AbstractDataSource.AbstractDataSourceNode (Windward Reports 15.2 API)

java.lang.Object
- net.windward.datasource.abstract_datasource.AbstractDataSource.AbstractDataSourceNode

All Implemented Interfaces:

DataSourceNode

Direct Known Subclasses:

SalesForceDataSource.SalesForceDataSourceNode

Enclosing class:

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

Constructor Summary

Constructors
Constructor and Description

AbstractDataSourceNode()

Constructors
Constructor and Description
`AbstractDataSourceNode()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
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.
`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`	`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.
`int`	`getQueryMode(java.lang.String query, BaseTag tag)` Returns the mode of a query.
`java.lang.String`	`getValue(BaseTag tag, DataSourceNode[] stack, IMacroState macroState, java.util.Locale locale)`
`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`	`isQuery(java.lang.String s)`
`boolean`	`isSelect(java.lang.String select, boolean textIsNode)` Returns true if the passed in string is believed to be a select.
`abstract DataSourceIterator`	`iterator(ForEachTag tag, DataSourceNode[] stack)` Called for a forEach tag.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractDataSourceNode
```
public AbstractDataSourceNode()
```
- Method Detail
  - isQuery
```
public boolean isQuery(java.lang.String s)
```
  - 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
  - isSelect
```
public boolean isSelect(java.lang.String select,
                        boolean textIsNode)
```
    Description copied from interface: DataSourceNode
    
    Returns true if the passed in string is believed to be a select. false otherwise.
    
    Specified by:
    
    isSelect in interface DataSourceNode
    
    Parameters:
    
    select - Determine if this string is a select.
    
    textIsNode - true if plain text is a nod. false if it's a value.
    
    Returns:
    
    true if believed to be a select. false otherwise.
  - getQueryMode
```
public int getQueryMode(java.lang.String query,
                        BaseTag tag)
                 throws DataSourceException
```
    Description copied from interface: DataSourceNode
    
    Returns the mode of a query. It is one of the BaseTag.MODE_* values. This tells the underlying provider if the passed in select is a select=, evaluate=, or value=.
    
    Specified by:
    
    getQueryMode in interface DataSourceNode
    
    Parameters:
    
    query - The query.
    
    tag - The tag this select is for. This may be null.
    
    Returns:
    
    The mode.
    
    Throws:
    
    DataSourceException
  - 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,
                                 IMacroState macroState,
                                 java.util.Locale locale)
                          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.
  - 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 abstract DataSourceIterator iterator(ForEachTag tag,
                                            DataSourceNode[] stack)
                                     throws DataSourceException
```
    Description copied from interface: DataSourceNode
    
    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.
    
    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.
  - getDataSourceProvider
```
public DataSourceProvider getDataSourceProvider()
```
    Description copied from interface: DataSourceNode
    
    Get the parent datasource.
    
    Specified by:
    
    getDataSourceProvider in interface DataSourceNode
    
    Returns:
    
    The datasource.

Class AbstractDataSource.AbstractDataSourceNode

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractDataSourceNode

Method Detail

isQuery

addSet

isSelect

getQueryMode

addQuery

getBitmap

getImport

getImport

getLink

getValue

getOut

getOutStream

isExistingNode

evaluate

isIf

addSwitch

isCase

endSwitch

iterator

getIterator

close

getData

getCursor

getVariableValue

getEquationData

getDatasourceState

getDataSourceProvider