org.mazarineblue.datasources

Interface DataSource

All Superinterfaces:

VariableSource

All Known Implementing Classes:

AbstractSource, AbstractSourceWrapper, ArraySource, BlackboardSource, ExcelSource, MatrixSource, NullDataSource, ObjectArraySource, ObjectMatrixSource, ResourceSource, ScopedSource, SourceChain, SourceWrapper

public interface DataSource
extends VariableSource

The interface for fetching keys and data from a source.

Author:

Alex de Kruijff <alex.de.kruijff@MazarineBlue.org>

See Also:

AbstractSource, ArraySource, ResourceSource, ExcelSource

Method Summary

Modifier and Type	Method and Description
String[]	getColumns() Returns an array of supported columns.
Object	getData(int index)
default <T> T	getData(int index, Class<T> objectType)
Object	getData(String column) Return the object at the specified column.
default <T> T	getData(String column, Class<T> objectType) Return the object at the specified column.
String	getLineIdentifier() Returns the line identifier.
String	getSourceIdentifier() Returns the source identifier.
boolean	hasNext() Return true if the data source has more rows.
String	next() Moves the data source to the next row.
String	reset() Resets the data source.
default String	reset(String mark)
boolean	setData(int index, Object value) Sets the specified value to the specivied column.
boolean	setData(String column, Object value) Return the object at the specified index.

Method Detail

hasNext

boolean hasNext()

Return true if the data source has more rows.

Returns:

true if the data source has more rows.

next

String next()

Moves the data source to the next row.

Returns:

the line identifier of the next row.

reset

String reset()

Resets the data source.

Returns:

the line identifier from before reset was called or null, if next was not called.

reset

default String reset(String mark)

getSourceIdentifier

String getSourceIdentifier()

Returns the source identifier.

Returns:

the source identifier

getLineIdentifier

String getLineIdentifier()
                  throws IllegalSourceStateException

Returns the line identifier.

Returns:

the line identifier.

Throws:

IllegalSourceStateException - when the method could not be called due to the state of the source i.e. next() has not been called or this method is not supported by the data source. when next() has not been

getData

default <T> T getData(String column,
                      Class<T> objectType)
               throws IllegalSourceStateException,
                      DataValidationException

Return the object at the specified column.

Type Parameters:

T -

Parameters:

column - the location where the object resides.

objectType - the type of the return data

Returns:

the object at the specified index or null if it could not be fetched.

Throws:

IllegalSourceStateException - when the method could not be called due to the state of the source i.e. next() has not been called or this method is not supported by the data source. when next() has not been

DataValidationException - when the data object is not of type objectType.

getData

Object getData(String column)
        throws IllegalSourceStateException

Return the object at the specified column.

Specified by:

getData in interface VariableSource

Parameters:

column - the location where the object resides.

Returns:

the object at the specified index or null if it could not be fetched.

Throws:

IllegalSourceStateException - when the method could not be called due to the state of the source i.e. next() has not been called or this method is not supported by the data source. when next() has not been

getData

default <T> T getData(int index,
                      Class<T> objectType)
               throws IllegalSourceStateException,
                      DataValidationException

Throws:

IllegalSourceStateException

DataValidationException

getData

Object getData(int index)
        throws IllegalSourceStateException

Throws:

IllegalSourceStateException

setData

boolean setData(String column,
                Object value)
         throws Exception

Return the object at the specified index.

Specified by:

setData in interface VariableSource

Parameters:

column - the location where the object should be stored.

value - the object to store.

Returns:

the object at the specified index or null if it could not be fetched.

Throws:

IllegalSourceStateException - when the method could not be called due to the state of the source i.e. next() has not been called or this method is not supported by the data source. when next() has not been

DataValidationException - when the data object is not of type objectType.

Exception

setData

boolean setData(int index,
                Object value)

Sets the specified value to the specivied column.

Parameters:

index - the location where the object should be stored.

value - the object to store.

Returns:

the object at the specified index or null if it could not be fetched.

getColumns

String[] getColumns()

Returns an array of supported columns.

Returns:

an array of supported columns or an empty array when none are supported by this data source.