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.util.HashMap confMap
           
protected  java.util.Date dateOfKPI
           
protected  boolean display_alarm
           
protected  boolean display_bullet_chart
           
protected  boolean display_semaphore
           
protected  boolean display_weight
           
protected  java.util.Date endKpiValueDate
           
static java.lang.String messageBundle
           
protected  java.lang.String name
           
protected  java.util.HashMap parametersObject
           
protected  java.lang.Integer periodInstID
           
protected  it.eng.spago.security.IEngUserProfile profile
           
protected  boolean recalculate_anyway
           
protected  boolean register_values
           
protected  java.util.List resources
           
protected  StyleLabel styleSubTitle
           
protected  StyleLabel styleTitle
           
protected  java.lang.String subName
           
 
Constructor Summary
SpagoBIKpiInternalEngine()
           
 
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 execute(it.eng.spago.base.RequestContainer requestContainer, it.eng.spago.base.SourceBean response)
           
 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(IDataSet dataSet, KpiInstance k, Resource r)
           
 java.awt.Color getSemaphorColor(java.util.List thresholds, java.lang.Double value)
          This function fills up the vector "intervals" with the intervals of the chart, getting them from a list of Thresholds
 void getSetConf(it.eng.spago.base.SourceBean content)
           
 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

name

protected java.lang.String name

subName

protected java.lang.String subName

styleTitle

protected StyleLabel styleTitle

styleSubTitle

protected StyleLabel styleSubTitle

profile

protected it.eng.spago.security.IEngUserProfile profile

parametersObject

protected java.util.HashMap parametersObject

display_semaphore

protected boolean display_semaphore

display_bullet_chart

protected boolean display_bullet_chart

display_weight

protected boolean display_weight

display_alarm

protected boolean display_alarm

register_values

protected boolean register_values

recalculate_anyway

protected boolean recalculate_anyway

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
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
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
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

getBlock

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

getNewKpiValue

public KpiValue getNewKpiValue(IDataSet dataSet,
                               KpiInstance k,
                               Resource r)
                        throws it.eng.spago.error.EMFUserError,
                               it.eng.spago.error.EMFInternalError
Throws:
it.eng.spago.error.EMFUserError
it.eng.spago.error.EMFInternalError

getSemaphorColor

public java.awt.Color getSemaphorColor(java.util.List thresholds,
                                       java.lang.Double value)
This function fills up the vector "intervals" with the intervals of the chart, getting them from a list of Thresholds

Parameters:
List - of thresholds to set
Returns:
The Color of the interval in which the value falls

getSetConf

public void getSetConf(it.eng.spago.base.SourceBean content)

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