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

Class Query

java.lang.Object

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

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

Direct Known Subclasses:

CSVQuery, CustomQueryBasedDSQuery, ExcelQuery, ExpressionQuery, GSpreadQuery, MongoQuery, SPARQLQuery, SparqlQueryBase, WebQuery

public abstract class Query
extends XMLWriterHelper

Represents a query in a data service.

Constructor Summary

Constructors

Constructor and Description
Query(DataService dataService, String queryId, List<QueryParam> queryParams, Result result, String configId, EventTrigger inputEventTrigger, EventTrigger outputEventTrigger, Map<String,String> advancedProperties, String inputNamespace)

Method Summary

Methods

Modifier and Type	Method and Description
static void	addQueryPreprocessedObject(Object value)
void	execute(XMLStreamWriter xmlWriter, Map<String,ParamValue> params, int queryLevel)
Map<String,String>	getAdvancedProperties()
static Object	getAndRemoveQueryPreprocessObject()
String	getConfigId()
DataService	getDataService()
EventTrigger	getInputEventTrigger()
String	getInputNamespace()
EventTrigger	getOutputEventTrigger()
String	getQueryId()
List<QueryParam>	getQueryParams()
Result	getResult()
boolean	hasResult()
boolean	isPreBuildResult()
static boolean	isQueryPreprocessInitial()
static boolean	isQueryPreprocessSecondary()
boolean	isUsingColumnNumbers()
boolean	isWriteRow()
static void	resetQueryPreprocessing()
abstract 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.
abstract 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	setQueryPreprocessingInitial(boolean state)
static void	setQueryPreprocessingSecondary(boolean state)
void	writeResultEntry(XMLStreamWriter xmlWriter, DataEntry dataEntry, InternalParamCollection ipc, int queryLevel) writes an result entry to the output.

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

Constructor Detail

Query

public Query(DataService dataService,
     String queryId,
     List<QueryParam> queryParams,
     Result result,
     String configId,
     EventTrigger inputEventTrigger,
     EventTrigger outputEventTrigger,
     Map<String,String> advancedProperties,
     String inputNamespace)

Method Detail

getInputNamespace

public String getInputNamespace()

isPreBuildResult

public boolean isPreBuildResult()

getInputEventTrigger

public EventTrigger getInputEventTrigger()

getOutputEventTrigger

public EventTrigger getOutputEventTrigger()

getAdvancedProperties

public Map<String,String> getAdvancedProperties()

getConfigId

public String getConfigId()

getDataService

public DataService getDataService()

getQueryId

public String getQueryId()

getQueryParams

public List<QueryParam> getQueryParams()

getResult

public Result getResult()

hasResult

public boolean hasResult()

isWriteRow

public boolean isWriteRow()

isUsingColumnNumbers

public boolean isUsingColumnNumbers()

execute

public void execute(XMLStreamWriter xmlWriter,
           Map<String,ParamValue> params,
           int queryLevel)
             throws DataServiceFault

Throws:

DataServiceFault

runPreQuery

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

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

Throws:

DataServiceFault

runPostQuery

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

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

Throws:

DataServiceFault

writeResultEntry

public void writeResultEntry(XMLStreamWriter xmlWriter,
                    DataEntry dataEntry,
                    InternalParamCollection ipc,
                    int queryLevel)
                      throws DataServiceFault

writes an result entry to the output.

Throws:

DataServiceFault

setQueryPreprocessingInitial

public static void setQueryPreprocessingInitial(boolean state)

setQueryPreprocessingSecondary

public static void setQueryPreprocessingSecondary(boolean state)

isQueryPreprocessInitial

public static boolean isQueryPreprocessInitial()

isQueryPreprocessSecondary

public static boolean isQueryPreprocessSecondary()

getAndRemoveQueryPreprocessObject

public static Object getAndRemoveQueryPreprocessObject()

addQueryPreprocessedObject

public static void addQueryPreprocessedObject(Object value)

resetQueryPreprocessing

public static void resetQueryPreprocessing()