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

Class WebQuery

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

public class WebQuery
extends Query

This class represents a Web query in a data service.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
WebConfig	getConfig()
String	getScraperVariable()
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.

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

addQueryPreprocessedObject, execute, getAdvancedProperties, getAndRemoveQueryPreprocessObject, getConfigId, getCurrentInternalParams, getDataService, getInputEventTrigger, getInputNamespace, getOutputEventTrigger, getQueryId, getQueryParams, getResult, hasResult, isPreBuildResult, isQueryPreprocessInitial, isQueryPreprocessSecondary, isUsingColumnNumbers, isWriteRow, resetCurrentInternalParams, resetQueryPreprocessing, setCurrentInternalParams, 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

Constructor Detail

WebQuery

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

Throws:

DataServiceFault

Method Detail

getConfig

public WebConfig getConfig()

getScraperVariable

public String getScraperVariable()

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