Style Intelligence v12.0

inetsoft.graph.guide.form
Class TargetParameter

java.lang.Object
  extended by inetsoft.graph.guide.form.TargetParameter

public class TargetParameter
extends Object

Parameters for the Graph Target which can be constant values or a post-aggregate calculation


Constructor Summary
TargetParameter()
          Convenience empty constructor.
TargetParameter(double constValue)
          Convenience constructor with double argument
TargetParameter(Formula formula)
          Convenience constructor for non constants
TargetParameter(Formula formula, double constValue)
          Create a new TargetParameter
 
Method Summary
 double getConstantValue()
          Get the value of the parameter, generally only useful for constant
 Formula getFormula()
           
 double getRuntimeValue(double[] postAggregateData)
          Calculate the runtime value of the parameter given the post aggregate data
 void setConstantValue(double newValue)
          Set the value of the parameter
 void setFormula(Formula formula)
          Set the formula for calculating the runtime value of the parameter
 String toString()
          Return a description of the value
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TargetParameter

public TargetParameter(double constValue)
Convenience constructor with double argument


TargetParameter

public TargetParameter(Formula formula)
Convenience constructor for non constants


TargetParameter

public TargetParameter(Formula formula,
                       double constValue)
Create a new TargetParameter

Parameters:
formula -
constValue -

TargetParameter

public TargetParameter()
Convenience empty constructor. Makes a pass-through with default value

Method Detail

getFormula

public Formula getFormula()
Returns:
the formula used to calculate the runtime value of the parameter

getConstantValue

public double getConstantValue()
Get the value of the parameter, generally only useful for constant

Returns:
constant parameter value

setConstantValue

public void setConstantValue(double newValue)
Set the value of the parameter

Parameters:
newValue -

setFormula

public void setFormula(Formula formula)
Set the formula for calculating the runtime value of the parameter

Parameters:
formula - the formula to use

getRuntimeValue

public double getRuntimeValue(double[] postAggregateData)
Calculate the runtime value of the parameter given the post aggregate data

Parameters:
postAggregateData -
Returns:

toString

public String toString()
Return a description of the value

Overrides:
toString in class Object

Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.