net.windward.datasource.abstract_datasource

Class AbstractDataSource

java.lang.Object

net.windward.datasource.DataSourceBase

net.windward.datasource.abstract_datasource.AbstractDataSource

All Implemented Interfaces:

DataSourceProvider

Direct Known Subclasses:

SalesForceDataSource

public abstract class AbstractDataSource
extends DataSourceBase
implements DataSourceProvider

This class is designed to make future data sources easier to implement and more robust. Ideally, you should never need to touch this class, and we will never need to deal with the DataSourceIterators, and stacks again. We can just extend this class, link a DataSourceQueryHelper into it via the getQueryHelper() method, and we will be good to go.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractDataSource.AbstractDataSourceNode

Field Summary

Fields

Modifier and Type	Field and Description
AbstractDataSource.AbstractDataSourceNode	rootNode
int	SynTaxmode

Constructor Summary

Constructors

Constructor and Description
AbstractDataSource()

Method Summary

Modifier and Type	Method and Description
void	approveDenyModifySelect(BaseTag xmlTag) Verifys that a tag select is approved by a user defined callback Or denies by throwing a DatasourceException or modifies the select
abstract void	close() Clean up resources.
java.util.Map	getMap() Returns the map of variables for this datasource.
int	getParamMode() Get the parameter substitution mode.
abstract int	getQueryMode(java.lang.String query, BaseTag tag) Gets the query mode of a select.
DataSourceNode	getRootNode() Returns the root node for this data set.
TagAttributes[]	getTagAttributes() Returns the allowed attributes for all tags.
void	populateDatasourceException(DataSourceException exception, BaseTag tag, DataSourceNode[] stack) Populates that properties in a DataSourceException via DataSourceException.setProperties().
java.lang.Object	returnfirstattribute(DataSourceResultRow dsrr)
java.lang.Object	returnValue(DataSourceResultRow dsrr)
void	setDatasets(java.lang.Object[] datasets) Set the datasets to use with this datasource.
void	setMap(java.util.Map m) Adds a map that is used for ${variable} substitution.
void	setParamMode(int paramMode) Set the parameter substitution mode.
void	validateTag(BaseTag xmlTag) Verifys that a tag has all required attributes and no unknown attributes.

Methods inherited from class net.windward.datasource.DataSourceBase

convertToInputStream

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.windward.datasource.DataSourceProvider

getDatasourceName

Field Detail

rootNode

public AbstractDataSource.AbstractDataSourceNode rootNode

SynTaxmode

public int SynTaxmode

Constructor Detail

AbstractDataSource

public AbstractDataSource()

Method Detail

close

public abstract void close()

Clean up resources. This is datasource specific, so it needs to be implemented every time.

Specified by:

close in interface DataSourceProvider

getQueryMode

public abstract int getQueryMode(java.lang.String query,
                                 BaseTag tag)
                          throws DataSourceException

Gets the query mode of a select. This is datasource specific, so it needs to be implemented every time.

Specified by:

getQueryMode in interface DataSourceProvider

Parameters:

query -

tag - The tag this select is for. This may be null.

Returns:

Throws:

DataSourceException

getRootNode

public DataSourceNode getRootNode()

Description copied from interface: DataSourceProvider

Returns the root node for this data set. Outside of forEach loops this is the node all tag requests will be evaluated against.

Specified by:

getRootNode in interface DataSourceProvider

Returns:

The root node.

setParamMode

public void setParamMode(int paramMode)

Description copied from interface: DataSourceProvider

Set the parameter substitution mode. Uses one of the BaseTag.PARAM_MODE_* constants. ${vars} are replaced in the select either using a string substitution or using the setParameter() underlying provider call. (For XML Windward implementes the setParameter as XPath does not provide that mechanism.)

Specified by:

setParamMode in interface DataSourceProvider

Parameters:

paramMode - the parameter substitution mode.

getParamMode

public int getParamMode()

Description copied from interface: DataSourceProvider

Get the parameter substitution mode. Uses one of the BaseTag.PARAM_MODE_* constants. ${vars} are replaced in the select either using a string substitution or using the setParameter() underlying provider call. (For XML Windward implementes the setParameter as XPath does not provide that mechanism.)

Specified by:

getParamMode in interface DataSourceProvider

Returns:

the parameter substitution mode.

getMap

public java.util.Map getMap()

Description copied from interface: DataSourceProvider

Returns the map of variables for this datasource.

Specified by:

getMap in interface DataSourceProvider

Returns:

the map of variables for this datasource.

validateTag

public void validateTag(BaseTag xmlTag)
                 throws TagException

Description copied from interface: DataSourceProvider

Verifys that a tag has all required attributes and no unknown attributes.

Specified by:

validateTag in interface DataSourceProvider

Parameters:

xmlTag - The tag to check

Throws:

TagException - thrown if illegal parameters passed in.

approveDenyModifySelect

public void approveDenyModifySelect(BaseTag xmlTag)
                             throws DataSourceException

Verifys that a tag select is approved by a user defined callback Or denies by throwing a DatasourceException or modifies the select

Specified by:

approveDenyModifySelect in interface DataSourceProvider

Parameters:

xmlTag - The tag to check

Throws:

DataSourceException - thrown if illegal parameters passed in.

setMap

public void setMap(java.util.Map m)

Description copied from interface: DataSourceProvider

Adds a map that is used for ${variable} substitution. The map should be string pairs and the key values cannot have any of the characters ${} in them. When ${key} is found in any tag, it is replaced with the matching value. The key and value strings are not evaluated in any way, it is just a text substitution. This replace occurs before any other evaluation of a tag so the value string can have ${variable} values that will then be evaluated. This call sets the map so calling it a second time replaces the map passed in the first time. The map is copied so on return changes to the passed in map will not affect the data source. The values passed in a map must be a String, Number (Integer, Float, etc), Date, or SelectBase derived class.

Specified by:

setMap in interface DataSourceProvider

Parameters:

m - The map of string pairs.

setDatasets

public void setDatasets(java.lang.Object[] datasets)

Description copied from interface: DataSourceProvider

Set the datasets to use with this datasource. This will overwrite datasets from previous calls to this method.

Specified by:

setDatasets in interface DataSourceProvider

Parameters:

datasets - The datasets to use. Can be null to turn off datasets. This is a DatasetBase[] but because of how the .NET engine is structured, we need to declare it as an object.

getTagAttributes

public TagAttributes[] getTagAttributes()

Description copied from interface: DataSourceProvider

Returns the allowed attributes for all tags.

Specified by:

getTagAttributes in interface DataSourceProvider

Returns:

The tag attributes.

populateDatasourceException

public void populateDatasourceException(DataSourceException exception,
                                        BaseTag tag,
                                        DataSourceNode[] stack)

Populates that properties in a DataSourceException via DataSourceException.setProperties().

Specified by:

populateDatasourceException in interface DataSourceProvider

Parameters:

exception - The exception to populate.

tag - The tag we're processing. null if no tag.

stack - The node stack at the time of the exception. null if not relevant.

returnfirstattribute

public java.lang.Object returnfirstattribute(DataSourceResultRow dsrr)
                                      throws DataSourceException

Throws:

DataSourceException

returnValue

public java.lang.Object returnValue(DataSourceResultRow dsrr)
                             throws DataSourceException

Throws:

DataSourceException