DataSourceProvider (Windward Reports 15.2 API)

All Known Implementing Classes:

AbstractDataSource, Dom4jDataSource, JdbcDataSource, JsonDataSource, SalesForceDataSource
```
public interface DataSourceProvider
```
This supplies a data source to Windward Reports. Implementation of this interface is necessary and sufficient to provide a data source to Windward Reports. This object lives for the lifetime of substituting data into a report.

Version:

2.0 2 January 2004

Method Summary

All Methods Instance Methods Abstract Methods
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 Called in XmlSubNodeVisitor when tag is validated
`void`	`close()` Called when processing is complete.
`java.lang.String`	`getDatasourceName()` returns the name of this type in the form "sql", "xml", etc.
`java.util.Map`	`getMap()` Returns the map of variables for this datasource.
`int`	`getParamMode()` Get the parameter substitution mode.
`int`	`getQueryMode(java.lang.String select, BaseTag tag)` Returns the mode of a query.
`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().
`void`	`setDatasets(java.lang.Object[] datasets)` Set the datasets to use with this datasource.
`void`	`setMap(java.util.Map map)` 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.

- Method Detail
  - getDatasourceName
```
java.lang.String getDatasourceName()
```
    returns the name of this type in the form "sql", "xml", etc.
    
    Returns:
    
    "sql", "xml", etc.
  - getParamMode
```
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.)
    
    Returns:
    
    the parameter substitution mode.
  - setParamMode
```
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.)
    
    Parameters:
    
    paramMode - the parameter substitution mode.
  - setMap
```
void setMap(java.util.Map map)
```
    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.
    
    Parameters:
    
    map - The map of string pairs.
  - getMap
```
java.util.Map getMap()
```
    Returns the map of variables for this datasource.
    
    Returns:
    
    the map of variables for this datasource.
  - setDatasets
```
void setDatasets(java.lang.Object[] datasets)
```
    Set the datasets to use with this datasource. This will overwrite datasets from previous calls to this method.
    
    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.
  - getRootNode
```
DataSourceNode getRootNode()
                    throws DataSourceException
```
    Returns the root node for this data set. Outside of forEach loops this is the node all tag requests will be evaluated against.
    
    Returns:
    
    The root node.
    
    Throws:
    
    DataSourceException - Could not retrieve the data. Generally wraps a SqlException or XpathException.
  - close
```
void close()
    throws DataSourceException
```
    Called when processing is complete. Used to close any resources opened by this object.
    
    Throws:
    
    DataSourceException - Could not retrieve the data. Generally wraps a SqlException or XpathException.
  - getTagAttributes
```
TagAttributes[] getTagAttributes()
```
    Returns the allowed attributes for all tags.
    
    Returns:
    
    The tag attributes.
  - validateTag
```
void validateTag(BaseTag xmlTag)
          throws TagException,
                 DataSourceException
```
    Verifys that a tag has all required attributes and no unknown attributes.
    
    Parameters:
    
    xmlTag - The tag to check
    
    Throws:
    
    TagException - thrown if illegal parameters passed in.
    
    DataSourceException
  - populateDatasourceException
```
void populateDatasourceException(DataSourceException exception,
                                 BaseTag tag,
                                 DataSourceNode[] stack)
```
    Populates that properties in a DataSourceException via DataSourceException.setProperties().
    
    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.
  - approveDenyModifySelect
```
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 Called in XmlSubNodeVisitor when tag is validated
    
    Parameters:
    
    xmlTag - The tag to check
    
    Throws:
    
    DataSourceException - thrown if illegal parameters passed in.
  - getQueryMode
```
int getQueryMode(java.lang.String select,
                 BaseTag tag)
          throws DataSourceException
```
    Returns the mode of a query. It is one of the BaseTag.MODE_* values. This tells the underlying provide if the passed in select is a select=, evaluate=, or value=.
    
    Parameters:
    
    select - The query
    
    tag - The tag this select is for. This may be null.
    
    Returns:
    
    The mode
    
    Throws:
    
    DataSourceException

Interface DataSourceProvider

Method Summary

Method Detail

getDatasourceName

getParamMode

setParamMode

setMap

getMap

setDatasets

getRootNode

close

getTagAttributes

validateTag

populateDatasourceException

approveDenyModifySelect

getQueryMode