it.eng.spagobi.engines.drivers.worksheet
Class WorksheetDriver

java.lang.Object
  extended by it.eng.spagobi.engines.drivers.AbstractDriver
      extended by it.eng.spagobi.engines.drivers.worksheet.WorksheetDriver
All Implemented Interfaces:
IEngineDriver

public class WorksheetDriver
extends AbstractDriver
implements IEngineDriver

Driver Implementation (IEngineDriver Interface) for Worksheet External Engine.


Field Summary
static java.lang.String ATTRIBUTE_VERSION
           
static java.lang.String CURRENT_VERSION
           
static java.lang.String FORM_VALUES
           
static java.lang.String MASSIVE_EXPORT_PARAM_ACTION_NAME
           
static java.lang.String METADATA_AND_METACONTENT
           
static java.lang.String PARAM_ACTION_NAME
           
static java.lang.String PARAM_NEW_SESSION
           
static java.lang.String PARAM_SERVICE_NAME
           
static java.lang.String PARAMETERS
           
static java.lang.String QUERY
           
static java.lang.String TAG_QBE
           
static java.lang.String TAG_WORKSHEET
           
static java.lang.String TAG_WORKSHEET_DEFINITION
           
 
Constructor Summary
WorksheetDriver()
           
 
Method Summary
 java.lang.String composeWorksheetTemplate(java.lang.String workSheetDef, java.lang.String workSheetQuery, java.lang.String smartFilterValues, java.lang.String originalQbeTempl)
           
 java.lang.String createNewWorksheetTemplate(java.lang.String worksheetDefinition)
           
 EngineURL getEditDocumentTemplateBuildUrl(java.lang.Object biobject, it.eng.spago.security.IEngUserProfile profile)
          Function not implemented.
 EngineURL getNewDocumentTemplateBuildUrl(java.lang.Object biobject, it.eng.spago.security.IEngUserProfile profile)
          Function not implemented.
 java.util.Map getParameterMap(java.lang.Object analyticalDocument, it.eng.spago.security.IEngUserProfile profile, java.lang.String roleName)
          Returns a map of parameters which will be send in the request to the engine application.
 java.util.Map getParameterMap(java.lang.Object analyticalDocument, java.lang.Object analyticalDocumentSubObject, it.eng.spago.security.IEngUserProfile profile, java.lang.String roleName)
          Returns a map of parameters which will be send in the request to the engine application.
 java.lang.String updateWorksheetTemplate(java.lang.String workSheetDef, java.lang.String workSheetQuery, java.lang.String smartFilterValues, java.lang.String originalWorksheetTempl)
           
 
Methods inherited from class it.eng.spagobi.engines.drivers.AbstractDriver
addBIParameterDescriptions, applySecurity
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PARAM_SERVICE_NAME

public static final java.lang.String PARAM_SERVICE_NAME
See Also:
Constant Field Values

PARAM_NEW_SESSION

public static final java.lang.String PARAM_NEW_SESSION
See Also:
Constant Field Values

QUERY

public static final java.lang.String QUERY
See Also:
Constant Field Values

MASSIVE_EXPORT_PARAM_ACTION_NAME

public static final java.lang.String MASSIVE_EXPORT_PARAM_ACTION_NAME
See Also:
Constant Field Values

PARAM_ACTION_NAME

public static final java.lang.String PARAM_ACTION_NAME
See Also:
Constant Field Values

METADATA_AND_METACONTENT

public static final java.lang.String METADATA_AND_METACONTENT
See Also:
Constant Field Values

PARAMETERS

public static final java.lang.String PARAMETERS
See Also:
Constant Field Values

FORM_VALUES

public static final java.lang.String FORM_VALUES
See Also:
Constant Field Values

CURRENT_VERSION

public static final java.lang.String CURRENT_VERSION
See Also:
Constant Field Values

ATTRIBUTE_VERSION

public static final java.lang.String ATTRIBUTE_VERSION
See Also:
Constant Field Values

TAG_WORKSHEET_DEFINITION

public static final java.lang.String TAG_WORKSHEET_DEFINITION
See Also:
Constant Field Values

TAG_WORKSHEET

public static final java.lang.String TAG_WORKSHEET
See Also:
Constant Field Values

TAG_QBE

public static final java.lang.String TAG_QBE
See Also:
Constant Field Values
Constructor Detail

WorksheetDriver

public WorksheetDriver()
Method Detail

getParameterMap

public java.util.Map getParameterMap(java.lang.Object analyticalDocument,
                                     it.eng.spago.security.IEngUserProfile profile,
                                     java.lang.String roleName)
Returns a map of parameters which will be send in the request to the engine application.

Specified by:
getParameterMap in interface IEngineDriver
Parameters:
profile - Profile of the user
roleName - the name of the execution role
analyticalDocument - the biobject
Returns:
Map The map of the execution call parameters

getParameterMap

public java.util.Map getParameterMap(java.lang.Object analyticalDocument,
                                     java.lang.Object analyticalDocumentSubObject,
                                     it.eng.spago.security.IEngUserProfile profile,
                                     java.lang.String roleName)
Returns a map of parameters which will be send in the request to the engine application.

Specified by:
getParameterMap in interface IEngineDriver
Parameters:
analyticalDocumentSubObject - SubObject to execute
profile - Profile of the user
roleName - the name of the execution role
analyticalDocument - the object
Returns:
Map The map of the execution call parameters

getEditDocumentTemplateBuildUrl

public EngineURL getEditDocumentTemplateBuildUrl(java.lang.Object biobject,
                                                 it.eng.spago.security.IEngUserProfile profile)
                                          throws InvalidOperationRequest
Function not implemented. Thid method should not be called

Specified by:
getEditDocumentTemplateBuildUrl in interface IEngineDriver
Parameters:
biobject - The BIOBject to edit
profile - the profile
Returns:
the edits the document template build url
Throws:
InvalidOperationRequest - the invalid operation request

getNewDocumentTemplateBuildUrl

public EngineURL getNewDocumentTemplateBuildUrl(java.lang.Object biobject,
                                                it.eng.spago.security.IEngUserProfile profile)
                                         throws InvalidOperationRequest
Function not implemented. Thid method should not be called

Specified by:
getNewDocumentTemplateBuildUrl in interface IEngineDriver
Parameters:
biobject - The BIOBject to edit
profile - the profile
Returns:
the new document template build url
Throws:
InvalidOperationRequest - the invalid operation request

updateWorksheetTemplate

public java.lang.String updateWorksheetTemplate(java.lang.String workSheetDef,
                                                java.lang.String workSheetQuery,
                                                java.lang.String smartFilterValues,
                                                java.lang.String originalWorksheetTempl)
                                         throws it.eng.spago.base.SourceBeanException
Throws:
it.eng.spago.base.SourceBeanException

composeWorksheetTemplate

public java.lang.String composeWorksheetTemplate(java.lang.String workSheetDef,
                                                 java.lang.String workSheetQuery,
                                                 java.lang.String smartFilterValues,
                                                 java.lang.String originalQbeTempl)
                                          throws it.eng.spago.base.SourceBeanException
Throws:
it.eng.spago.base.SourceBeanException

createNewWorksheetTemplate

public java.lang.String createNewWorksheetTemplate(java.lang.String worksheetDefinition)
                                            throws it.eng.spago.base.SourceBeanException
Throws:
it.eng.spago.base.SourceBeanException