DataSourceProvider (Windward Studios 21.2 API)

All Known Implementing Classes:

AbstractDataSource, Dom4jDataSource, JdbcDataSource, JsonDataSource
```
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

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`NAME_DATASET` getDatasourceName() will return this for a dataset.
`static java.lang.String`	`NAME_JSON` getDatasourceName() will return this for a JSON datasource.
`static java.lang.String`	`NAME_LITERAL` getDatasourceName() will return this for the internal literal datasource.
`static java.lang.String`	`NAME_ODATA` getDatasourceName() will return this for a OData datasource.
`static java.lang.String`	`NAME_SFDC` getDatasourceName() will return this for a SalesForce datasource.
`static java.lang.String`	`NAME_SQL` getDatasourceName() will return this for a SQL datasource.
`static java.lang.String`	`NAME_XML` getDatasourceName() will return this for a XML datasource.
`static java.lang.String`	`NAME_XML_1_0` getDatasourceName() will return this for a XML (XPath 1.0) datasource.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated 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<java.lang.String,java.lang.Object>`	`getParameters()` This call is for internal engine use only.
`int`	`getParamMode()` Deprecated. Use ReportProperties.getString(SQL_PARAMETERS)
`ReportProperties`	`getProperties()` Get properties currently in use.
`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`	`setParameters(java.util.Map<java.lang.String,java.lang.Object> parameters)` This call is for internal engine use only.
`void`	`setParamMode(int paramMode)` Deprecated. Use ReportProperties.setString(SQL_PARAMETERS)
`void`	`setProperties(ReportProperties properties)` Sets properties used by a report object.
`void`	`validateTag(BaseTag xmlTag)` Verifys that a tag has all required attributes and no unknown attributes.

- Field Detail
  - NAME_SQL
```
static final java.lang.String NAME_SQL
```
    getDatasourceName() will return this for a SQL datasource.
    
    See Also:
    
    Constant Field Values
  - NAME_JSON
```
static final java.lang.String NAME_JSON
```
    getDatasourceName() will return this for a JSON datasource.
    
    See Also:
    
    Constant Field Values
  - NAME_LITERAL
```
static final java.lang.String NAME_LITERAL
```
    getDatasourceName() will return this for the internal literal datasource.
    
    See Also:
    
    Constant Field Values
  - NAME_ODATA
```
static final java.lang.String NAME_ODATA
```
    getDatasourceName() will return this for a OData datasource.
    
    See Also:
    
    Constant Field Values
  - NAME_SFDC
```
static final java.lang.String NAME_SFDC
```
    getDatasourceName() will return this for a SalesForce datasource.
    
    See Also:
    
    Constant Field Values
  - NAME_XML
```
static final java.lang.String NAME_XML
```
    getDatasourceName() will return this for a XML datasource.
    
    See Also:
    
    Constant Field Values
  - NAME_XML_1_0
```
static final java.lang.String NAME_XML_1_0
```
    getDatasourceName() will return this for a XML (XPath 1.0) datasource.
    
    See Also:
    
    Constant Field Values
  - NAME_DATASET
```
static final java.lang.String NAME_DATASET
```
    getDatasourceName() will return this for a dataset.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getDatasourceName
```
java.lang.String getDatasourceName()
```
    returns the name of this type in the form "sql", "xml", etc. Use the NAME_* static strings defined here for the names.
    
    Returns:
    
    "sql", "xml", etc.
  - getParamMode
```
int getParamMode()
```
    Deprecated. Use ReportProperties.getString(SQL_PARAMETERS)
    
    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)
```
    Deprecated. Use ReportProperties.setString(SQL_PARAMETERS)
    
    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.
  - setParameters
```
void setParameters(java.util.Map<java.lang.String,java.lang.Object> parameters)
```
    This call is for internal engine use only. Do not call this!
    
    Parameters:
    
    parameters - This object is directly assigned for use as it is shared. Therefore any changes to it after this call effect the datasource.
  - getParameters
```
java.util.Map<java.lang.String,java.lang.Object> getParameters()
```
    This call is for internal engine use only. Do not call this!
  - 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)
                          throws DataSourceException
```
    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.
    
    Throws:
    
    DataSourceException
  - 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)
```
    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
  - setProperties
```
void setProperties(ReportProperties properties)
```
    Sets properties used by a report object. Used internally by the engine!
  - getProperties
```
ReportProperties getProperties()
```
    Get properties currently in use. Used internally by the engine!

Interface DataSourceProvider

Field Summary

Method Summary

Field Detail

NAME_SQL

NAME_JSON

NAME_LITERAL

NAME_ODATA

NAME_SFDC

NAME_XML

NAME_XML_1_0

NAME_DATASET

Method Detail

getDatasourceName

getParamMode

setParamMode

setParameters

getParameters

getRootNode

close

getTagAttributes

validateTag

populateDatasourceException

approveDenyModifySelect

getQueryMode

setProperties

getProperties