org.openepics.cable.services.dl

Class DataLoader<T extends Serializable>

java.lang.Object

org.openepics.cable.services.dl.DataLoader<T>

Type Parameters:

T - Class of the objects that are affected when processing records.

Direct Known Subclasses:

CableArticleLoader, CableLoader, CableTypeLoader, ConnectorLoader, InstallationPackageLoader

public class DataLoader<T extends Serializable>
extends Object

This is a base class that processes records from RecordStream. Any record consumer should extend this class. Base implementation reads through the whole stream, but does nothing with the records.

Author:

Vasu Vuppala, Sunil Sah

Field Summary

Fields

Modifier and Type	Field and Description
protected int	createRows
protected int	createRowsTest
protected int	dataRows
protected int	deleteRows
protected int	deleteRowsTest
protected LoaderResult<T>	report
protected boolean	stopLoad
protected boolean	test
protected int	updateRows
protected int	updateRowsTest

Constructor Summary

Constructors

Constructor and Description
DataLoader() Constructs a generic data loader.
DataLoader(Iterable<String> urlColumns) Constructs a generic data loader.

Method Summary

Modifier and Type	Method and Description
protected String	getColumnLabel(String name) Returns the column label from header definition currently in use.
protected ValidationMessage	getErrorMessage(String message, DSRecord record, Object field)
protected ValidationMessage	getErrorMessage(String message, DSRecord record, Object field, String value)
LoaderResult<T>	load(InputStream stream) Loads all the records from the stream and processes them.
LoaderResult<T>	load(InputStream stream, boolean test) Loads all the records from the stream and processes them.
protected void	updateRecord(DSRecord record) Processes the record.
protected void	updateRecordList(Iterable<DSRecord> records) Processes a number of records.
protected void	validateStringSize(String value, FieldIntrospection fieldDescriptor, Class<? extends Persistable> entity) Checks whether the value string length is not too long for the database definition.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

test

protected boolean test

stopLoad

protected boolean stopLoad

report

protected LoaderResult<T extends Serializable> report

dataRows

protected int dataRows

createRows

protected int createRows

updateRows

protected int updateRows

deleteRows

protected int deleteRows

createRowsTest

protected int createRowsTest

updateRowsTest

protected int updateRowsTest

deleteRowsTest

protected int deleteRowsTest

Constructor Detail

DataLoader

public DataLoader()

Constructs a generic data loader.

DataLoader

public DataLoader(Iterable<String> urlColumns)

Constructs a generic data loader.

Parameters:

urlColumns - The list of column names that can contain URL links, used for spreadsheet parsing optimization.

Method Detail

updateRecord

protected void updateRecord(DSRecord record)

Processes the record. Extend this method to process the record. This method does nothing.

Parameters:

record - the record to process

updateRecordList

protected void updateRecordList(Iterable<DSRecord> records)

Processes a number of records. Extend this method to process a number of records at the same time. Base method calls updateRecord for each individual record.

Parameters:

records - the records to process

load

public LoaderResult<T> load(InputStream stream)

Loads all the records from the stream and processes them. The stream is closed on completion.

Parameters:

stream - the stream to read data from

Returns:

the report for the load

load

public LoaderResult<T> load(InputStream stream,
                            boolean test)

Loads all the records from the stream and processes them. The stream is closed on completion.

Parameters:

stream - the stream to read data from

test - if true, only a test whether the load would succeed is performed, and no data is imported to the database.

Returns:

the report for the load

getColumnLabel

protected String getColumnLabel(String name)

Returns the column label from header definition currently in use.

Parameters:

name - the name of the column

Returns:

the label

getErrorMessage

protected ValidationMessage getErrorMessage(String message,
                                            DSRecord record,
                                            Object field,
                                            String value)

Parameters:

message - the message string

record - the record for which the validation message is created

field - the field for which the validation message is created

value - of the field

Returns:

returns the error validation message for a given record and field

getErrorMessage

protected ValidationMessage getErrorMessage(String message,
                                            DSRecord record,
                                            Object field)

Parameters:

message - the message string

record - the record for which the validation message is created

field - the field for which the validation message is created

Returns:

returns the error validation message for a given record and field

validateStringSize

protected void validateStringSize(String value,
                                  FieldIntrospection fieldDescriptor,
                                  Class<? extends Persistable> entity)

Checks whether the value string length is not too long for the database definition. The method returns false if the entity has no such field, or if the filed data type is not String.

Parameters:

value - the string to store

fieldDescriptor - the name of the entity field

entity - the Class of the entity

Throws:

DbFieldLengthViolationException - if the length of value violates the database restrictions.