net.windward.datasource.json

Class JsonDataSource

java.lang.Object

net.windward.datasource.DataSourceBase

net.windward.datasource.abstract_datasource.AbstractDataSource

net.windward.datasource.json.JsonDataSource

All Implemented Interfaces:

DataSourceProvider

public class JsonDataSource
extends AbstractDataSource

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
class	JsonDataSource.JsonDataNode
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.

Fields inherited from class net.windward.datasource.abstract_datasource.AbstractDataSource

rootNode

Fields inherited from interface net.windward.datasource.DataSourceProvider

NAME_DATASET, NAME_JSON, NAME_LITERAL, NAME_ODATA, NAME_SFDC, NAME_SQL, NAME_XML, NAME_XML_1_0

Constructor Summary

Constructors

Constructor and Description
JsonDataSource(java.io.InputStream jsonStream, java.lang.String encoding) Creates a Json data source from an InputStream.
JsonDataSource(java.lang.String jsonConnectionString, int mode) Create a DataSourceProvider using the passed in connection strings.

Method Summary

Modifier and Type	Method and Description
void	close() Clean up resources.
java.lang.String	combineQueryForDataSet(java.lang.String dataSetQuery, java.lang.String query, java.lang.String dataSetName)
java.lang.String	getDatasourceName() returns the name of this type in the form "sql", "xml", etc.
IDataSourceQueryHelper	getQueryHelper() Gets the query helper from the subclass.
int	getQueryMode(java.lang.String select, BaseTag tag) Gets the query mode of a select.
boolean	supportsDataSets() Does this datasource support data sets?

Methods inherited from class net.windward.datasource.abstract_datasource.AbstractDataSource

approveDenyModifySelect, dataSourceNodeWithIndex, drillDownToVal, getParameters, getParamMode, getRootNode, getTagAttributes, populateDatasourceException, returnValue, SetDseProps, setParameters, setParamMode, validateTag

Methods inherited from class net.windward.datasource.DataSourceBase

convertToInputStream, forTesting, getProperties, lookupVariable, setProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.windward.datasource.DataSourceProvider

getProperties, setProperties

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

Method Detail

getDatasourceName

public java.lang.String getDatasourceName()

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

Returns:

"json"

getQueryHelper

public IDataSourceQueryHelper getQueryHelper()

Gets the query helper from the subclass.

Specified by:

getQueryHelper in class AbstractDataSource

Returns:

close

public void close()
           throws DataSourceException

Description copied from class: AbstractDataSource

Clean up resources.

Specified by:

close in interface DataSourceProvider

Specified by:

close in class AbstractDataSource

Throws:

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

getQueryMode

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

Description copied from class: AbstractDataSource

Gets the query mode of a select. This is datasource specific, so it needs to be implemented every time.

Specified by:

getQueryMode in interface DataSourceProvider

Specified by:

getQueryMode in class AbstractDataSource

Parameters:

select - The query we need to return the mode for

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

Returns:

The mode

supportsDataSets

public boolean supportsDataSets()

Does this datasource support data sets?

Specified by:

supportsDataSets in class DataSourceBase

Returns:

true if supported false if not

combineQueryForDataSet

public java.lang.String combineQueryForDataSet(java.lang.String dataSetQuery,
                                               java.lang.String query,
                                               java.lang.String dataSetName)

Specified by:

combineQueryForDataSet in class AbstractDataSource