public class Cube
extends java.lang.Object
By default, parameters are case insensitive and may not be null or empty unless otherwise specified.
Modifier and Type | Method and Description |
---|---|
void |
clearPartialData(java.lang.String mdxRegion,
boolean isPhysical)
Clears data from a specific region(slice) of an ASO cube.
|
DataExporter |
createDataExporter()
Returns a DataExporter that can be used to export data from this cube.
|
DataImportRequest |
createDataImportRequest()
Returns a new DataImportRequest that can be used import data into this
cube.
|
DataGridBuilder |
dataGridBuilder(java.lang.String dateFormat)
Returns a data grid builder.
|
DataGridBuilder |
dataGridBuilder(java.lang.String dateFormat,
ExecuteAsUser executeAsUser)
Returns a data grid builder.
|
DataGridDefinitionBuilder |
dataGridDefinitionBuilder()
Returns a grid definition builder.
|
boolean |
equals(java.lang.Object arg0) |
void |
executeAsoAllocation(AllocationParameters allocationParameters)
Executes the specified ASO allocation.
|
void |
executeAsoCustomCalculation(CustomCalcParameters calcParameters)
Executes the specified ASO custom calculation.
|
void |
executeCalcScript(java.lang.String calcScript)
Executes the specified calc script.
|
FlexibleDataGridDefinitionBuilder |
flexibleDataGridDefinitionBuilder()
Returns a flexible grid definition builder.
|
Application |
getApplication()
Returns the application to which this cube belongs.
|
java.lang.String |
getDescription()
Returns the description for this cube.
|
java.lang.String |
getEssbaseName()
Returns the physical name for this cube in Essbase.
|
java.lang.String |
getName()
Returns the logical name for this cube.
|
SubstitutionVariable |
getSubstitutionVariable(java.lang.String name)
Returns a substitution variable with the specified name defined at
this cube level.
|
SubstitutionVariable |
getSubstitutionVariable(java.lang.String name,
boolean derivedValues)
Returns a substitution variable with the specified name defined at
either the application or cube level depending on the specified value
of derivedValues.
|
java.lang.String |
getSubstitutionVariableValue(java.lang.String name)
Returns the value for the substitution variable with the specified name
at this cube level or null is not found.
|
int |
hashCode() |
boolean |
hasSubstitutionVariable(java.lang.String name)
Returns true if a substitution variable with the specified name exists
at this cube level.
|
boolean |
hasSubstitutionVariable(java.lang.String name,
boolean derivedValues)
Returns true if a substitution variable with the specified name exists
at this cube level or the application level.
|
boolean |
isSandBoxEnabled()
Returns true if this cube is enabled for sandboxing.
|
DataGrid |
loadGrid(DataGridDefinition gridDefinition,
boolean filterMembersWithNoAccess)
Returns a data grid for the specified region.
|
void |
saveGrid(DataGrid grid)
Save the data specified in the grid.
|
void |
setSubstitutionVariableValue(java.lang.String name,
java.lang.String value)
Sets the value for the substitution variable with the specified name at
this cube level.
|
java.lang.String |
toString()
Returns a string representation of the object.
|
public void clearPartialData(java.lang.String mdxRegion, boolean isPhysical)
Example call from Groovy:
Cube cube = operation.getApplication().getCube('HP1_ASO') cube.clearPartialData('Crossjoin(Crossjoin(Crossjoin(Crossjoin(Crossjoin( Crossjoin(Crossjoin(Crossjoin({[Jan]},{[FY15]}),{[Current]}), {[BU Version_1]}),{[USD]}),{[FL]}),{[No Manager]}), {CHILDREN([Total Employees])}), {[Bonus]})', false)
mdxRegion
- MDX set expression which specifies the region to be
clearedisPhysical
- true to clear data physically (cells will be removed
from cube) and false to clear logically (cell value is set to 0)public DataExporter createDataExporter() throws java.lang.Exception
java.lang.Exception
- if an unexpected fault occurspublic DataImportRequest createDataImportRequest()
public DataGridBuilder dataGridBuilder(java.lang.String dateFormat)
This builder can be used to build a grid that retrieves metadata for the POV/Row/Column header cells as well as the data cells. In addition, the grid provides smart iterators to iterate over the data cells for the grid.
dateFormat
- Date format for Date type of cellspublic DataGridBuilder dataGridBuilder(java.lang.String dateFormat, ExecuteAsUser executeAsUser)
This builder can be used to build a grid that retrieves metadata for the POV/Row/Column header cells as well as the data cells. In addition, the grid provides smart iterators to iterate over the data cells for the grid.
dateFormat
- Date format for Date type of cellsexecuteAsUser
- user to build the grid on behalf ofpublic DataGridDefinitionBuilder dataGridDefinitionBuilder()
This builder can be used to build a DataGridDefinition object used to define a region from which to export data.
public void executeAsoAllocation(AllocationParameters allocationParameters) throws oracle.epm.api.model.AsoException
Example call from Groovy:
/*RTPS: {curYear}*/ AllocationParameters allocationParameters = new AllocationParameters() allocationParameters.pov = 'Crossjoin(Crossjoin(Crossjoin(Crossjoin(Crossjoin(Crossjoin(Crossjoin({[Bonus]},{[No Currency]}),{[No Entity]}), {[No Manager]}),{[Jan]}),{[Current]}),{[BU Version_1]}),{${mdxParams(rtps.curYear)}})' allocationParameters.amount = '([No Employee])' allocationParameters.zeroAmountOption = ZeroAmountOption.ABORT allocationParameters.targetTimeSpanOption = TargetTimeSpanOption.DIVIDE_AMOUNT allocationParameters.range = '{Descendants([Total Employees], [Total Employees].dimension.Levels(0))}' allocationParameters.basis = '([Salary], [Actual])' allocationParameters.basisTimeSpanOption = BasisTimeSpanOption.COMBINE_BASIS allocationParameters.zeroBasisOption = ZeroBasisOption.ABORT allocationParameters.negativeBasisOption = NegativeBasisOption.DEFAULT allocationParameters.allocationMethod = AllocationMethod.SHARE allocationParameters.roundDigits = 2 allocationParameters.roundMethod = RoundingMethod.ERRORS_TO_HIGHEST operation.cube.executeAsoAllocation(allocationParameters)
allocationParameters
- the ASO allocation parametersAsoException
- if there is an allocation failurepublic void executeAsoCustomCalculation(CustomCalcParameters calcParameters) throws oracle.epm.api.model.AsoException
Example call from Groovy:
/*RTPS: {curYear}*/ CustomCalcParameters calcParameters = new CustomCalcParameters() calcParameters.pov = 'Crossjoin(Crossjoin(Crossjoin(Crossjoin(Crossjoin( Crossjoin(Crossjoin({[Jan]},{${mdxParams(rtps.curYear)}}),{[Current]}), {[BU Version_1]}), {[No Currency]}),{[No Entity]}),{[No Manager]}), {CHILDREN([Total Employees])})' calcParameters.script = '([Salary]) := 5000;' calcParameters.roundDigits = 2 operation.getApplication().getCube('HP1_ASO').executeAsoCustomCalculation(calcParameters)
calcParameters
- the custom calculation parametersAsoException
- if there is a calculation failurepublic void executeCalcScript(java.lang.String calcScript) throws oracle.epm.api.model.CalcScriptException
Example call from Groovy to execute a calc script that returns a custom message and read the properties of the exception:
def script = """ FIX("USD", "Current", "BU Version_1", "FY17", "No Entity", "Grade 1") "Min Salary"( IF(Jan < 0) @RETURN("Jan contains a negative value!", ERROR); ENDIF ) ENDFIX""" Cube cube = operation.application.getCube("Plan1") try { cube.executeCalcScript(script) } catch(CalcScriptException e) { assert e.message == "Jan contains a negative value!" assert e.localizedMessage == "Jan contains a negative value!" assert e.atReturnMessage == "Jan contains a negative value!" }
Example call from Groovy to execute a calc script with an error and read the properties of the exception:
def script = """ FIX ("USDx", "Current", "BU Version_1", "FY17", "No Entity", "Grade 1", "Min Salary") Jan = 10; ENDFIX""" Cube cube = operation.application.getCube("Plan1") try { cube.executeCalcScript(script) } catch(CalcScriptException e) { assert e.message == "Error parsing formula for [FIX STATEMENT] (line 1): invalid object type" assert e.localizedMessage == "Error parsing formula for [FIX STATEMENT] (line 1): invalid object type" assert e.hasAtReturnMessage() == false }
calcScript
- calc scriptCalcScriptException
- if the specified calc script returns a
custom error message via a @RETURN calc command or there is an execution
failure for other reasons such as an invalid calc script.public FlexibleDataGridDefinitionBuilder flexibleDataGridDefinitionBuilder()
This builder can be used to build a DataGridDefinition object used to define a region from which to export data.
This builder should be preferred over DataGridDefinitionBuilder
as it supports exclusions and Dimension and Member references instead of
just Strings for arguments. It also auto computes the dimensions from the
members on various axis if dimensions are not specified.
public Application getApplication()
public java.lang.String getDescription()
public java.lang.String getEssbaseName()
public java.lang.String getName()
public SubstitutionVariable getSubstitutionVariable(java.lang.String name)
name
- name of the substitution variablecom.hyperion.planning.HspRuntimeException
- if the substitution variable was not foundpublic SubstitutionVariable getSubstitutionVariable(java.lang.String name, boolean derivedValues)
If derivedValues is set to true, the derived list of variables will be looked at which includes variables defined at the application level and at this cube level. If a substitution variable with the speciified name is defined both at this cube level and at the application level, the cube level is returned.
name
- name of the substitution variablederivedValues
- true to look against the derived list of variablescom.hyperion.planning.HspRuntimeException
- if the substitution variable was not foundpublic java.lang.String getSubstitutionVariableValue(java.lang.String name)
name
- name of the substitution variablepublic boolean hasSubstitutionVariable(java.lang.String name)
name
- name of the substitution variablepublic boolean hasSubstitutionVariable(java.lang.String name, boolean derivedValues)
If derivedValues is set to true, the derived list of variables will be looked at which includes variables defined at the application level and at this cube level. If a substitution variable with the speciified name is defined both at this cube level and at the application level, the cube level is considered.
name
- name of the substitution variablederivedValues
- true to look against the derived list of variablespublic boolean isSandBoxEnabled()
public DataGrid loadGrid(DataGridDefinition gridDefinition, boolean filterMembersWithNoAccess) throws java.lang.Exception
This grid can be used to retrieve metadata for the POV/Row/Column header cells as well as the data cells. In addition, the grid provides smart iterators to iterate over the data cells for the grid.
gridDefinition
- the slice definition for which to export datafilterMembersWithNoAccess
- if true the user's security is appliedjava.lang.Exception
- if an unexpected fault occurspublic void saveGrid(DataGrid grid)
grid
- data gridpublic void setSubstitutionVariableValue(java.lang.String name, java.lang.String value)
The variable will be created if it does not exist already.
This is a privileged method, see section Privileged Method
name
- name of the substitution variablevalue
- value to setpublic java.lang.String toString()
toString
in class java.lang.Object
public boolean equals(java.lang.Object arg0)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
Copyright © 2017, 2024, Oracle and/or its affiliates. All rights reserved.