Package repast.simphony.freezedry

Class AbstractDataSource<X>

java.lang.Object

repast.simphony.freezedry.AbstractDataSource<X>

All Implemented Interfaces:

FreezeDryedDataSource

Direct Known Subclasses:

DelimitedFileDataSource, JDBCDataSource

public abstract class AbstractDataSource<X>
extends Object
implements FreezeDryedDataSource

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ARRAY_MARKER
static final String	BYTES_MARKER	Marker for byte storage column names (should be appended to the column name).
static final String	CHILD_CLASS_COL	In child tables, this is the child's class column.
static final String	CHILD_ID_COL	In child tables, this is the child's id column.
static final String	CHILD_ID_MARKER	Marker for child id column names (should be appended to the column name).
static final String	CHILDREN_MARKER	Marker for children column names (should be appended to the column name).
static final String	CLASS_MARKER	Marker for class types column names (should be appended to the column name).
static final String	ID_COL	Name of the column used to identify objects.
static final String	PARENT_ID_COL	In child tables, this is the parent's identifier column.
static final String	SPECIAL_COL_MARKER	This should be pre-pended to column names that will be interpreted in a "special" way (IE used to identify an object, or as a reference to another table).

Constructor Summary

Constructors

Constructor	Description
AbstractDataSource()

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this data source.
protected abstract void	endTypeRead(Class clazz)	Finishes the reading of the specified class.
protected abstract void	finishChildrenRead(FreezeDryedObject fdo)	Ends the reading of the children for the specified FreezeDryedObject.
protected abstract void	finishChildrenWrite(FreezeDryedObject object)	Finishes the writing of the children for the specified FreezeDryedObject.
protected abstract void	finishTypeWrite(FreezeDryedObject object)	Finishes the writing of the specified FreezeDryedObject.
protected String	getArrayType(String field)
protected Object	getArrayValue(String arrayType, Object val)
protected String	getChildrenColumnName(FreezeDryedObject fdo)
protected List<String[]>	getColumnKeysetPairs(FreezeDryedObject fdo)
protected List<String>	getColumns(FreezeDryedObject fdo)
protected abstract List<String>	getFields(String type)	Retrieves the fields for a specified type.
protected abstract Object	getFieldValue(X row, String field)	Retrieves the value of the specified field in the specified row of data.
protected String	getTrueFieldName(String field, String marker)
protected String	getType(Class clazz)
protected String	getType(FreezeDryedObject object)
protected String	getValue(char[] value)
protected String	getValue(Number number)
protected String	getValue(String value)
protected String	getValueArray(Object value)
protected String[]	pair(String string1, String string2)
protected FreezeDryedParentChild	parseChildRow(FreezeDryedObject fdo, X childsRow)
protected FreezeDryedObject	parseRow(Class clazz, X row)
Iterable<FreezeDryedObject>	read(Class clazz)
FreezeDryedObject	read(Class clazz, String key)
protected abstract byte[]	readByteArray(FreezeDryedObject fdo, String field, Object bytesId)	Reads in a byte[] that corresponds to the specified bytesId and will be loaded into the specified fdo through the specified field.
protected void	readChildren(FreezeDryedObject fdo)
protected abstract X	readChildsRow(FreezeDryedObject parent, String id)	Reads in a row of data about a child of the specified FreezeDryedObject.
protected FreezeDryedParentChild	readFreezeDryedParentChild(FreezeDryedObject parent, String className, String childId)
protected abstract X	readRow(Class clazz, String key)	Reads in a row of data that will be parsed by the use of getFieldValue(X, String) and getFields(String).
void	reset()	Resets this data source.
protected abstract void	startChildrenRead(FreezeDryedObject fdo)	Initializes the reading of the children of a specified FreezeDryedObject.
protected abstract void	startChildrenWrite(FreezeDryedObject fdo)	Initiates the writing of the children for the specified FreezeDryedObject.
protected abstract void	startTypeRead(Class clazz)	Initiates the reading of the specified class.
protected abstract void	startTypeWrite(FreezeDryedObject fdo)	This is called at the start of a call to write.
void	write(FreezeDryedObject object)
protected abstract Object	writeByteArray(FreezeDryedObject fdo, String fieldName, byte[] bs)	Writes a byte array retrieved from the specified FreezeDryedObject with the specified fieldName.
protected abstract void	writeChildData(FreezeDryedObject fdo, HashMap<String,Object> child)	Writes the data for a child of the specified FreezeDryedObject.
protected void	writeChildren(FreezeDryedObject fdo)
protected abstract void	writeRow(FreezeDryedObject object, Map<String,Object> row)	This writes a row of data out which was generated by the specified FreezeDryedObject.

Methods inherited from class java.lang.Object

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

Field Details

SPECIAL_COL_MARKER

public static final String SPECIAL_COL_MARKER

This should be pre-pended to column names that will be interpreted in a "special" way (IE used to identify an object, or as a reference to another table).

See Also:

• Constant Field Values

CHILDREN_MARKER

public static final String CHILDREN_MARKER

Marker for children column names (should be appended to the column name).

See Also:

• Constant Field Values

BYTES_MARKER

public static final String BYTES_MARKER

Marker for byte storage column names (should be appended to the column name).

See Also:

• Constant Field Values

CLASS_MARKER

public static final String CLASS_MARKER

Marker for class types column names (should be appended to the column name).

See Also:

• Constant Field Values

CHILD_ID_MARKER

public static final String CHILD_ID_MARKER

Marker for child id column names (should be appended to the column name).

See Also:

• Constant Field Values

ID_COL

public static final String ID_COL

Name of the column used to identify objects.

See Also:

• Constant Field Values

PARENT_ID_COL

public static final String PARENT_ID_COL

In child tables, this is the parent's identifier column.

See Also:

• Constant Field Values

CHILD_CLASS_COL

public static final String CHILD_CLASS_COL

In child tables, this is the child's class column.

See Also:

• Constant Field Values

CHILD_ID_COL

public static final String CHILD_ID_COL

In child tables, this is the child's id column.

See Also:

• Constant Field Values

ARRAY_MARKER

public static final String ARRAY_MARKER

See Also:

• Constant Field Values

Constructor Details

AbstractDataSource

public AbstractDataSource()

Method Details

startTypeWrite

protected abstract void startTypeWrite(FreezeDryedObject fdo)
                                throws FreezeDryingException

This is called at the start of a call to write. This should cause any needed preparation for reading this type to occur. It will be followed by calls to writeRow(FreezeDryedObject, Map) and a call to finishTypeWrite(FreezeDryedObject).

Parameters:

fdo - the FreezeDryedObject who will begin to be written

Throws:

FreezeDryingException - when there's an error

writeRow

protected abstract void writeRow(FreezeDryedObject object,
 Map<String,Object> row)
                          throws FreezeDryingException

This writes a row of data out which was generated by the specified FreezeDryedObject. This will be preceded by a call and will be followed by calls to {@link #writeRow(FreezeDryedObject, Map)} and a call to {@link #finishTypeWrite(FreezeDryedObject)}.

Parameters:

fdo - the FreezeDryedObject that the row of data came from

row - the data for the specified FreezeDryedObject

Throws:

FreezeDryingException - when there's an error

writeByteArray

protected abstract Object writeByteArray(FreezeDryedObject fdo,
 String fieldName,
 byte[] bs)
                                  throws FreezeDryingException

Writes a byte array retrieved from the specified FreezeDryedObject with the specified fieldName.

Parameters:

fdo - the source of the data

fieldName - the field this data is assosciated with

bs - the data itself

Returns:

the value to be written to the subclass for the fieldName (this could potentially just be an id, or it could just be the bytes themselves)

Throws:

FreezeDryingException

startChildrenWrite

protected abstract void startChildrenWrite(FreezeDryedObject fdo)
                                    throws FreezeDryingException

Initiates the writing of the children for the specified FreezeDryedObject.

Parameters:

fdo - the whose children will be written

Throws:

FreezeDryingException

writeChildData

protected abstract void writeChildData(FreezeDryedObject fdo,
 HashMap<String,Object> child)
                                throws FreezeDryingException

Writes the data for a child of the specified FreezeDryedObject.

Parameters:

fdo - the parent

child - the data from the child

Throws:

FreezeDryingException

finishChildrenWrite

protected abstract void finishChildrenWrite(FreezeDryedObject object)
                                     throws FreezeDryingException

Finishes the writing of the children for the specified FreezeDryedObject.

Parameters:

fdo - the whose children were written

Throws:

FreezeDryingException

finishTypeWrite

protected abstract void finishTypeWrite(FreezeDryedObject object)
                                 throws FreezeDryingException

Finishes the writing of the specified FreezeDryedObject. This will be preceded by a call and calls to {@link #writeRow(FreezeDryedObject, Map)} (along with the other child and byte methods).

Parameters:

fdo - the FreezeDryedObject that the row of data came from

Throws:

FreezeDryingException - when there's an error

startTypeRead

protected abstract void startTypeRead(Class clazz)
                               throws FreezeDryingException

Initiates the reading of the specified class. This class represents is of a type that was at some point written out through a FreezeDryedObject.

Parameters:

clazz - the class that was the type returned by FreezeDryedObject.getType()

Throws:

FreezeDryingException

readRow

protected abstract X readRow(Class clazz,
 String key)
                      throws FreezeDryingException

Reads in a row of data that will be parsed by the use of getFieldValue(X, String) and getFields(String).

If the data source can find an object with the specified key it should return data for reading that object, otherwise it may return any object.

Parameters:

clazz - the class the data will be used for

key - the key of the object we're looking for, if null it should be ignored

Returns:

a row of data

Throws:

FreezeDryingException

readByteArray

protected abstract byte[] readByteArray(FreezeDryedObject fdo,
 String field,
 Object bytesId)
                                 throws FreezeDryingException

Reads in a byte[] that corresponds to the specified bytesId and will be loaded into the specified fdo through the specified field.

Parameters:

fdo - the object that the bytes are going to be stored in

field - the field the bytes[] are for

columnValue - the value in the row of data for the field (the return of a writeByteArray(FreezeDryedObject, String, byte[])

Returns:

the read in byte[]

Throws:

FreezeDryingException

getFields

protected abstract List<String> getFields(String type)
                                   throws FreezeDryingException

Retrieves the fields for a specified type. Generally these should be read in and stored during the startTypeRead(Class) call.

Parameters:

type - the type of the FreezeDryedObject (from getType(Class)).

Returns:

the list of fields of that type

Throws:

FreezeDryingException

getFieldValue

protected abstract Object getFieldValue(X row,
 String field)
                                 throws FreezeDryingException

Retrieves the value of the specified field in the specified row of data.

Parameters:

row - the row (returned by #readRow(Class)).

field - the field we're reading

Returns:

the value of that field

Throws:

FreezeDryingException

startChildrenRead

protected abstract void startChildrenRead(FreezeDryedObject fdo)
                                   throws FreezeDryingException

Initializes the reading of the children of a specified FreezeDryedObject.

Parameters:

fdo - the FreezeDryedObject whose children will be read

Throws:

FreezeDryingException

readChildsRow

protected abstract X readChildsRow(FreezeDryedObject parent,
 String id)
                            throws FreezeDryingException

Reads in a row of data about a child of the specified FreezeDryedObject.

Parameters:

parent - the parent of the child that will be read

id - the id of the child we're concerned with

Returns:

a row of data on the child

Throws:

FreezeDryingException

finishChildrenRead

protected abstract void finishChildrenRead(FreezeDryedObject fdo)

Ends the reading of the children for the specified FreezeDryedObject.

Parameters:

fdo - the FreezeDryedObject whose children have been read

endTypeRead

protected abstract void endTypeRead(Class clazz)

Finishes the reading of the specified class.

Parameters:

clazz - the class whose reading has completed

reset

public void reset()

Resets this data source.

Specified by:

reset in interface FreezeDryedDataSource

close

public void close()
           throws FreezeDryingException

Closes this data source.

Specified by:

close in interface FreezeDryedDataSource

Throws:

FreezeDryingException

write

public void write(FreezeDryedObject object)
           throws FreezeDryingException

Specified by:

write in interface FreezeDryedDataSource

Throws:

FreezeDryingException

getValueArray

protected String getValueArray(Object value)

writeChildren

protected void writeChildren(FreezeDryedObject fdo)
                      throws FreezeDryingException

Throws:

FreezeDryingException

getType

protected String getType(Class clazz)

getType

protected String getType(FreezeDryedObject object)

getValue

protected String getValue(String value)

getValue

protected String getValue(char[] value)

getValue

protected String getValue(Number number)

getColumns

protected List<String> getColumns(FreezeDryedObject fdo)

pair

protected String[] pair(String string1,
 String string2)

getColumnKeysetPairs

protected List<String[]> getColumnKeysetPairs(FreezeDryedObject fdo)

parseRow

protected FreezeDryedObject parseRow(Class clazz,
 X row)
                              throws FreezeDryingException

Throws:

FreezeDryingException

getArrayValue

protected Object getArrayValue(String arrayType,
 Object val)

getArrayType

protected String getArrayType(String field)

getTrueFieldName

protected String getTrueFieldName(String field,
 String marker)

readFreezeDryedParentChild

protected FreezeDryedParentChild readFreezeDryedParentChild(FreezeDryedObject parent,
 String className,
 String childId)
                                                     throws ClassNotFoundException

Throws:

ClassNotFoundException

readChildren

protected void readChildren(FreezeDryedObject fdo)
                     throws ClassNotFoundException,
FreezeDryingException

Throws:

ClassNotFoundException

FreezeDryingException

parseChildRow

protected FreezeDryedParentChild parseChildRow(FreezeDryedObject fdo,
 X childsRow)
                                        throws ClassNotFoundException,
FreezeDryingException

Throws:

ClassNotFoundException

FreezeDryingException

read

public FreezeDryedObject read(Class clazz,
 String key)
                       throws FreezeDryingException

Specified by:

read in interface FreezeDryedDataSource

Throws:

FreezeDryingException

read

public Iterable<FreezeDryedObject> read(Class clazz)
                                 throws FreezeDryingException

Specified by:

read in interface FreezeDryedDataSource

Throws:

FreezeDryingException

getChildrenColumnName

protected String getChildrenColumnName(FreezeDryedObject fdo)