it.eng.spagobi.engines.worksheet.services
Class AbstractWorksheetEngineAction

java.lang.Object
  extended by it.eng.spago.dispatching.service.DefaultRequestContext
      extended by it.eng.spago.dispatching.service.DefaultHttpRequestContext
          extended by it.eng.spago.dispatching.action.AbstractHttpAction
              extended by it.eng.spagobi.utilities.service.AbstractBaseHttpAction
                  extended by it.eng.spagobi.utilities.engines.AbstractEngineAction
                      extended by it.eng.spagobi.engines.worksheet.services.AbstractWorksheetEngineAction
All Implemented Interfaces:
it.eng.spago.dispatching.action.ActionIFace, it.eng.spago.dispatching.service.HttpRequestContextIFace, it.eng.spago.dispatching.service.RequestContextIFace, it.eng.spago.dispatching.service.ServiceIFace, it.eng.spago.init.InitializerIFace, java.io.Serializable
Direct Known Subclasses:
ExecuteWorksheetQueryAction, GetFilterValuesAction, GetImageContentAction, GetValuesForCrosstabAttributesAction, GetWorksheetFieldsAction, GetWorkSheetPreviewAction, LoadCrosstabAction, SetWorkSheetDefinitionAction, UpdateDataSetWithSmartFilterValues, UploadWorksheetImageAction

public abstract class AbstractWorksheetEngineAction
extends it.eng.spagobi.utilities.engines.AbstractEngineAction

Author:
Davide Zerbetto (davide.zerbetto@eng.it)
See Also:
Serialized Form

Field Summary
static org.apache.log4j.Logger auditlogger
           
 
Fields inherited from class it.eng.spagobi.utilities.engines.AbstractEngineAction
PRIVATE_SCOPE, PUBLIC_SCOPE
 
Constructor Summary
AbstractWorksheetEngineAction()
           
 
Method Summary
protected  void adjustMetadata(it.eng.spagobi.tools.dataset.common.datastore.DataStore dataStore, it.eng.spagobi.tools.dataset.bo.IDataSet dataset, it.eng.spagobi.tools.dataset.persist.IDataSetTableDescriptor descriptor)
           
protected  void adjustMetadata(it.eng.spagobi.tools.dataset.common.datastore.DataStore dataStore, it.eng.spagobi.tools.dataset.bo.IDataSet dataset, it.eng.spagobi.tools.dataset.persist.IDataSetTableDescriptor descriptor, org.json.JSONArray fieldOptions)
           
 void applyOptions(it.eng.spagobi.tools.dataset.common.datastore.IDataStore dataStore)
           
protected  java.lang.String buildSqlStatement(java.lang.String fieldName, it.eng.spagobi.tools.dataset.persist.IDataSetTableDescriptor descriptor, java.util.List<it.eng.qbe.query.WhereField> filters, java.lang.String ordeType)
           
 it.eng.spagobi.tools.dataset.common.datastore.IDataStore executeWorksheetQuery(java.lang.String worksheetQuery, java.lang.Integer start, java.lang.Integer limit)
           
 java.util.List<java.lang.String> getAllFields()
           
 java.sql.Connection getConnection()
           
 it.eng.spagobi.tools.datasource.bo.IDataSource getDataSource()
           
 WorksheetEngineInstance getEngineInstance()
           
 java.util.Map<java.lang.String,java.util.List<java.lang.String>> getFiltersOnDomainValues()
           
 java.util.Map<java.lang.String,java.util.List<java.lang.String>> getGlobalFiltersOnDomainValues()
           
 java.util.List<it.eng.qbe.query.WhereField> getOptionalFilters(org.json.JSONObject optionalUserFilters)
           
 java.util.Map<java.lang.String,java.util.List<java.lang.String>> getSheetFiltersOnDomainValues(java.lang.String sheetName)
           
 it.eng.spagobi.tools.dataset.common.datastore.IDataStore getUserSheetFilterValues(java.lang.String sheetName, java.lang.String fieldName)
           
 it.eng.spagobi.tools.dataset.persist.IDataSetTableDescriptor persistDataSet()
           
 void setDataSource(it.eng.spagobi.tools.datasource.bo.IDataSource dataSource)
           
 void setEngineInstance(WorksheetEngineInstance engineInstance)
           
static java.util.List<it.eng.qbe.query.WhereField> transformIntoWhereClauses(org.json.JSONObject optionalUserFilters)
           
static java.util.List<it.eng.qbe.query.WhereField> transformIntoWhereClauses(java.util.Map<java.lang.String,java.util.List<java.lang.String>> filters)
           
 void updateWorksheetDefinition(org.json.JSONObject worksheetDefinitionJSON)
          Sets the worksheet definition into the worksheet engine instance
 
Methods inherited from class it.eng.spagobi.utilities.engines.AbstractEngineAction
getAuditServiceProxy, getConetxtManager, getEnv, getLocale, getSpagoBIHttpSessionContainer, getSpagoBISessionContainer, init, saveAnalysisState, service, setLocale
 
Methods inherited from class it.eng.spagobi.utilities.service.AbstractBaseHttpAction
delAttributeFromHttpSession, delAttributeFromSession, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsCsvStringList, getAttributeAsInteger, getAttributeAsJSONArray, getAttributeAsJSONObject, getAttributeAsList, getAttributeAsString, getAttributeFromHttpSession, getAttributeFromHttpSessionAsBoolean, getAttributeFromHttpSessionAsBoolean, getAttributeFromHttpSessionAsString, getAttributeFromSession, getAttributeFromSessionAsBoolean, getAttributeFromSessionAsBoolean, getAttributeFromSessionAsString, getAttributesAsLinkedMap, getAttributesAsMap, getHttpSession, getSessionContainer, getSpagoBIRequestContainer, getSpagoBIResponseContainer, httpSessionContainsAttribute, requestContainsAttribute, requestContainsAttribute, sessionContainsAttribute, setAttribute, setAttributeInHttpSession, setAttributeInSession, setSpagoBIRequestContainer, setSpagoBIResponseContainer, tryToWriteBackToClient, writeBackToClient, writeBackToClient, writeBackToClient, writeBackToClient, writeBackToClient
 
Methods inherited from class it.eng.spago.dispatching.action.AbstractHttpAction
getActionMethod, getActionName, getConfig, setActionMethod, setActionName
 
Methods inherited from class it.eng.spago.dispatching.service.DefaultHttpRequestContext
freezeHttpResponse, getHttpRequest, getHttpResponse, getServletConfig, isHttpResponseFreezed, setRequestContext, unfreezeHttpResponse
 
Methods inherited from class it.eng.spago.dispatching.service.DefaultRequestContext
getErrorHandler, getRequestContainer, getResponseContainer, getServiceRequest, getServiceResponse
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface it.eng.spago.dispatching.service.RequestContextIFace
getErrorHandler, getRequestContainer, getResponseContainer, getServiceRequest, getServiceResponse
 

Field Detail

auditlogger

public static transient org.apache.log4j.Logger auditlogger
Constructor Detail

AbstractWorksheetEngineAction

public AbstractWorksheetEngineAction()
Method Detail

executeWorksheetQuery

public it.eng.spagobi.tools.dataset.common.datastore.IDataStore executeWorksheetQuery(java.lang.String worksheetQuery,
                                                                                      java.lang.Integer start,
                                                                                      java.lang.Integer limit)

getEngineInstance

public WorksheetEngineInstance getEngineInstance()
Overrides:
getEngineInstance in class it.eng.spagobi.utilities.engines.AbstractEngineAction

setEngineInstance

public void setEngineInstance(WorksheetEngineInstance engineInstance)

getDataSource

public it.eng.spagobi.tools.datasource.bo.IDataSource getDataSource()

setDataSource

public void setDataSource(it.eng.spagobi.tools.datasource.bo.IDataSource dataSource)

persistDataSet

public it.eng.spagobi.tools.dataset.persist.IDataSetTableDescriptor persistDataSet()

getConnection

public java.sql.Connection getConnection()

getFiltersOnDomainValues

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getFiltersOnDomainValues()

getSheetFiltersOnDomainValues

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getSheetFiltersOnDomainValues(java.lang.String sheetName)

getGlobalFiltersOnDomainValues

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getGlobalFiltersOnDomainValues()

getAllFields

public java.util.List<java.lang.String> getAllFields()

transformIntoWhereClauses

public static java.util.List<it.eng.qbe.query.WhereField> transformIntoWhereClauses(java.util.Map<java.lang.String,java.util.List<java.lang.String>> filters)
                                                                             throws org.json.JSONException
Throws:
org.json.JSONException

getOptionalFilters

public java.util.List<it.eng.qbe.query.WhereField> getOptionalFilters(org.json.JSONObject optionalUserFilters)
                                                               throws org.json.JSONException
Throws:
org.json.JSONException

transformIntoWhereClauses

public static java.util.List<it.eng.qbe.query.WhereField> transformIntoWhereClauses(org.json.JSONObject optionalUserFilters)
                                                                             throws org.json.JSONException
Throws:
org.json.JSONException

updateWorksheetDefinition

public void updateWorksheetDefinition(org.json.JSONObject worksheetDefinitionJSON)
                               throws java.lang.Exception
Sets the worksheet definition into the worksheet engine instance

Parameters:
worksheetDefinitionJSON - The worksheet definition in JSON format
Throws:
java.lang.Exception

adjustMetadata

protected void adjustMetadata(it.eng.spagobi.tools.dataset.common.datastore.DataStore dataStore,
                              it.eng.spagobi.tools.dataset.bo.IDataSet dataset,
                              it.eng.spagobi.tools.dataset.persist.IDataSetTableDescriptor descriptor)

adjustMetadata

protected void adjustMetadata(it.eng.spagobi.tools.dataset.common.datastore.DataStore dataStore,
                              it.eng.spagobi.tools.dataset.bo.IDataSet dataset,
                              it.eng.spagobi.tools.dataset.persist.IDataSetTableDescriptor descriptor,
                              org.json.JSONArray fieldOptions)

getUserSheetFilterValues

public it.eng.spagobi.tools.dataset.common.datastore.IDataStore getUserSheetFilterValues(java.lang.String sheetName,
                                                                                         java.lang.String fieldName)
                                                                                  throws org.json.JSONException
Throws:
org.json.JSONException

applyOptions

public void applyOptions(it.eng.spagobi.tools.dataset.common.datastore.IDataStore dataStore)

buildSqlStatement

protected java.lang.String buildSqlStatement(java.lang.String fieldName,
                                             it.eng.spagobi.tools.dataset.persist.IDataSetTableDescriptor descriptor,
                                             java.util.List<it.eng.qbe.query.WhereField> filters,
                                             java.lang.String ordeType)