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:

JdbcDataSource, JsonDataSource

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 IDataSourceQueryHelper into it via the getQueryHelper() method, and we will be good to go.

Field Summary

Fields

Modifier and Type	Field and Description
AbstractDataSourceNode	rootNode

Fields inherited from interface net.windward.datasource.DataSourceProvider

NAME_DATASET, NAME_JSON, NAME_LITERAL, NAME_ODATA, NAME_SFDC, NAME_SQL, NAME_XML, NAME_XML_1_0

Constructor Summary

Constructors

Constructor and Description
AbstractDataSource() Create the datasource object.

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.
abstract java.lang.String	combineQueryForDataSet(java.lang.String dataSetQuery, java.lang.String query, java.lang.String dataSetName)
DataSourceNode	dataSourceNodeWithIndex(int index, DataSourceIterator it, ForEachTag tag) Return the node when a forEach has a step > 1 and therefore results can be accessed using ${var[2]}.
java.util.Map<java.lang.String,java.lang.Object>	getParameters() This call is for internal engine use only.
int	getParamMode() Get the parameter substitution mode.
abstract IDataSourceQueryHelper	getQueryHelper() Returns the query helper which is datasource specific.
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	returnValue(IDataSourceResultRow resultRow, java.lang.String tagType) Return the requested value from a result set.
void	SetDseProps(DataSourceException dse, BaseTag tag, DataSourceNode[] stack)
void	setParameters(java.util.Map<java.lang.String,java.lang.Object> parameters) This call is for internal engine use only.
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, lookupVariable, supportsDataSets

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 AbstractDataSourceNode rootNode

Constructor Detail

AbstractDataSource

public AbstractDataSource()

Create the datasource object.

Method Detail

getQueryHelper

public abstract IDataSourceQueryHelper getQueryHelper()

Returns the query helper which is datasource specific. The abstract class methods use the helper for the datasource specific calls in their processing.

close

public abstract void close()
                    throws DataSourceException

Clean up resources.

Specified by:

close in interface DataSourceProvider

Throws:

DataSourceException - Could not retrieve the data. Generally wraps a SqlException or XpathException.

combineQueryForDataSet

public abstract java.lang.String combineQueryForDataSet(java.lang.String dataSetQuery,
                                                        java.lang.String query,
                                                        java.lang.String dataSetName)

getQueryMode

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

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 - The query we need to return the mode for

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

Returns:

The mode

getRootNode

public DataSourceNode getRootNode()

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.

getParamMode

public int getParamMode()

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.

setParamMode

public void setParamMode(int paramMode)

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.

getParameters

public java.util.Map<java.lang.String,java.lang.Object> getParameters()

This call is for internal engine use only. Do not call this!

Specified by:

getParameters in interface DataSourceProvider

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.Object> parameters)

This call is for internal engine use only. Do not call this!

Specified by:

setParameters in interface DataSourceProvider

Parameters:

parameters - This object is directly assigned for use as it is shared. Therefore any changes to it after this call effect the datasource.

validateTag

public void validateTag(BaseTag xmlTag)
                 throws TagException

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.

getTagAttributes

public TagAttributes[] getTagAttributes()

Returns the allowed attributes for all tags.

Specified by:

getTagAttributes in interface DataSourceProvider

Returns:

The tag attributes.

SetDseProps

public void SetDseProps(DataSourceException dse,
                        BaseTag tag,
                        DataSourceNode[] stack)

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.

dataSourceNodeWithIndex

public DataSourceNode dataSourceNodeWithIndex(int index,
                                              DataSourceIterator it,
                                              ForEachTag tag)
                                       throws DataSourceException

Return the node when a forEach has a step > 1 and therefore results can be accessed using ${var[2]}.

Parameters:

index - The index from the first row of the block returned. 0 is the same as not indexing.

it - The iterator holding the result set presently on.

tag - The forEach tag this is for.

Returns:

The requested node (the node at the requested index).

Throws:

DataSourceException

returnValue

public java.lang.Object returnValue(IDataSourceResultRow resultRow,
                                    java.lang.String tagType)
                             throws DataSourceException

Return the requested value from a result set. This can be either a specified specific value or if not specified, the first column's value.

Parameters:

resultRow - The row from the results to pull the column value from.

tagType - The tag this is for. Can be null.

Returns:

The requested data value.

Throws:

DataSourceException