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

Class GSpreadQuery

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

public class GSpreadQuery
extends Query

This class represents a GSpread data services query.

Constructor Summary

Constructors

Constructor and Description
GSpreadQuery(DataService dataService, String queryId, List<QueryParam> queryParams, String configId, int worksheetNumber, boolean hasHeader, int startingRow, int headerRow, int maxRowCount, Result result, EventTrigger inputEventTrigger, EventTrigger outputEventTrigger, Map<String,String> advancedProperties, String inputNamespace)

Method Summary

Modifier and Type	Method and Description
GSpreadConfig	getConfig()
int	getHeaderRow()
int	getMaxRowCount()
int	getStartingRow()
int	getWorksheetNumber()
boolean	isHasHeader()
org.wso2.carbon.dataservices.core.description.query.GSpreadQuery.GSpreadResultSet	retrieveData()
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

GSpreadQuery

public GSpreadQuery(DataService dataService,
                    String queryId,
                    List<QueryParam> queryParams,
                    String configId,
                    int worksheetNumber,
                    boolean hasHeader,
                    int startingRow,
                    int headerRow,
                    int maxRowCount,
                    Result result,
                    EventTrigger inputEventTrigger,
                    EventTrigger outputEventTrigger,
                    Map<String,String> advancedProperties,
                    String inputNamespace)
             throws DataServiceFault

Throws:

DataServiceFault

Method Detail

isHasHeader

public boolean isHasHeader()

getHeaderRow

public int getHeaderRow()

getConfig

public GSpreadConfig getConfig()

getMaxRowCount

public int getMaxRowCount()

getStartingRow

public int getStartingRow()

getWorksheetNumber

public int getWorksheetNumber()

retrieveData

public org.wso2.carbon.dataservices.core.description.query.GSpreadQuery.GSpreadResultSet retrieveData()
                                                                                               throws Exception

Throws:

Exception

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