net.windward.datasource.json

Class JsonDataSource

java.lang.Object

net.windward.datasource.DataSourceBase

net.windward.datasource.json.JsonDataSource

All Implemented Interfaces:

DataSourceProvider

public class JsonDataSource
extends DataSourceBase
implements DataSourceProvider

JsonDataSource

Written by: Sarah Scheffler

This software is the confidential and proprietary information of Windward Studios ("Confidential Information"). You shall not disclose such Confidential Information and shall use it only in accordance with the terms of the license agreement you entered into with Windward Studios, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonDataSource.SortingComparer

Field Summary

Fields

Modifier and Type	Field and Description
static int	MODE_CONNECTION_STRING constructor using mode the string is a connection string.
static int	MODE_RAW_TEXT constructor using mode the string is the JSON in the string.

Constructor Summary

Constructors

Constructor and Description
JsonDataSource(java.io.File src) Deprecated. use connection string constructor instead
JsonDataSource(java.io.File src, java.lang.String encoding) Deprecated. use connection string constructor instead
JsonDataSource(java.io.InputStream jsonStream, java.lang.String encoding) Creates a Json data source from an InputStream.
JsonDataSource(java.lang.String urlOrFilename, boolean isLocation) Deprecated. use connection string constructor instead
JsonDataSource(java.lang.String locationOrRawJson, boolean isLocation, java.lang.String encoding) Deprecated. use connection string constructor instead
JsonDataSource(java.lang.String jsonConnectionString, int mode) Create a DataSourceProvider using the passed in connection strings.
JsonDataSource(java.lang.String location, java.lang.String encoding, java.lang.String username, java.lang.String password) Deprecated. use connection string constructor instead

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 Called in XmlSubNodeVisitor when tag is validated
void	close() Called when processing is complete.
java.lang.Object	convertToDataClass(java.lang.Object entity, int mode)
java.lang.Object	convertToDataClass(java.lang.String tagType, java.lang.Object entity, int mode)
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.
boolean	isIgnoreEvaluateExceptions()
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	setIgnoreEvaluateExceptions(boolean ignoreEvaluateExceptions)
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 tagToCheck) Verifys that a tag has all required attributes and no unknown attributes.

Methods inherited from class net.windward.datasource.DataSourceBase

convertToInputStream

Methods inherited from class java.lang.Object

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

Field Detail

MODE_CONNECTION_STRING

public static final int MODE_CONNECTION_STRING

constructor using mode the string is a connection string.

See Also:

Constant Field Values

MODE_RAW_TEXT

public static final int MODE_RAW_TEXT

constructor using mode the string is the JSON in the string.

See Also:

Constant Field Values

Constructor Detail

JsonDataSource

public JsonDataSource(java.io.File src)
               throws DataConnectionException

Deprecated. use connection string constructor instead

Creates a Json data source from a File.

Parameters:

src - - File to use

Throws:

DataConnectionException

JsonDataSource

public JsonDataSource(java.lang.String jsonConnectionString,
                      int mode)
               throws DataConnectionException

Create a DataSourceProvider using the passed in connection strings.

Parameters:

jsonConnectionString - Connection string to read the XML file. Or if mode is raw text, the actual JSON.

mode - One of the MODE_CONNECTION_* values

Throws:

DataConnectionException

JsonDataSource

public JsonDataSource(java.io.File src,
                      java.lang.String encoding)
               throws DataConnectionException

Deprecated. use connection string constructor instead

Creates a Json data source from a File.

Parameters:

src - - File to use

encoding - - character encoding of the file

Throws:

DataConnectionException

JsonDataSource

public JsonDataSource(java.io.InputStream jsonStream,
                      java.lang.String encoding)
               throws DataConnectionException

Creates a Json data source from an InputStream.

Parameters:

jsonStream - - Stream to create the data source from.

encoding - - character encoding of the file

Throws:

DataConnectionException

JsonDataSource

public JsonDataSource(java.lang.String urlOrFilename,
                      boolean isLocation)
               throws DataConnectionException

Deprecated. use connection string constructor instead

Create a Json data source from a URL/file path, or from a raw json string

Parameters:

urlOrFilename - - URL or file location

isLocation - - True if locationOrRawJson is a URL/file path, false if it is a raw json string.

Throws:

DataConnectionException

JsonDataSource

public JsonDataSource(java.lang.String locationOrRawJson,
                      boolean isLocation,
                      java.lang.String encoding)
               throws DataConnectionException

Deprecated. use connection string constructor instead

Create a Json data source from a URL/file path, or from a raw json string

Parameters:

locationOrRawJson - - URL or file location

isLocation - - True if locationOrRawJson is a URL/file path, false if it is a raw json string.

encoding - -encoding of the file if isLocation = true

Throws:

DataConnectionException

JsonDataSource

public JsonDataSource(java.lang.String location,
                      java.lang.String encoding,
                      java.lang.String username,
                      java.lang.String password)
               throws DataConnectionException

Deprecated. use connection string constructor instead

Only supports BASIC for now

Parameters:

location -

username -

password -

encoding - the encoding of the json file to be downloaded

Throws:

DataConnectionException

Method Detail

getDatasourceName

public java.lang.String getDatasourceName()

returns the name of this type in the form "sql", "xml", etc.

Specified by:

getDatasourceName in interface DataSourceProvider

Returns:

"json"

isIgnoreEvaluateExceptions

public boolean isIgnoreEvaluateExceptions()

setIgnoreEvaluateExceptions

public void setIgnoreEvaluateExceptions(boolean ignoreEvaluateExceptions)

getParamMode

public int getParamMode()

Description copied from interface: DataSourceProvider

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)

Description copied from interface: DataSourceProvider

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.

setMap

public 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.

Specified by:

setMap in interface DataSourceProvider

Parameters:

map - The map of string pairs.

getMap

public java.util.Map getMap()

Description copied from interface: DataSourceProvider

Returns the map of variables for this datasource.

Specified by:

getMap in interface DataSourceProvider

Returns:

the map of variables for this datasource.

setDatasets

public void setDatasets(java.lang.Object[] datasets)

Description copied from interface: DataSourceProvider

Set the datasets to use with this datasource. This will overwrite datasets from previous calls to this method.

Specified by:

setDatasets in interface DataSourceProvider

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

public DataSourceNode getRootNode()
                           throws DataSourceException

Description copied from interface: DataSourceProvider

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.

Throws:

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

close

public void close()
           throws DataSourceException

Description copied from interface: DataSourceProvider

Called when processing is complete. Used to close any resources opened by this object.

Specified by:

close in interface DataSourceProvider

Throws:

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

getTagAttributes

public TagAttributes[] getTagAttributes()

Description copied from interface: DataSourceProvider

Returns the allowed attributes for all tags.

Specified by:

getTagAttributes in interface DataSourceProvider

Returns:

The tag attributes.

validateTag

public void validateTag(BaseTag tagToCheck)
                 throws TagException

Description copied from interface: DataSourceProvider

Verifys that a tag has all required attributes and no unknown attributes.

Specified by:

validateTag in interface DataSourceProvider

Parameters:

tagToCheck - The tag to check

Throws:

TagException - thrown if illegal parameters passed in.

approveDenyModifySelect

public void approveDenyModifySelect(BaseTag xmlTag)
                             throws DataSourceException

Description copied from interface: DataSourceProvider

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

Specified by:

approveDenyModifySelect in interface DataSourceProvider

Parameters:

xmlTag - The tag to check

Throws:

DataSourceException - thrown if illegal parameters passed in.

getQueryMode

public int getQueryMode(java.lang.String select,
                        BaseTag tag)
                 throws DataSourceException

Description copied from interface: DataSourceProvider

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=.

Specified by:

getQueryMode in interface DataSourceProvider

Parameters:

select - The query

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

Returns:

The mode

Throws:

DataSourceException

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.

convertToDataClass

public java.lang.Object convertToDataClass(java.lang.String tagType,
                                           java.lang.Object entity,
                                           int mode)

convertToDataClass

public java.lang.Object convertToDataClass(java.lang.Object entity,
                                           int mode)