com.essbase.api.datasource

Class EssCalcParams

java.lang.Object

com.essbase.api.datasource.EssCalcParams

public class EssCalcParams
extends java.lang.Object

The parameters required to perform a calculation.

Author:

Gautam Kumar

Constructor Summary

Constructors

Constructor and Description
EssCalcParams(boolean isDefault) Constructs calc params to execute default calculations.
EssCalcParams(boolean validateScriptOnly, java.lang.String calcScriptFileName) Constructs parameters with calcScript as a string and validate script flag.
EssCalcParams(boolean validateScriptOnly, java.lang.String calcScriptFileName, java.lang.String runtimeSubVariables) Constructs parameters with calcScript file name, runtime variables and validate script flag.
EssCalcParams(java.lang.String calcScriptString, boolean validateScriptOnly) Constructs parameters with calcScript as a string and validate script flag.
EssCalcParams(java.lang.String calcScriptString, java.lang.String runtimeSubVariables, boolean validateScriptOnly) Constructs parameters with calcScript as a string, runtime variables and validate script flag.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCalcScriptFileName() Get the cacl script file name.
java.lang.String	getCalcScriptString() Get the contents of the calculation script as a string.
java.lang.String	getRunTimeSubVariables() Get the runtime variables.
boolean	isDefault() Get is the parameter are for default calculation.
boolean	isValidateScriptOnly() Get if only the script is to be validated.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EssCalcParams

public EssCalcParams(boolean isDefault)

Constructs calc params to execute default calculations.

Parameters:

isDefault - true for default calculation.

EssCalcParams

public EssCalcParams(java.lang.String calcScriptString,
                     boolean validateScriptOnly)

Constructs parameters with calcScript as a string and validate script flag.

Parameters:

calcScriptString - The calculation script as a string.

validateScriptOnly - true if only the script is to be validated.

EssCalcParams

public EssCalcParams(boolean validateScriptOnly,
                     java.lang.String calcScriptFileName)

Constructs parameters with calcScript as a string and validate script flag.

Parameters:

validateScriptOnly - true if only the script is to be validated.

calcScriptFileName - The calculation script filename without extension.

EssCalcParams

public EssCalcParams(java.lang.String calcScriptString,
                     java.lang.String runtimeSubVariables,
                     boolean validateScriptOnly)

Constructs parameters with calcScript as a string, runtime variables and validate script flag.

Parameters:

calcScriptString - CalcScript as string.

runtimeSubVariables - Runtime variables.

validateScriptOnly - true if only the script is to be validated.

EssCalcParams

public EssCalcParams(boolean validateScriptOnly,
                     java.lang.String calcScriptFileName,
                     java.lang.String runtimeSubVariables)

Constructs parameters with calcScript file name, runtime variables and validate script flag.

Parameters:

validateScriptOnly - true if only the script is to be validated.

calcScriptFileName - Calculation script file name without extension.

runtimeSubVariables - Runtime Variables.

Method Detail

isDefault

public boolean isDefault()

Get is the parameter are for default calculation.

Returns:

true if the parameter is for default calculation.

isValidateScriptOnly

public boolean isValidateScriptOnly()

Get if only the script is to be validated.

Returns:

true if only script is to be validated without execution.

getCalcScriptString

public java.lang.String getCalcScriptString()

Get the contents of the calculation script as a string.

Returns:

Calculation script as string.

getCalcScriptFileName

public java.lang.String getCalcScriptFileName()

Get the cacl script file name.

Returns:

File name of the script present in the cube.

getRunTimeSubVariables

public java.lang.String getRunTimeSubVariables()

Get the runtime variables.

Returns:

The runtime variables.