org.mazarineblue.datasources

Class BlackboardSource

java.lang.Object

org.mazarineblue.datasources.AbstractSource

org.mazarineblue.datasources.ArraySource

org.mazarineblue.datasources.BlackboardSource

All Implemented Interfaces:

DataSource, VariableSource

public class BlackboardSource
extends ArraySource

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	GLOBAL
static String	LOCAL
static String	SHEET

Constructor Summary

Constructors

Constructor and Description
BlackboardSource(String identifier)

Method Summary

Modifier and Type	Method and Description
void	declareVariable(String name)
void	declareVariable(String scope, String name)
String[]	getColumns() Returns an array of supported columns.
Object	getData(int index)
Object	getData(String column) Return the object at the specified column.
ObjectArraySource	popSource()
ObjectArraySource	popSource(ObjectArraySource source)
ObjectArraySource	popSource(String scope)
void	pushSource(ObjectArraySource source)
void	pushSource(String scope)
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.
void	setup()
void	setup(Map<String,Object> presetVariables)
void	teardown()
String	toString()

Methods inherited from class org.mazarineblue.datasources.ArraySource

getLineIdentifier, hasNext, next, reset, validateState

Methods inherited from class org.mazarineblue.datasources.AbstractSource

getSourceIdentifier

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mazarineblue.datasources.DataSource

getData, getData, reset

Field Detail

LOCAL

public static final String LOCAL

See Also:

Constant Field Values

SHEET

public static final String SHEET

See Also:

Constant Field Values

GLOBAL

public static final String GLOBAL

See Also:

Constant Field Values

Constructor Detail

BlackboardSource

public BlackboardSource(String identifier)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

setup

public void setup()

setup

public void setup(Map<String,Object> presetVariables)

teardown

public void teardown()

pushSource

public void pushSource(String scope)

pushSource

public void pushSource(ObjectArraySource source)

popSource

public ObjectArraySource popSource()

popSource

public ObjectArraySource popSource(ObjectArraySource source)
                            throws BlackboardException

Throws:

BlackboardException

popSource

public ObjectArraySource popSource(String scope)
                            throws BlackboardException

Throws:

BlackboardException

declareVariable

public void declareVariable(String name)
                     throws BlackboardException

Throws:

BlackboardException

declareVariable

public void declareVariable(String scope,
                            String name)
                     throws BlackboardException

Throws:

BlackboardException

getData

public final Object getData(String column)
                     throws IllegalSourceStateException

Description copied from interface: DataSource

Return the object at the specified column.

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

public Object getData(int index)
               throws IllegalSourceStateException

Throws:

IllegalSourceStateException

setData

public boolean setData(String column,
                       Object value)

Description copied from interface: DataSource

Return the object at the specified index.

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.

setData

public boolean setData(int index,
                       Object value)

Description copied from interface: DataSource

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

public final String[] getColumns()

Description copied from interface: DataSource

Returns an array of supported columns.

Returns:

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