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

Class ExcelQuery

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

public class ExcelQuery
extends Query

This class represents a Excel data services query.

Constructor Summary

Constructors

Constructor and Description
ExcelQuery(DataService dataService, String queryId, List<QueryParam> queryParams, String configId, String workbookName, 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
Map<Integer,String>	getColumnMappings()
ExcelConfig	getConfig()
int	getHeaderRow()
int	getMaxRowCount()
int	getStartingRow()
String	getWorkbookName()
boolean	isHasHeader()
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

ExcelQuery

public ExcelQuery(DataService dataService,
                  String queryId,
                  List<QueryParam> queryParams,
                  String configId,
                  String workbookName,
                  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

getColumnMappings

public Map<Integer,String> getColumnMappings()

getConfig

public ExcelConfig getConfig()

isHasHeader

public boolean isHasHeader()

getMaxRowCount

public int getMaxRowCount()

getStartingRow

public int getStartingRow()

getHeaderRow

public int getHeaderRow()

getWorkbookName

public String getWorkbookName()

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