sapphire.accessor

Class QueryProcessor

java.lang.Object

com.labvantage.sapphire.BaseClass

com.labvantage.sapphire.BaseAccessor

sapphire.accessor.QueryProcessor

public class QueryProcessor
extends com.labvantage.sapphire.BaseAccessor

Supports QueryManager access and related functions

Field Summary

Fields inherited from class com.labvantage.sapphire.BaseAccessor

jndiPrefix, local, localJNDIPrefix, remoteAccessKey

Fields inherited from class com.labvantage.sapphire.BaseClass

FAILURE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
QueryProcessor(java.io.File rakFile, java.lang.String connectionid) Constructor for a client application with an existing connection
QueryProcessor(javax.servlet.jsp.PageContext pageContext) Constructor for a client web application with a page Context and existing connectionid
QueryProcessor(java.lang.String connectionid) Constructor for creating an accessor from components
QueryProcessor(java.lang.String nameserverlist, java.lang.String connectionid) Deprecated.

Method Summary

Modifier and Type	Method and Description
int	execPreparedUpdate(java.lang.String sql, java.lang.Object[] bindvars) Utility method for passing a prepared SQL along with bind variables to be executed against the database by the application server.
int	execSQL(int sqlCode)
int	execSQL(int sqlCode, java.lang.Object[] bindVars)
int	execSQL(java.lang.String sql) Utility method for passing SQL to be executed against the database by the application server.
int	getCount(java.lang.String sql) Executes the sql the should return a single row with a single number value.
java.lang.String	getKeyid1List(java.lang.String sdcid, java.lang.String queryid) Executes the supplied Sapphire query and returns the list of sdi(s).
java.lang.String	getKeyid1List(java.lang.String sdcid, java.lang.String queryid, java.lang.String[] params) Executes the supplied Sapphire query and returns the list of sdi(s).
java.lang.String	getKeyid1List(java.lang.String sdcid, java.lang.String queryid, java.lang.String param1, java.lang.String param2, java.lang.String param3, java.lang.String param4, java.lang.String param5) Executes the supplied Sapphire query and returns the list of sdi(s).
int	getPreparedCount(java.lang.String sql, java.lang.Object[] params) Executes the sql with bind variables the should return a single row with a single number value.
DataSet	getPreparedSqlDataSet(int sqlCode, java.lang.Object[] params) Returns a sapphire.util.DataSet that reflects the resultset for the given sql
DataSet	getPreparedSqlDataSet(int sqlCode, java.lang.Object[] params, boolean extendedDataTypes) Returns a sapphire.util.DataSet that reflects the resultset for the given sql
DataSet	getPreparedSqlDataSet(java.lang.String sql, java.lang.Object[] params) Returns a sapphire.util.DataSet that reflects the resultset for the given sql
DataSet	getPreparedSqlDataSet(java.lang.String sql, java.lang.Object[] params, boolean extendedDataTypes) Returns a sapphire.util.DataSet that reflects the resultset for the given sql
DataSet	getPreparedSqlDataSet(java.lang.String name, java.lang.String sql, java.lang.Object[] params) Returns a sapphire.util.DataSet that reflects the resultset for the given sql
DataSet	getPreparedSqlDataSet(java.lang.String name, java.lang.String sql, java.lang.Object[] params, boolean extendedDataTypes) Returns a sapphire.util.DataSet that reflects the resultset for the given sql
DataSet	getPreparedSqlDataSet(java.lang.String name, java.lang.String sql, java.lang.Object[] params, boolean extendedDataTypes, int queryTimeout) Returns a sapphire.util.DataSet that reflects the resultset for the given sql
DataSet	getRefTypeDataSet(java.lang.String reftypeid) Returns a dataset that contains the details of the reference values for the supplied ReferenceType.
java.lang.String	getSecurityFilterWhere(java.lang.String sdcid)
DataSet	getSqlDataSet(int sqlCode) Returns a sapphire.util.DataSet that reflects the resultset for the given sqlcode
DataSet	getSqlDataSet(int sqlCode, boolean extendedDataTypes) Returns a sapphire.util.DataSet that reflects the resultset for the given sqlcode
DataSet	getSqlDataSet(int sqlCode, java.lang.Object[] bindVars) Returns a sapphire.util.DataSet that reflects the resultset for the given sqlcode
DataSet	getSqlDataSet(int sqlCode, java.lang.Object[] bindVars, boolean extendedDataTypes) Returns a sapphire.util.DataSet that reflects the resultset for the given sqlcode
DataSet	getSqlDataSet(java.lang.String sql) Returns a sapphire.util.DataSet that reflects the resultset for the given sql
DataSet	getSqlDataSet(java.lang.String sql, boolean extendedDataTypes) Returns a sapphire.util.DataSet that reflects the resultset for the given sql
DataSet	getSqlDataSet(java.lang.String name, java.lang.String sql) Returns a sapphire.util.DataSet that reflects the resultset for the given sql
DataSet	getSqlDataSet(java.lang.String name, java.lang.String sql, boolean extendedDataTypes) Returns a sapphire.util.DataSet that reflects the resultset for the given sql
DataSet	getSqlDataSet(java.lang.String name, java.lang.String sql, boolean extendedDataTypes, int queryTimeout) Returns a sapphire.util.DataSet that reflects the resultset for the given sql
DataSet	getSqlDataSet(java.lang.String name, java.lang.String sql, boolean extendedDataTypes, int queryTimeout, boolean keepAlive) Returns a sapphire.util.DataSet that reflects the resultset for the given sql

Methods inherited from class com.labvantage.sapphire.BaseAccessor

createRemoteAccessKey, getAttachmentManager, getAutomationManager, getConfigurationManager, getConnectionid, getErrorCodeList, getErrorCodeStack, getErrorHandler, getErrorStack, getErrorStack, getErrorString, getInfoErrorString, getLastError, getLastErrorCode, getLastErrorMessage, getLastException, getLocalAccessManager, getNameserverlist, getQueryManager, getRemoteAccessManager, getRequestManager, getStatusManager, getWebAdminManager, hasErrors, hasInfoErrors, parseServiceExceptionMsg, resetConnectionid, resetErrorStack, setConnectionDetails, setConnectionid, setError, setError, setErrorString, setInfoErrorString, setJNDIPrefix, setLocal, setLocalJNDIPrefix, setRakFile

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryProcessor

public QueryProcessor(java.lang.String connectionid)

Constructor for creating an accessor from components

Parameters:

connectionid - The connection to use for component calls

QueryProcessor

public QueryProcessor(java.lang.String nameserverlist,
                      java.lang.String connectionid)

Deprecated.

Constructor for a client application with an existing connection

Parameters:

nameserverlist - list of the application sever names

connectionid - A valid connectionid

QueryProcessor

public QueryProcessor(java.io.File rakFile,
                      java.lang.String connectionid)

Constructor for a client application with an existing connection

Parameters:

rakFile - A remote access key file

connectionid - A valid connectionid

QueryProcessor

public QueryProcessor(javax.servlet.jsp.PageContext pageContext)

Constructor for a client web application with a page Context and existing connectionid

Parameters:

pageContext - The current page context

Method Detail

getSqlDataSet

public DataSet getSqlDataSet(java.lang.String name,
                             java.lang.String sql)

Returns a sapphire.util.DataSet that reflects the resultset for the given sql

Parameters:

name - A name for the query that will be used to record the statistics

sql - The sql to generate the dataset

Returns:

dataset The resulting dataset. Note that for backwards compatability reasons, CLOB fields are omitted from the dataset

getSqlDataSet

public DataSet getSqlDataSet(java.lang.String sql)

Returns a sapphire.util.DataSet that reflects the resultset for the given sql

Parameters:

sql - The sql to generate the dataset

Returns:

dataset The resulting dataset. Note that for backwards compatability reasons, CLOB fields are omitted from the dataset

getSqlDataSet

public DataSet getSqlDataSet(int sqlCode)

Returns a sapphire.util.DataSet that reflects the resultset for the given sqlcode

Parameters:

sqlCode - Reference to the sql to generate the dataset

Returns:

dataset The resulting dataset. Note that for backwards compatability reasons, CLOB fields are omitted from the dataset

getSqlDataSet

public DataSet getSqlDataSet(int sqlCode,
                             java.lang.Object[] bindVars)

Returns a sapphire.util.DataSet that reflects the resultset for the given sqlcode

Parameters:

sqlCode - Reference to the sql to generate the dataset

bindVars - Bind variables for the sql

Returns:

dataset The resulting dataset. Note that for backwards compatability reasons, CLOB fields are omitted from the dataset

getSqlDataSet

public DataSet getSqlDataSet(java.lang.String sql,
                             boolean extendedDataTypes)

Returns a sapphire.util.DataSet that reflects the resultset for the given sql

Parameters:

sql - The sql to generate the dataset

extendedDataTypes - Whether the returned dataset will include CLOB fields

Returns:

dataset The resulting dataset

getSqlDataSet

public DataSet getSqlDataSet(int sqlCode,
                             boolean extendedDataTypes)

Returns a sapphire.util.DataSet that reflects the resultset for the given sqlcode

Parameters:

sqlCode - Reference to the sql to generate the dataset

extendedDataTypes - Whether the returned dataset will include CLOB fields

Returns:

dataset The resulting dataset. Note that for backwards compatability reasons, CLOB fields are omitted from the dataset

getSqlDataSet

public DataSet getSqlDataSet(int sqlCode,
                             java.lang.Object[] bindVars,
                             boolean extendedDataTypes)

Returns a sapphire.util.DataSet that reflects the resultset for the given sqlcode

Parameters:

sqlCode - Reference to the sql to generate the dataset

bindVars - Bind variables for the sql

extendedDataTypes - Whether the returned dataset will include CLOB fields

Returns:

dataset The resulting dataset. Note that for backwards compatability reasons, CLOB fields are omitted from the dataset

getSqlDataSet

public DataSet getSqlDataSet(java.lang.String name,
                             java.lang.String sql,
                             boolean extendedDataTypes)

Returns a sapphire.util.DataSet that reflects the resultset for the given sql

Parameters:

name - A name for the query that will be used to record the statistics

sql - The sql to generate the dataset

extendedDataTypes - Whether the returned dataset will include CLOB fields

Returns:

dataset The resulting dataset

getSqlDataSet

public DataSet getSqlDataSet(java.lang.String name,
                             java.lang.String sql,
                             boolean extendedDataTypes,
                             int queryTimeout)

Returns a sapphire.util.DataSet that reflects the resultset for the given sql

Parameters:

name - A name for the query that will be used to record the statistics

sql - The sql to generate the dataset

extendedDataTypes - Whether the returned dataset will include CLOB fields

queryTimeout - Specify time out in seconds to override system default query timeout. Set to zero to disable timeout

Returns:

dataset The resulting dataset

getSqlDataSet

public DataSet getSqlDataSet(java.lang.String name,
                             java.lang.String sql,
                             boolean extendedDataTypes,
                             int queryTimeout,
                             boolean keepAlive)

Returns a sapphire.util.DataSet that reflects the resultset for the given sql

Parameters:

name - A name for the query that will be used to record the statistics

sql - The sql to generate the dataset

extendedDataTypes - Whether the returned dataset will include CLOB fields

queryTimeout - Specify time out in seconds to override system default query timeout. Set to zero to disable timeout

keepAlive - Set to true to keep connection alive

Returns:

dataset The resulting dataset

getPreparedSqlDataSet

public DataSet getPreparedSqlDataSet(java.lang.String sql,
                                     java.lang.Object[] params)

Returns a sapphire.util.DataSet that reflects the resultset for the given sql

Parameters:

sql - The sql to generate the dataset

params - bind variables for each parameter in the query

Returns:

dataset The resulting dataset

getPreparedSqlDataSet

public DataSet getPreparedSqlDataSet(int sqlCode,
                                     java.lang.Object[] params)

Returns a sapphire.util.DataSet that reflects the resultset for the given sql

Parameters:

sqlCode - Reference to the sql to generate the dataset

params - bind variables for each parameter in the query

Returns:

dataset The resulting dataset

getPreparedSqlDataSet

public DataSet getPreparedSqlDataSet(java.lang.String name,
                                     java.lang.String sql,
                                     java.lang.Object[] params)

Returns a sapphire.util.DataSet that reflects the resultset for the given sql

Parameters:

name - A name for the query that will be used to record the statistics

sql - The sql to generate the dataset

params - bind variables for each parameter in the query

Returns:

dataset The resulting dataset

getPreparedSqlDataSet

public DataSet getPreparedSqlDataSet(java.lang.String sql,
                                     java.lang.Object[] params,
                                     boolean extendedDataTypes)

Returns a sapphire.util.DataSet that reflects the resultset for the given sql

Parameters:

sql - The sql to generate the dataset

params - bind variables for each parameter in the query

extendedDataTypes - determines in LOB columns are included

Returns:

dataset The resulting dataset

getPreparedSqlDataSet

public DataSet getPreparedSqlDataSet(int sqlCode,
                                     java.lang.Object[] params,
                                     boolean extendedDataTypes)

Returns a sapphire.util.DataSet that reflects the resultset for the given sql

Parameters:

sqlCode - Reference to the sql to generate the dataset

params - bind variables for each parameter in the query

extendedDataTypes - determines in LOB columns are included

Returns:

dataset The resulting dataset

getPreparedSqlDataSet

public DataSet getPreparedSqlDataSet(java.lang.String name,
                                     java.lang.String sql,
                                     java.lang.Object[] params,
                                     boolean extendedDataTypes)

Returns a sapphire.util.DataSet that reflects the resultset for the given sql

Parameters:

name - A name for the query that will be used to record the statistics

sql - The sql to generate the dataset

params - bind variables for each parameter in the query

extendedDataTypes - true if support for clobs and blobs is required

Returns:

dataset The resulting dataset

getPreparedSqlDataSet

public DataSet getPreparedSqlDataSet(java.lang.String name,
                                     java.lang.String sql,
                                     java.lang.Object[] params,
                                     boolean extendedDataTypes,
                                     int queryTimeout)

Returns a sapphire.util.DataSet that reflects the resultset for the given sql

Parameters:

name - A name for the query that will be used to record the statistics

sql - The sql to generate the dataset

params - bind variables for each parameter in the query

extendedDataTypes - true if support for clobs and blobs is required

queryTimeout - Specify time out in seconds to override system default query timeout. Set to zero to disable timeout

Returns:

dataset The resulting dataset

getPreparedCount

public int getPreparedCount(java.lang.String sql,
                            java.lang.Object[] params)
                     throws SapphireException

Executes the sql with bind variables the should return a single row with a single number value. Typically for use with SELECT count(*) FROM ... type statements.

Parameters:

sql - Sql of the form getCount() with bind variables

params - array that holds bind values

Returns:

int The numberic result from the first row, first column of the sql.

Throws:

SapphireException

getCount

public int getCount(java.lang.String sql)
             throws SapphireException

Executes the sql the should return a single row with a single number value. Typically for use with SELECT count(*) FROM ... type statements.

Parameters:

sql - Sql of the form getCount()

Returns:

int The numberic result from the first row, first column of the sql.

Throws:

SapphireException

getRefTypeDataSet

public DataSet getRefTypeDataSet(java.lang.String reftypeid)

Returns a dataset that contains the details of the reference values for the supplied ReferenceType.

Parameters:

reftypeid - A valid Sapphire ReferenceType

Returns:

dataset DataSet that contains details of the reference values.

getKeyid1List

public java.lang.String getKeyid1List(java.lang.String sdcid,
                                      java.lang.String queryid,
                                      java.lang.String param1,
                                      java.lang.String param2,
                                      java.lang.String param3,
                                      java.lang.String param4,
                                      java.lang.String param5)

Executes the supplied Sapphire query and returns the list of sdi(s). Note that this method is only applicable for single-keyed SDIs. Refer to the SDIProcessor for details on other ways to retrieve details of SDIs. Used when the query takes up to five parameters

Parameters:

sdcid - A valid Sapphire SDC

queryid - A valid Sapphire Query

param1 - Query parameter (Optional)

param2 - Query parameter (Optional)

param3 - Query parameter (Optional)

param4 - Query parameter (Optional)

param5 - Query parameter (Optional)

Returns:

sdilist Semi-colon separated list of keyids

getKeyid1List

public java.lang.String getKeyid1List(java.lang.String sdcid,
                                      java.lang.String queryid)

Executes the supplied Sapphire query and returns the list of sdi(s). Note that this method is only applicable for single-keyed SDIs. Refer to the SDIProcessor for details on other ways to retrieve details of SDIs. Used when the query takes no parameters

Parameters:

sdcid - A valid Sapphire SDC

queryid - A valid Sapphire Query

Returns:

sdilist Semi-colon separated list of keyids

getKeyid1List

public java.lang.String getKeyid1List(java.lang.String sdcid,
                                      java.lang.String queryid,
                                      java.lang.String[] params)

Executes the supplied Sapphire query and returns the list of sdi(s). Note that this method is only applicable for single-keyed SDIs. Refer to the SDIProcessor for details on other ways to retrieve details of SDIs. Used when the query takes an any numbers of parameters

Parameters:

sdcid - A valid Sapphire SDC

queryid - A valid Sapphire Query

params - String array of query parameters

Returns:

sdilist Semi-colon separated list of keyids

execSQL

public int execSQL(java.lang.String sql)

Utility method for passing SQL to be executed against the database by the application server.

Parameters:

sql - The sql to execute

Returns:

SUCCESS / FAILURE

execPreparedUpdate

public int execPreparedUpdate(java.lang.String sql,
                              java.lang.Object[] bindvars)

Utility method for passing a prepared SQL along with bind variables to be executed against the database by the application server.

Parameters:

sql - The prepared sql to execute

bindvars - The sql bind variable object array

Returns:

SUCCESS / FAILURE

execSQL

public int execSQL(int sqlCode)

execSQL

public int execSQL(int sqlCode,
                   java.lang.Object[] bindVars)

getSecurityFilterWhere

public java.lang.String getSecurityFilterWhere(java.lang.String sdcid)