net.windward.datasource

Class DataSourceBase

java.lang.Object

net.windward.datasource.DataSourceBase

Direct Known Subclasses:

AbstractDataSource, Dom4jDataSource

public abstract class DataSourceBase
extends java.lang.Object

The base class for all data source providers to inherit from.

Constructor Summary

Constructors

Constructor and Description
DataSourceBase()

Method Summary

Modifier and Type	Method and Description
static java.io.InputStream	convertToInputStream(java.lang.Object data) Used for cases where an evaluate can return a byte[] or other object and the engine needs the data as an InputStream.
boolean	forTesting()
ReportProperties	getProperties() Get properties currently in use.
static java.lang.Object	lookupVariable(DataSourceNode[] stack, java.lang.String var) Looks up the variable on the node stack.
void	setProperties(ReportProperties properties) Sets properties used by a report object.
abstract boolean	supportsDataSets() Does this datasource support data sets?

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSourceBase

public DataSourceBase()

Method Detail

forTesting

public boolean forTesting()

convertToInputStream

public static java.io.InputStream convertToInputStream(java.lang.Object data)
                                                throws DataSourceException

Used for cases where an evaluate can return a byte[] or other object and the engine needs the data as an InputStream. Converts if needed (does nothing if passed in an InputStream).

Parameters:

data - The data that may need to be converted.

Returns:

The data placed in an InoutStream.

Throws:

DataSourceException

supportsDataSets

public abstract boolean supportsDataSets()

Does this datasource support data sets?

Returns:

true if supported false if not

lookupVariable

public static java.lang.Object lookupVariable(DataSourceNode[] stack,
                                              java.lang.String var)

Looks up the variable on the node stack. Placed here because there's no base DataSurceNode class.

Parameters:

stack - The stack of data providers to look up in.

var - The variable to look up for.

Returns:

The variable's value or null if the variable does not exist.

setProperties

public void setProperties(ReportProperties properties)

Sets properties used by a report object. An implementation for anyone implementing DataSourceProvider and derived from this class.

getProperties

public ReportProperties getProperties()

Get properties currently in use. An implementation for anyone implementing DataSourceProvider and derived from this class.