net.windward.datasource.abstract_datasource

Class AbstractDataSourceNode

java.lang.Object

net.windward.datasource.abstract_datasource.AbstractDataSourceNode

All Implemented Interfaces:

DataSourceNode

Direct Known Subclasses:

JdbcDataSource.JdbcNode, JsonDataSource.JsonDataNode

public abstract class AbstractDataSourceNode
extends java.lang.Object
implements DataSourceNode

This represents a node in the datasource. Every time a forEach loop is entered one of these nodes must be created and is pushed on to the stack of forEach nodes. When a forEach is exited, the node is pop'ed off the stack. The base node is the DataSourceProvider.getRootNode().

Constructor Summary

Constructors

Constructor and Description
AbstractDataSourceNode(AbstractDataSource abstractDataSource)

Method Summary

Modifier and Type	Method and Description
boolean	addQuery(QueryTag tag, DataSourceNode[] stack) Called for a query tag.
void	addSet(SetTag tag, DataSourceNode[] stack, java.util.Locale locale, IMacroState macroState) Adds the set tag value to the usermap.
boolean	addSwitch(SwitchTag tag, DataSourceNode[] stack) Called for a switch tag.
void	close() We are done with this node.
java.lang.Object	drillDownToVal(java.lang.Object rtn, java.lang.String tagType) Drills through result sets to get the final return value.
void	endSwitch(EndSwitchTag tag, DataSourceNode[] stack) Called when a switch ends.
boolean	evaluate(java.lang.String text, DataSourceNode[] stack, IMacroState macroState) Evaluate an expression for the boolean result.
java.io.InputStream	getBitmap(OutTag tag, DataSourceNode[] stack, IMacroState state) Called when tag is of type BITMAP.
java.lang.Object	getCursor() Returns the underlying cursor this node presently holds.
ChartDataSet	getData(ChartTag tag, DataSourceNode[] stack, java.util.Locale locale) Returns a set of data used to create a chart.
DataSourceProvider	getDataSourceProvider() Get the parent datasource.
DebugDatasourceState	getDatasourceState(DataSourceNode[] stack) Get the state of the datasource.
java.lang.Object[]	getEquationData(java.lang.String query, DataSourceNode[] stack, java.util.Locale locale) Returns an array of data from a given datasource query
java.lang.String	getImport(ImportTag tag, DataSourceNode[] stack) Called for an import tag.
java.lang.String	getImport(ImportTag tag, DataSourceNode[] stack, java.util.Locale locale, IMacroState macroState) An extended version of getImport() which supports the macro evaluation.
DataSourceIterator	getIterator() Returns the iterator presently in use for this node.
java.lang.String	getLink(BaseTag tag, DataSourceNode[] stack) Called for a link or DrillDown tag.
java.lang.Object	getNativeVariable(DataSourceNode[] stack, java.lang.String var) Gets the variable from a data provider on the stack.
java.lang.Object	getOut(OutTag tag, DataSourceNode[] stack, java.util.Locale locale, IMacroState state) Called for an out tag.
InputDataContainer	getOutStream(OutTag tag, DataSourceNode[] stack, IMacroState state) Called for an out tag.
java.lang.String	getValue(BaseTag tag, DataSourceNode[] stack, java.util.Locale locale, IMacroState macroState)
java.lang.Object[]	getVariableValue(java.lang.String variable, DataSourceNode[] stack, java.util.Locale locale) Returns the variable value.
boolean	isCase(CaseTag tag, DataSourceNode[] stack, IMacroState macroState) Called for a case tag.
boolean	isExistingNode(BaseTag tag, DataSourceNode[] stack) Return true if the passed in node exists.
boolean	isIf(IfTag tag, DataSourceNode[] stack, IMacroState macroState) Called for an if tag.
boolean	isLiteralDataSourceNode() This is needed in parts of the code that do not know about the .NET version of the LiteralDataSourceNode, for example if we are in cross compiled java code and we need to know if a DataSourceNode is an instance of WindwardReportDrivers.net.windward.datasource.LiteralDatasource.LiteralDataSourceNode.
DataSourceIterator	iterator(ForEachTag tag, DataSourceNode[] stack) Called for a forEach tag.
ParsedQuery	parse(java.lang.String query, DataSourceNode[] stack, int mode, int returnType, java.lang.String tagType, boolean ignoreUndefinedParams) parses the query and gets variable results.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.windward.datasource.DataSourceNode

getQueryMode, isSelect

Constructor Detail

AbstractDataSourceNode

public AbstractDataSourceNode(AbstractDataSource abstractDataSource)

Method Detail

isLiteralDataSourceNode

public boolean isLiteralDataSourceNode()

This is needed in parts of the code that do not know about the .NET version of the LiteralDataSourceNode, for example if we are in cross compiled java code and we need to know if a DataSourceNode is an instance of WindwardReportDrivers.net.windward.datasource.LiteralDatasource.LiteralDataSourceNode. This is necessary in the charting code as the series data select resulted in a LiteralDataSourceNode instead of a node of the original type. In this case we need to know it is a LiteralDataSourceNode, so that we can run row data selects against a query higher up the stack.

Specified by:

isLiteralDataSourceNode in interface DataSourceNode

Returns:

true if this is an instane of a literal datasource node

getNativeVariable

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

Gets the variable from a data provider on the stack. The stack is queried in order from top to bottom and if the provider in turn owns the variable its value is returnd. The base implementation simply returns null. Override it in the derived provider.

Specified by:

getNativeVariable in interface DataSourceNode

Parameters:

stack - The current stack of data providers.

var - A variable to look up. It's in the form of ${...}.

Returns:

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

addSet

public void addSet(SetTag tag,
                   DataSourceNode[] stack,
                   java.util.Locale locale,
                   IMacroState macroState)
            throws DataSourceException

Adds the set tag value to the usermap. If queryMode is a select statement, need to evaluate by calling queryhelpers. If queryMode is a value, set the usermap to contain the querytext - no need to evaluate anything

Specified by:

addSet in interface DataSourceNode

Parameters:

tag - The tag to add

stack - The stack of forEach loops in at this point. Node [0] is the root document node so this will always

macroState - the macro state of the report have length of at least 1.

Throws:

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

addQuery

public boolean addQuery(QueryTag tag,
                        DataSourceNode[] stack)
                 throws DataSourceException

Description copied from interface: DataSourceNode

Called for a query tag. Adds this query to the list of queries the document holds. This query will continue to exist after this node is gone.

Specified by:

addQuery in interface DataSourceNode

Parameters:

tag - The values that identify the datasource node to read.

stack - The stack of forEach loops in at this point. Node [0] is the root document node so this will always have length of at least 1.

Returns:

true if returned 1 or more rows of data. false if no data.

Throws:

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

getBitmap

public java.io.InputStream getBitmap(OutTag tag,
                                     DataSourceNode[] stack,
                                     IMacroState state)
                              throws DataSourceException

Description copied from interface: DataSourceNode

Called when tag is of type BITMAP. Returns the fileimage of the bitmap from the datasource. Return a 0 length array for an empty bitmap. Return null if the requested node does not exist.

Specified by:

getBitmap in interface DataSourceNode

Parameters:

tag - The values that identify the datasource node to read.

stack - The stack of forEach loops in at this point. Node [0] is the root document node so this will always have length of at least 1.

state - macrostate of the report

Returns:

A file image of the referenced bitmap.

Throws:

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

getImport

public java.lang.String getImport(ImportTag tag,
                                  DataSourceNode[] stack)
                           throws DataSourceException

Description copied from interface: DataSourceNode

Called for an import tag. Returns the name of the resource to be parsed and inserted into the report. Windward Reports will process the returned string based on the tag type attribute. Return a 0 length string for an empty node. Return null if the requested node does not exist. Windward Reports uses the type and source attributes on this returned value. This method cannot affect those attributes.

Specified by:

getImport in interface DataSourceNode

Parameters:

tag - The values that identify the datasource node to read.

stack - The stack of forEach loops in at this point. Node [0] is the root document node so this will always have length of at least 1.

Returns:

The text to insert into the report.

Throws:

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

getImport

public java.lang.String getImport(ImportTag tag,
                                  DataSourceNode[] stack,
                                  java.util.Locale locale,
                                  IMacroState macroState)
                           throws DataSourceException

Description copied from interface: DataSourceNode

An extended version of getImport() which supports the macro evaluation.

Specified by:

getImport in interface DataSourceNode

Throws:

DataSourceException

getLink

public java.lang.String getLink(BaseTag tag,
                                DataSourceNode[] stack)
                         throws DataSourceException

Description copied from interface: DataSourceNode

Called for a link or DrillDown tag. Returns the link text that is the url for the link. Return a 0 length string for an empty node. Return null if the requested node does not exist.

Specified by:

getLink in interface DataSourceNode

Parameters:

tag - The values that identify the datasource node to read.

stack - The stack of forEach loops in at this point. Node [0] is the root document node so this will always have length of at least 1.

Returns:

The url for a link.

Throws:

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

getValue

public java.lang.String getValue(BaseTag tag,
                                 DataSourceNode[] stack,
                                 java.util.Locale locale,
                                 IMacroState macroState)
                          throws DataSourceException

Throws:

DataSourceException

getOut

public java.lang.Object getOut(OutTag tag,
                               DataSourceNode[] stack,
                               java.util.Locale locale,
                               IMacroState state)
                        throws DataSourceException

Description copied from interface: DataSourceNode

Called for an out tag. Returns the object to be inserted into the report. Return a 0 length string for an empty node. Return null if the requested node does not exist and there is no default value. This can be a String, Number, or Date.

Specified by:

getOut in interface DataSourceNode

Parameters:

tag - The values that identify the datasource node to read.

stack - The stack of forEach loops in at this point. Node [0] is the root document node so this will always have length of at least 1.

locale - The locale to produce the output in.

state - The macro state of the report

Returns:

The object to insert into the report.

Throws:

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

drillDownToVal

public java.lang.Object drillDownToVal(java.lang.Object rtn,
                                       java.lang.String tagType)
                                throws DataSourceException

Drills through result sets to get the final return value. Only public for .net extension methods. This closes the passed in IDataSourceResultSet object, if the passed in object is a IDataSourceResultSet.

Parameters:

rtn - Usually an IDataSourceResultSet or DataSourceResultRow that we need to drill into

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

Returns:

The data in the passed in data result.

Throws:

DataSourceException

getOutStream

public InputDataContainer getOutStream(OutTag tag,
                                       DataSourceNode[] stack,
                                       IMacroState state)
                                throws DataSourceException

Description copied from interface: DataSourceNode

Called for an out tag. Returns the raw bytes of a node. This is used to read a rtf or xml file from the database. Return a 0 length stream for an empty node. Return null if the requested node does not exist and there is no default value.

Specified by:

getOutStream in interface DataSourceNode

Parameters:

tag - The values that identify the datasource node to read.

stack - The stack of forEach loops in at this point. Node [0] is the root document node so this will always have length of at least 1.

state - macrostate of the report

Returns:

The text to insert into the report.

Throws:

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

isExistingNode

public boolean isExistingNode(BaseTag tag,
                              DataSourceNode[] stack)
                       throws DataSourceException

Description copied from interface: DataSourceNode

Return true if the passed in node exists. This should return true even if the passed in node is empty. This method needs to be fast.

Specified by:

isExistingNode in interface DataSourceNode

Parameters:

tag - The values that identify the datasource node to read.

stack - The stack of forEach loops in at this point. Node [0] is the root document node so this will always have length of at least 1.

Returns:

True if the node exists, false otherwise.

Throws:

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

evaluate

public boolean evaluate(java.lang.String text,
                        DataSourceNode[] stack,
                        IMacroState macroState)
                 throws DataSourceException

Description copied from interface: DataSourceNode

Evaluate an expression for the boolean result.

Specified by:

evaluate in interface DataSourceNode

Parameters:

text - The expression to evaluate.

stack - The stack of forEach loops in at this point. Node [0] is the root document node so this will always have length of at least 1.

macroState - macrostate of the report

Returns:

true or false.

Throws:

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

isIf

public boolean isIf(IfTag tag,
                    DataSourceNode[] stack,
                    IMacroState macroState)
             throws DataSourceException

Description copied from interface: DataSourceNode

Called for an if tag. Returns if the node exists. This normally is identical to isExistingNode() but can be different as this determines if an <wr:if ... > tag will return true while isExistingNode is used in numerous other cases.

Specified by:

isIf in interface DataSourceNode

Parameters:

tag - The values that identify the datasource node to read.

stack - The stack of forEach loops in at this point. Node [0] is the root document node so this will always have length of at least 1.

macroState - macrostate of the report

Returns:

True if the node exists, false otherwise.

Throws:

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

addSwitch

public boolean addSwitch(SwitchTag tag,
                         DataSourceNode[] stack)
                  throws DataSourceException

Description copied from interface: DataSourceNode

Called for a switch tag. Adds this switch to the list of switch the document holds. This switch will continue until the endSwitch is called.

Specified by:

addSwitch in interface DataSourceNode

Parameters:

tag - The values that identify the datasource node to read.

stack - The stack of forEach loops in at this point. Node [0] is the root document node so this will always have length of at least 1.

Returns:

true if no select. For a select, true if returned 1 or more rows of data. false if no data.

Throws:

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

isCase

public boolean isCase(CaseTag tag,
                      DataSourceNode[] stack,
                      IMacroState macroState)
               throws DataSourceException

Description copied from interface: DataSourceNode

Called for a case tag. Returns if the case is true. This normally is identical to isExistingNode() but can be different as this determines if an <wr:case ... > tag will return true while isExistingNode is used in numerous other cases.

Specified by:

isCase in interface DataSourceNode

Parameters:

tag - The values that identify the datasource node to read.

stack - The stack of forEach loops in at this point. Node [0] is the root document node so this will always have length of at least 1.

macroState - macro state of the report

Returns:

True if the case is true, false otherwise.

Throws:

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

endSwitch

public void endSwitch(EndSwitchTag tag,
                      DataSourceNode[] stack)

Description copied from interface: DataSourceNode

Called when a switch ends. Will pop the innermost switch off the internal stack.

Specified by:

endSwitch in interface DataSourceNode

Parameters:

tag - The values that identify the datasource node to read.

stack - The stack of forEach loops in at this point. Node [0] is the root document node so this will always have length of at least 1.

iterator

public DataSourceIterator iterator(ForEachTag tag,
                                   DataSourceNode[] stack)
                            throws DataSourceException

Called for a forEach tag. Returns an iterator used to walk through the nodes that match the forEach tag. It is the responsibility of this iterator to handle begin, step, and end in the tag. If there are no nodes, an iterator that will return false on the first call to hasNext() should be returned.
Windward Reports will never request multiple simultaneous iterators from a DataSourceNode. When this method is called, any iterators from previous calls to this method are no longer in use. This restriction is critical for the functionality of the method getIterator().

Specified by:

iterator in interface DataSourceNode

Parameters:

tag - The values that identify the datasource node to read.

stack - The stack of forEach loops in at this point. Node [0] is the root document node so this will always have length of at least 1.

Returns:

An iterator to walk the nodes that match.

Throws:

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

getIterator

public DataSourceIterator getIterator()
                               throws DataSourceException

Description copied from interface: DataSourceNode

Returns the iterator presently in use for this node. This is not the method called when processing a forEach tag. The method called to process a forEach tag is iterator(). This method is called to get the iterator in use for a node..
Windward Reports will never request multiple simultaneous iterators from a DataSourceNode. This restriction is critical for the functionality of this method.
This is not the iterator that returned this in it's iteration. It is the iterator created by this node and is returning nodes 1 level higher in the node stack. For example, stack[0] holds the iterator for the node at stack[1]. And by definition, the node at the top of the stack cannot have an iterator (because if it did, the first node returned by that iterator would then be on the top of the stack).

Specified by:

getIterator in interface DataSourceNode

Returns:

The iterator in use for this node. Will return null if no iterator is in use for this node.

Throws:

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

close

public void close()
           throws DataSourceException

Description copied from interface: DataSourceNode

We are done with this node. Used to close any resources opened by this object.

Specified by:

close in interface DataSourceNode

Throws:

DataSourceException - Could not retrieve the data.

getData

public ChartDataSet getData(ChartTag tag,
                            DataSourceNode[] stack,
                            java.util.Locale locale)
                     throws DataSourceException

Description copied from interface: DataSourceNode

Returns a set of data used to create a chart. The structure of this is tied tightly to the chart package.

Specified by:

getData in interface DataSourceNode

Parameters:

tag - The wr:chart tag with the select setting to use.

stack - The stack of forEach loops in at this point. Node [0] is the root document node so this will always have length of at least 1.

locale - The locale to produce the output in.

Returns:

The data used by the charting functions to create the chart.

Throws:

DataSourceException - Could not retrieve the data.

getCursor

public java.lang.Object getCursor()
                           throws DataSourceException

Description copied from interface: DataSourceNode

Returns the underlying cursor this node presently holds. This is implementation specific.

Specified by:

getCursor in interface DataSourceNode

Returns:

the underlying cursor this node presently holds.

Throws:

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

getVariableValue

public java.lang.Object[] getVariableValue(java.lang.String variable,
                                           DataSourceNode[] stack,
                                           java.util.Locale locale)
                                    throws DataSourceException

Description copied from interface: DataSourceNode

Returns the variable value.

Specified by:

getVariableValue in interface DataSourceNode

Parameters:

variable - The string containing the variable name.

stack - The stack of forEach loops in at this point. Node [0] is the root document node so this will always have length of at least 1.

locale - The locale to produce the output in.

Returns:

The desired variable value.

Throws:

DataSourceException

getEquationData

public java.lang.Object[] getEquationData(java.lang.String query,
                                          DataSourceNode[] stack,
                                          java.util.Locale locale)
                                   throws DataSourceException

Description copied from interface: DataSourceNode

Returns an array of data from a given datasource query

Specified by:

getEquationData in interface DataSourceNode

Parameters:

query - The datasource query.

stack - The stack of forEach loops in at this point. Node [0] is the root document node so this will always have length of at least 1.

locale - The locale to produce the output in.

Returns:

The desired array of data

Throws:

DataSourceException

getDatasourceState

public DebugDatasourceState getDatasourceState(DataSourceNode[] stack)

Description copied from interface: DataSourceNode

Get the state of the datasource. Used by the debugger.

Specified by:

getDatasourceState in interface DataSourceNode

Parameters:

stack - The stack of forEach loops in at this point. Node [0] is the root document node so this will always have length of at least 1.

Returns:

The datasource state.

parse

public ParsedQuery parse(java.lang.String query,
                         DataSourceNode[] stack,
                         int mode,
                         int returnType,
                         java.lang.String tagType,
                         boolean ignoreUndefinedParams)
                  throws DataSourceException

parses the query and gets variable results. only public to make .NET extension methods possible.

Parameters:

query - The query to parse.

stack - The stack of forEach tags we're in the scope of. stack[0] is the root node.

mode -

returnType -

tagType -

ignoreUndefinedParams - ture to replace undefined ${vars} clauses in the select with "1 = 1". Should only be used for getting metadata.

Returns:

The parsed query.

Throws:

DataSourceException - thrown if anything goes wrong.

getDataSourceProvider

public DataSourceProvider getDataSourceProvider()

Description copied from interface: DataSourceNode

Get the parent datasource.

Specified by:

getDataSourceProvider in interface DataSourceNode

Returns:

The datasource.