it.eng.spagobi.engines.kpi
Class SpagoBIKpiInternalEngine

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

public class SpagoBIKpiInternalEngine
extends java.lang.Object
implements InternalEngineIFace

Author:
Chiara Chiarelli

Field Summary
protected  java.lang.String behaviour
           
protected  java.lang.String bullet_chart_title
           
protected  boolean closed_tree
           
protected  java.util.HashMap confMap
           
protected  java.lang.String country
           
protected  boolean dataset_multires
           
protected  java.util.Date dateOfKPI
           
protected  boolean display_alarm
           
protected  boolean display_bullet_chart
           
protected  boolean display_semaphore
           
protected  boolean display_threshold_image
           
protected  boolean display_weight
           
protected  java.util.Date endKpiValueDate
           
protected  java.lang.String formatServer
           
protected  java.lang.String internationalizedFormat
           
protected  java.lang.String kpi_title
           
protected  java.util.List<KpiResourceBlock> kpiResultsList
           
protected  java.lang.String lang
           
protected  java.util.Locale locale
           
static java.lang.String messageBundle
           
protected  java.lang.String metadata_publisher_Name
           
protected  java.lang.String model_title
           
protected  java.lang.Integer modelInstanceRootId
           
protected  java.lang.String name
           
protected  java.util.HashMap parametersObject
           
protected  java.lang.Integer periodInstID
           
protected  java.lang.String publisher_Name
           
protected  boolean recalculate_anyway
           
protected  boolean register_par_setted
           
protected  boolean register_values
           
protected  java.util.List resources
           
protected  boolean show_axis
           
protected  StyleLabel styleSubTitle
           
protected  StyleLabel styleTitle
           
protected  java.lang.String subName
           
protected  java.lang.String threshold_image_title
           
protected  java.util.Date timeRangeFrom
           
protected  java.util.Date timeRangeTo
           
protected  java.lang.String trend_publisher_Name
           
protected  java.lang.String userIdField
           
protected  java.lang.String value_title
           
protected  java.lang.String weight_title
           
protected  boolean weighted_values
           
 
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)
          Executes the document and populates the response.
 void execute(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)
           
 KpiValue getNewKpiValue(it.eng.spagobi.tools.dataset.bo.IDataSet dataSet, KpiInstance kpiInst, Resource r, java.lang.Integer modelInstanceId)
           
 void getSetConf(it.eng.spago.base.SourceBean content)
          Function that sets the basic values getting them from the xml template
 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.
 void setName(java.lang.String _name)
           
 void setSubName(java.lang.String _name)
           
 
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

publisher_Name

protected java.lang.String publisher_Name

metadata_publisher_Name

protected java.lang.String metadata_publisher_Name

trend_publisher_Name

protected java.lang.String trend_publisher_Name

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

locale

protected java.util.Locale locale

internationalizedFormat

protected java.lang.String internationalizedFormat

formatServer

protected java.lang.String formatServer

parametersObject

protected java.util.HashMap parametersObject

closed_tree

protected boolean closed_tree

model_title

protected java.lang.String model_title

threshold_image_title

protected java.lang.String threshold_image_title

bullet_chart_title

protected java.lang.String bullet_chart_title

value_title

protected java.lang.String value_title

kpi_title

protected java.lang.String kpi_title

weight_title

protected java.lang.String weight_title

display_semaphore

protected boolean display_semaphore

display_bullet_chart

protected boolean display_bullet_chart

display_threshold_image

protected boolean display_threshold_image

display_weight

protected boolean display_weight

display_alarm

protected boolean display_alarm

register_values

protected boolean register_values

recalculate_anyway

protected boolean recalculate_anyway

register_par_setted

protected boolean register_par_setted

show_axis

protected boolean show_axis

weighted_values

protected boolean weighted_values

confMap

protected java.util.HashMap confMap

resources

protected java.util.List resources

dateOfKPI

protected java.util.Date dateOfKPI

endKpiValueDate

protected java.util.Date endKpiValueDate

periodInstID

protected java.lang.Integer periodInstID

modelInstanceRootId

protected java.lang.Integer modelInstanceRootId

lang

protected java.lang.String lang

country

protected java.lang.String country

behaviour

protected java.lang.String behaviour

dataset_multires

protected boolean dataset_multires

timeRangeFrom

protected java.util.Date timeRangeFrom

timeRangeTo

protected java.util.Date timeRangeTo

kpiResultsList

protected java.util.List<KpiResourceBlock> kpiResultsList
Constructor Detail

SpagoBIKpiInternalEngine

public SpagoBIKpiInternalEngine()
Method Detail

execute

public void execute(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
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

getNewKpiValue

public KpiValue getNewKpiValue(it.eng.spagobi.tools.dataset.bo.IDataSet dataSet,
                               KpiInstance kpiInst,
                               Resource r,
                               java.lang.Integer modelInstanceId)
                        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

getSetConf

public void getSetConf(it.eng.spago.base.SourceBean content)
Function that sets the basic values getting them from the xml template

Parameters:
content - The template SourceBean containing parameters configuration

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

setName

public void setName(java.lang.String _name)

setSubName

public void setSubName(java.lang.String _name)

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