org.wso2.carbon.dataservices.core.description.query

Class SQLQuery

java.lang.Object

org.wso2.carbon.dataservices.core.engine.XMLWriterHelper

org.wso2.carbon.dataservices.core.description.query.Query

org.wso2.carbon.dataservices.core.description.query.ExpressionQuery

org.wso2.carbon.dataservices.core.description.query.SQLQuery

All Implemented Interfaces:

BatchRequestParticipant

public class SQLQuery
extends ExpressionQuery
implements BatchRequestParticipant

This class represents an SQL query in a data service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SQLQuery.FetchSizeProperty Internal class to hold fetch size and whether to set fetch size for connection.
class	SQLQuery.StoredProcMetadataEntry This class represents a information on a single stored procedure parameter/result element.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DS_QUERY_TYPE_NORMAL
static int	DS_QUERY_TYPE_STORED_PROC
static int	ORACLE_REF_CURSOR_TYPE

Constructor Summary

Constructors

Constructor and Description
SQLQuery(DataService dataService, String queryId, String configId, boolean returnGeneratedKeys, boolean returnUpdatedRowCount, String[] keyColumns, String query, List<QueryParam> queryParams, Result result, EventTrigger inputEventTrigger, EventTrigger outputEventTrigger, Map<String,String> advancedProperties, String inputNamespace)

Method Summary

Methods

Modifier and Type	Method and Description
org.wso2.carbon.dataservices.common.DBConstants.AutoCommit	getAutoCommit()
SQLConfig	getConfig()
static int	getCurrentRefCursorOrdinal()
int	getFetchDirection()
int	getFetchSize()
SQLQuery.FetchSizeProperty	getFetchSizeProperty()
String[]	getKeyColumns()
int	getMaxFieldSize()
int	getMaxRows()
List<QueryParam>	getOutQueryParams()
int	getQueryTimeout()
int	getQueryType()
boolean	hasBatchQuerySupport()
boolean	hasOutParams()
boolean	hasRefCursor()
void	init(String query) Pre-processing of the query
boolean	isForceJDBCBatchReqs()
boolean	isForceStoredProc()
boolean	isHasFetchDirection()
boolean	isHasFetchSize()
boolean	isHasMaxFieldSize()
boolean	isHasMaxRows()
boolean	isHasQueryTimeout()
boolean	isResultOnlyOutParams()
boolean	isReturnGeneratedKeys()
boolean	isReturnUpdatedRowCount()
String[]	lookupConnectionCredentials()
void	releaseBatchRequestResources() release resources after the batch request is done
void	runPostQuery(Object result, XMLStreamWriter xmlWriter, InternalParamCollection params, int queryLevel) This method must be implemented by concrete implementations of this class, to provide the logic to execute the query.
Object	runPreQuery(InternalParamCollection params, int queryLevel) This method must be implemented by concrete implementations of this class, to provide the logic to execute the query.
static void	setCurrentRefCursorOrdinal(int ordinal)

Methods inherited from class org.wso2.carbon.dataservices.core.description.query.ExpressionQuery

createProcessedQuery, getParamCount, getQuery, isDynamicQuery, processDynamicQuery

Methods inherited from class org.wso2.carbon.dataservices.core.description.query.Query

addQueryPreprocessedObject, execute, getAdvancedProperties, getAndRemoveQueryPreprocessObject, getConfigId, getDataService, getInputEventTrigger, getInputNamespace, getOutputEventTrigger, getQueryId, getQueryParams, getResult, hasResult, isPreBuildResult, isQueryPreprocessInitial, isQueryPreprocessSecondary, isUsingColumnNumbers, isWriteRow, resetQueryPreprocessing, setQueryPreprocessingInitial, setQueryPreprocessingSecondary, writeResultEntry

Methods inherited from class org.wso2.carbon.dataservices.core.engine.XMLWriterHelper

addAttribute, endElement, getNamespace, setNamespace, startRowElement, startWrapperElement, writeResultElement

Methods inherited from class java.lang.Object

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

Field Detail

DS_QUERY_TYPE_NORMAL

public static final int DS_QUERY_TYPE_NORMAL

See Also:

Constant Field Values

DS_QUERY_TYPE_STORED_PROC

public static final int DS_QUERY_TYPE_STORED_PROC

See Also:

Constant Field Values

ORACLE_REF_CURSOR_TYPE

public static final int ORACLE_REF_CURSOR_TYPE

See Also:

Constant Field Values

Constructor Detail

SQLQuery

public SQLQuery(DataService dataService,
        String queryId,
        String configId,
        boolean returnGeneratedKeys,
        boolean returnUpdatedRowCount,
        String[] keyColumns,
        String query,
        List<QueryParam> queryParams,
        Result result,
        EventTrigger inputEventTrigger,
        EventTrigger outputEventTrigger,
        Map<String,String> advancedProperties,
        String inputNamespace)
         throws DataServiceFault

Throws:

DataServiceFault

Method Detail

getCurrentRefCursorOrdinal

public static int getCurrentRefCursorOrdinal()

setCurrentRefCursorOrdinal

public static void setCurrentRefCursorOrdinal(int ordinal)

init

public void init(String query)
          throws DataServiceFault

Description copied from class: ExpressionQuery

Pre-processing of the query

Overrides:

init in class ExpressionQuery

Parameters:

query - Query

Throws:

DataServiceFault

getAutoCommit

public org.wso2.carbon.dataservices.common.DBConstants.AutoCommit getAutoCommit()

hasBatchQuerySupport

public boolean hasBatchQuerySupport()

getKeyColumns

public String[] getKeyColumns()

isReturnGeneratedKeys

public boolean isReturnGeneratedKeys()

isReturnUpdatedRowCount

public boolean isReturnUpdatedRowCount()

isForceStoredProc

public boolean isForceStoredProc()

isForceJDBCBatchReqs

public boolean isForceJDBCBatchReqs()

isHasFetchDirection

public boolean isHasFetchDirection()

isHasFetchSize

public boolean isHasFetchSize()

isHasMaxFieldSize

public boolean isHasMaxFieldSize()

isHasMaxRows

public boolean isHasMaxRows()

isHasQueryTimeout

public boolean isHasQueryTimeout()

getFetchDirection

public int getFetchDirection()

getFetchSize

public int getFetchSize()

getMaxFieldSize

public int getMaxFieldSize()

getMaxRows

public int getMaxRows()

getQueryTimeout

public int getQueryTimeout()

getFetchSizeProperty

public SQLQuery.FetchSizeProperty getFetchSizeProperty()

hasOutParams

public boolean hasOutParams()

isResultOnlyOutParams

public boolean isResultOnlyOutParams()

getOutQueryParams

public List<QueryParam> getOutQueryParams()

getQueryType

public int getQueryType()

getConfig

public SQLConfig getConfig()

lookupConnectionCredentials

public String[] lookupConnectionCredentials()
                                     throws DataServiceFault

Throws:

DataServiceFault

hasRefCursor

public boolean hasRefCursor()

runPreQuery

public Object runPreQuery(InternalParamCollection params,
                 int queryLevel)
                   throws DataServiceFault

Description copied from class: Query

This method must be implemented by concrete implementations of this class, to provide the logic to execute the query.

Specified by:

runPreQuery in class Query

Throws:

DataServiceFault

runPostQuery

public void runPostQuery(Object result,
                XMLStreamWriter xmlWriter,
                InternalParamCollection params,
                int queryLevel)
                  throws DataServiceFault

Description copied from class: Query

This method must be implemented by concrete implementations of this class, to provide the logic to execute the query.

Specified by:

runPostQuery in class Query

Throws:

DataServiceFault

releaseBatchRequestResources

public void releaseBatchRequestResources()

Description copied from interface: BatchRequestParticipant

release resources after the batch request is done

Specified by:

releaseBatchRequestResources in interface BatchRequestParticipant