it.eng.spagobi.engines.chart
Class SpagoBIChartInternalEngine

java.lang.Object
  extended by it.eng.spagobi.engines.chart.SpagoBIChartInternalEngine
All Implemented Interfaces:
InternalEngineIFace

public class SpagoBIChartInternalEngine
extends java.lang.Object
implements InternalEngineIFace

Internal Engine * @author Giulio Gavardi giulio.gavardi@eng.it


Field Summary
static java.lang.String HIGHCHART_TEMPLATE
           
static java.lang.String messageBundle
           
 
Constructor Summary
SpagoBIChartInternalEngine()
           
 
Method Summary
 void execute(it.eng.spago.base.RequestContainer requestContainer, BIObject obj, it.eng.spago.base.SourceBean response)
          Executes the document and populates the response.
 void executeChart(it.eng.spago.base.RequestContainer requestContainer, BIObject obj, it.eng.spago.base.SourceBean response, it.eng.spago.security.IEngUserProfile userProfile, java.util.Locale locale)
          Executes the document and populates the response.
 java.io.File executeChartCode(it.eng.spago.base.RequestContainer requestContainer, BIObject obj, it.eng.spago.base.SourceBean response, it.eng.spago.security.IEngUserProfile userProfile)
          This method is used to execute a chart code way and returning the image chart execution Pay attention that must get the parameters from BiObject in order to filter categories and series All the parameters must be taken not from request but from BiObject
 void executeSubObject(it.eng.spago.base.RequestContainer requestContainer, BIObject obj, it.eng.spago.base.SourceBean response, java.lang.Object subObjectInfo)
          The SpagoBIDashboardInternalEngine cannot manage subobjects so this method must not be invoked.
 java.util.Map getParameters(BIObject obj)
          COnverts from BIObject Parameters to a map, in presence of multi value merge with ,
 org.json.JSONArray getParametersAsJSON(BIObject obj)
          COnverts from BIObject Parameters to a map, in presence of multi value merge with ,
 it.eng.spago.base.SourceBean getTemplate(java.lang.String documentId)
           
 void handleDocumentTemplateEdit(it.eng.spago.base.RequestContainer requestContainer, BIObject obj, it.eng.spago.base.SourceBean response)
          Function not implemented.
 void handleNewDocumentTemplateCreation(it.eng.spago.base.RequestContainer requestContainer, BIObject obj, it.eng.spago.base.SourceBean response)
          Function not implemented.
 DatasetMap retrieveDatasetValue(ChartImpl sbi)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

messageBundle

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

HIGHCHART_TEMPLATE

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

SpagoBIChartInternalEngine

public SpagoBIChartInternalEngine()
Method Detail

executeChartCode

public java.io.File executeChartCode(it.eng.spago.base.RequestContainer requestContainer,
                                     BIObject obj,
                                     it.eng.spago.base.SourceBean response,
                                     it.eng.spago.security.IEngUserProfile userProfile)
                              throws it.eng.spago.error.EMFUserError
This method is used to execute a chart code way and returning the image chart execution Pay attention that must get the parameters from BiObject in order to filter categories and series All the parameters must be taken not from request but from BiObject

Parameters:
requestContainer -
obj -
response -
Throws:
it.eng.spago.error.EMFUserError

execute

public void execute(it.eng.spago.base.RequestContainer requestContainer,
                    BIObject obj,
                    it.eng.spago.base.SourceBean response)
             throws it.eng.spago.error.EMFUserError
Description copied from interface: InternalEngineIFace
Executes the document and populates the response.

Specified by:
execute in interface InternalEngineIFace
Parameters:
requestContainer - The RequestContainer object (the session can be retrieved from this object)
obj - The BIObject representing the document to be executed
response - The response SourceBean to be populated
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

executeChart

public void executeChart(it.eng.spago.base.RequestContainer requestContainer,
                         BIObject obj,
                         it.eng.spago.base.SourceBean response,
                         it.eng.spago.security.IEngUserProfile userProfile,
                         java.util.Locale locale)
                  throws it.eng.spago.error.EMFUserError
Executes the document and populates the response.

Parameters:
requestContainer - The RequestContainerchartImp object (the session can be retrieved from this object)
obj - The BIObject representing the document to be executed
response - The response SourceBean to be populated
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

executeSubObject

public void executeSubObject(it.eng.spago.base.RequestContainer requestContainer,
                             BIObject obj,
                             it.eng.spago.base.SourceBean response,
                             java.lang.Object subObjectInfo)
                      throws it.eng.spago.error.EMFUserError
The SpagoBIDashboardInternalEngine cannot manage subobjects so this method must not be invoked.

Specified by:
executeSubObject in interface InternalEngineIFace
Parameters:
requestContainer - The RequestContainer object (the session can be retrieved from this object)
obj - The BIObject representing the document
response - The response SourceBean to be populated
subObjectInfo - An object describing the subobject to be executed
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

handleNewDocumentTemplateCreation

public void handleNewDocumentTemplateCreation(it.eng.spago.base.RequestContainer requestContainer,
                                              BIObject obj,
                                              it.eng.spago.base.SourceBean response)
                                       throws it.eng.spago.error.EMFUserError,
                                              InvalidOperationRequest
Function not implemented. Thid method should not be called

Specified by:
handleNewDocumentTemplateCreation in interface InternalEngineIFace
Parameters:
requestContainer - The RequestContainer object (the session can be retrieved from this object)
response - The response SourceBean to be populated
obj - the obj
Throws:
InvalidOperationRequest - the invalid operation request
it.eng.spago.error.EMFUserError - the EMF user error

handleDocumentTemplateEdit

public void handleDocumentTemplateEdit(it.eng.spago.base.RequestContainer requestContainer,
                                       BIObject obj,
                                       it.eng.spago.base.SourceBean response)
                                throws it.eng.spago.error.EMFUserError,
                                       InvalidOperationRequest
Function not implemented. Thid method should not be called

Specified by:
handleDocumentTemplateEdit in interface InternalEngineIFace
Parameters:
requestContainer - The RequestContainer object (the session can be retrieved from this object)
response - The response SourceBean to be populated
obj - the obj
Throws:
InvalidOperationRequest - the invalid operation request
it.eng.spago.error.EMFUserError - the EMF user error

getTemplate

public it.eng.spago.base.SourceBean getTemplate(java.lang.String documentId)
                                         throws it.eng.spago.error.EMFUserError
Throws:
it.eng.spago.error.EMFUserError

getParameters

public java.util.Map getParameters(BIObject obj)
COnverts from BIObject Parameters to a map, in presence of multi value merge with ,

Parameters:
obj -
Returns:

getParametersAsJSON

public org.json.JSONArray getParametersAsJSON(BIObject obj)
COnverts from BIObject Parameters to a map, in presence of multi value merge with ,

Parameters:
obj -
Returns:

retrieveDatasetValue

public DatasetMap retrieveDatasetValue(ChartImpl sbi)
                                throws it.eng.spago.error.EMFUserError
Throws:
it.eng.spago.error.EMFUserError