it.eng.spagobi.engines.kpi
Class SpagoBIKpiInternalEngine

java.lang.Object
  extended by it.eng.spagobi.engines.drivers.AbstractDriver
      extended by it.eng.spagobi.engines.kpi.SpagoBIKpiInternalEngine
All Implemented Interfaces:
InternalEngineIFace

public class SpagoBIKpiInternalEngine
extends AbstractDriver
implements InternalEngineIFace

Author:
Chiara Chiarelli

Field Summary
protected  KpiValueComputation computation
           
 java.util.HashMap confMap
           
 KpiEnginData data
           
protected  java.util.List<KpiResourceBlock> kpiResultsList
           
static java.lang.String messageBundle
           
protected  java.lang.Integer modelInstanceRootId
           
protected  java.lang.String name
           
 KpiParametrization parameters
           
protected  java.lang.Integer periodInstID
           
protected static java.lang.String RESOURCE
           
 java.util.List resources
           
protected  StyleLabel styleSubTitle
           
protected  StyleLabel styleTitle
           
protected  java.lang.String subName
           
 KpiTemplateConfiguration templateConfiguration
           
protected  java.lang.String userIdField
           
 
Constructor Summary
SpagoBIKpiInternalEngine()
           
 
Method Summary
 void calculateAndInsertKpiValueWithResources(java.lang.Integer miId, java.util.List resources)
           
 void execute(it.eng.spago.base.RequestContainer requestContainer, BIObject obj, it.eng.spago.base.SourceBean response)
          Method used by basic execution and by the scheduler.
 void executeByKpiEngineJob(it.eng.spago.base.RequestContainer requestContainer, it.eng.spago.base.SourceBean response)
           
 java.util.List<KpiResourceBlock> executeCode(it.eng.spago.base.RequestContainer requestContainer, BIObject obj, it.eng.spago.base.SourceBean response, java.lang.String userId)
           
 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.
 KpiLine getBlock(java.lang.Integer miId, Resource r)
           
 java.lang.String getName()
           
 java.lang.String getSubName()
           
 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.
protected  KpiValue setKpiValuesFromDataset(KpiValue kpiValueToReturn, java.util.List fields, it.eng.spagobi.tools.dataset.common.metadata.IMetaData d, java.util.Date begD, java.util.Date endDate, java.lang.String datasetLabel, java.lang.Integer modInstId, KpiValue kpiVal)
           
 void setName(java.lang.String name)
           
 void setSubName(java.lang.String subName)
           
 
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

messageBundle

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

RESOURCE

protected static final java.lang.String RESOURCE
See Also:
Constant Field Values

name

protected java.lang.String name

subName

protected java.lang.String subName

styleTitle

protected StyleLabel styleTitle

styleSubTitle

protected StyleLabel styleSubTitle

userIdField

protected java.lang.String userIdField

resources

public java.util.List resources

periodInstID

protected java.lang.Integer periodInstID

modelInstanceRootId

protected java.lang.Integer modelInstanceRootId

templateConfiguration

public KpiTemplateConfiguration templateConfiguration

data

public KpiEnginData data

parameters

public KpiParametrization parameters

computation

protected KpiValueComputation computation

kpiResultsList

protected java.util.List<KpiResourceBlock> kpiResultsList

confMap

public java.util.HashMap confMap
Constructor Detail

SpagoBIKpiInternalEngine

public SpagoBIKpiInternalEngine()
Method Detail

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getSubName

public java.lang.String getSubName()

setSubName

public void setSubName(java.lang.String subName)

executeByKpiEngineJob

public void executeByKpiEngineJob(it.eng.spago.base.RequestContainer requestContainer,
                                  it.eng.spago.base.SourceBean response)
                           throws it.eng.spago.error.EMFUserError,
                                  it.eng.spago.base.SourceBeanException
Throws:
it.eng.spago.error.EMFUserError
it.eng.spago.base.SourceBeanException

execute

public void execute(it.eng.spago.base.RequestContainer requestContainer,
                    BIObject obj,
                    it.eng.spago.base.SourceBean response)
             throws it.eng.spago.error.EMFUserError
Method used by basic execution and by the scheduler. 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

executeCode

public java.util.List<KpiResourceBlock> executeCode(it.eng.spago.base.RequestContainer requestContainer,
                                                    BIObject obj,
                                                    it.eng.spago.base.SourceBean response,
                                                    java.lang.String userId)
                                             throws it.eng.spago.error.EMFUserError
Parameters:
-
resources -
Throws:
it.eng.spago.error.EMFUserError
it.eng.spago.error.EMFInternalError

calculateAndInsertKpiValueWithResources

public void calculateAndInsertKpiValueWithResources(java.lang.Integer miId,
                                                    java.util.List resources)
                                             throws it.eng.spago.error.EMFUserError,
                                                    it.eng.spago.error.EMFInternalError,
                                                    it.eng.spago.base.SourceBeanException
Throws:
it.eng.spago.error.EMFUserError
it.eng.spago.error.EMFInternalError
it.eng.spago.base.SourceBeanException

getBlock

public KpiLine getBlock(java.lang.Integer miId,
                        Resource r)
                 throws it.eng.spago.error.EMFUserError,
                        it.eng.spago.error.EMFInternalError,
                        it.eng.spago.base.SourceBeanException
Throws:
it.eng.spago.error.EMFUserError
it.eng.spago.error.EMFInternalError
it.eng.spago.base.SourceBeanException

setKpiValuesFromDataset

protected KpiValue setKpiValuesFromDataset(KpiValue kpiValueToReturn,
                                           java.util.List fields,
                                           it.eng.spagobi.tools.dataset.common.metadata.IMetaData d,
                                           java.util.Date begD,
                                           java.util.Date endDate,
                                           java.lang.String datasetLabel,
                                           java.lang.Integer modInstId,
                                           KpiValue kpiVal)
                                    throws it.eng.spago.error.EMFUserError,
                                           it.eng.spago.base.SourceBeanException
Throws:
it.eng.spago.error.EMFUserError
it.eng.spago.base.SourceBeanException

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