oracle.epm.api.grid

Interface FlexibleDataGridDefinitionBuilder

public interface FlexibleDataGridDefinitionBuilder

A helper class to build a data grid definition that defines a slice or a region from which to load the 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.

The data grid object should be loaded using the withCloseable construct to ensure that it is automatically closed when it goes out of scope.

Example call from Groovy with dimension names specified:

 Cube cube = operation.application.getCube("Plan2")
 def builder = cube.flexibleDataGridDefinitionBuilder()

 builder.setPovDimensions('Scenario', 'Currency', 'Period', 'Version', 'Years')
 builder.setPov('Actual', 'USD', 'BegBalance', 'BU Version_1', 'FY22')

 builder.setColumnDimensions('Employee')
 builder.addColumn('ILvl0Descendants(Employee)')

 builder.setRowDimensions('Entity', 'Account')
 builder.addRow('ILvl0Descendants(USA)', 'Price', 'Units Sold', 'ILvl0Descendants(Alt Account)').setExclude('[Alt Account].[Units Sold]').setExcludeAll('[Alt Account].[Price]')

 // Load a data grid from the specified grid definition and cube
 cube.loadGrid(builder.build(), false).withCloseable { grid ->
    // grid operations go here
 }
 

Example call from Groovy without dimension names specified:

 Cube cube = operation.application.getCube("Plan2")
 FlexibleDataGridDefinitionBuilder builder = cube.flexibleDataGridDefinitionBuilder()

 builder.setPov('Actual', 'USD', 'BegBalance', 'BU Version_1', 'FY22')
 builder.addColumn('ILvl0Descendants(Employee)')
 builder.addRow('ILvl0Descendants(USA)', 'Price', 'Units Sold', 'ILvl0Descendants(Alt Account)').setExclude('[Alt Account].[Units Sold]').setExcludeAll('[Alt Account].[Price]')

 // Load a data grid from the specified grid definition and cube
 cube.loadGrid(builder.build(), false).withCloseable { grid ->
    // grid operations go here
 }
 

Example call from Groovy using dimension and member references:

 Cube cube = operation.application.getCube("Plan2")
 FlexibleDataGridDefinitionBuilder builder = cube.flexibleDataGridDefinitionBuilder()

 Dimension year = operation.application.getDimension('Years', cube)
 Member fy22 = year.getMember('FY22')

 builder.setPovDimensions('Scenario', 'Currency', 'Period', 'Version', year)
 builder.setPov('Actual', 'USD', 'BegBalance', 'BU Version_1', fy22)

 builder.addColumn('ILvl0Descendants(Employee)')
 builder.addRow('ILvl0Descendants(USA)', "Price", "Units Sold", "ILvl0Descendants(Alt Account)").setExclude('[Alt Account].[Units Sold]').setExcludeAll('[Alt Account].[Price]')

 // Load a data grid from the specified grid definition and cube
 cube.loadGrid(builder.build(), false).withCloseable { grid ->
    // grid operations go here
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FlexibleDataGridDefinitionBuilder.GridSegment A data grid segment defines the dimensions and members in a particular axis of the grid.

Method Summary

Modifier and Type	Method and Description
FlexibleDataGridDefinitionBuilder.GridSegment	addColumn(java.lang.Object... memberRefs) Add a Column with the specified members to this grid definition.
FlexibleDataGridDefinitionBuilder.GridSegment	addRow(java.lang.Object... memberRefs) Add a Row with the specified members to this grid definition.
DataGridDefinition	build() Returns a data grid definition built from the region defined by the caller.
FlexibleDataGridDefinitionBuilder	setColumnDimensions(java.lang.Object... dimensionRefs) Returns this object after setting the dimensions to be represented on the columns of the data grid.
FlexibleDataGridDefinitionBuilder	setPov(java.lang.Object... memberRefs) Returns this object after replacing the POV members with the specified members.
FlexibleDataGridDefinitionBuilder	setPovDimensions(java.lang.Object... dimensionRefs) Returns this object after setting the dimensions to be represented on the POV of the data grid.
FlexibleDataGridDefinitionBuilder	setRowDimensions(java.lang.Object... dimensionRefs) Returns this object after setting the dimensions to be represented on the rows of the data grid.
FlexibleDataGridDefinitionBuilder	setSuppressInvalidColumns(boolean suppressInvalidColumns) Returns this object after setting the value of suppress invalid columns option.
FlexibleDataGridDefinitionBuilder	setSuppressInvalidRows(boolean suppressInvalidRows) Returns this object after setting the value of suppress invalid rows option.
FlexibleDataGridDefinitionBuilder	setSuppressInvalidScenarioTps(boolean suppressInvalidScenarioTps) Returns this object after setting the value of suppress invalid scenario time periods option.
FlexibleDataGridDefinitionBuilder	setSuppressMissingBlocks(boolean suppressMissingBlocks) Returns this object after setting the suppress missing blocks option.
FlexibleDataGridDefinitionBuilder	setSuppressMissingColumns(boolean suppressMissingColumns) Returns this object after setting the suppress missing columns option.
FlexibleDataGridDefinitionBuilder	setSuppressMissingRows(boolean suppressMissingRows) Returns this object after setting the suppress missing rows option.
FlexibleDataGridDefinitionBuilder	setSuppressMissingRowsNative(boolean suppressMissingRowsNative) Returns this object after setting the suppress missing rows native option.
FlexibleDataGridDefinitionBuilder	setSuppressMissingSuppressesZero(boolean suppressMissingSuppressesZero) Returns this object after setting the value of suppress missing also suppresses zeros option.

Method Detail

addColumn

FlexibleDataGridDefinitionBuilder.GridSegment addColumn(java.lang.Object... memberRefs)

Add a Column with the specified members to this grid definition.

Parameters:

memberRefs - one or more objects representing a reference to a member (see section Member References)

Throws:

java.lang.Exception - if one of more dimensions for the members being set are already represented on another axis. An exception is also thrown if the dimensions for the members being set or the order in which they are being set does not match the dimensions previously set either implicitly (via a call to setColumnDimensions()) or explicitly by calling this method.

addRow

FlexibleDataGridDefinitionBuilder.GridSegment addRow(java.lang.Object... memberRefs)

Add a Row with the specified members to this grid definition.

Parameters:

memberRefs - one or more objects representing a reference to a member (see section Member References)

Throws:

java.lang.Exception - if one of more dimensions for the members being set are already represented on another axis. An exception is also thrown if the dimensions for the members being set or the order in which they are being set does not match the dimensions previously set either implicitly (via a call to setRowDimensions()) or explicitly by calling this method.

build

DataGridDefinition build()
                  throws java.lang.Exception

Returns a data grid definition built from the region defined by the caller.

Returns:

a data grid definition built from the region defined by the caller

Throws:

java.lang.Exception - if an unexpected fault occurs

setColumnDimensions

FlexibleDataGridDefinitionBuilder setColumnDimensions(java.lang.Object... dimensionRefs)

Returns this object after setting the dimensions to be represented on the columns of the data grid.

Parameters:

dimensionRefs - one or more objects representing a reference to a dimension (see section Dimension References)

Returns:

this object after setting the dimensions to be represented on the columns of the data grid

Throws:

java.lang.Exception - if one of more dimensions being set are already represented on another axis. An exception is also thrown if the dimensions being set or the order in which they are being set does not match the dimensions previously set either implicitly (via a call to addColumn()) or explicitly by calling this method.

setPov

FlexibleDataGridDefinitionBuilder setPov(java.lang.Object... memberRefs)

Returns this object after replacing the POV members with the specified members.

Parameters:

memberRefs - one or more objects representing a reference to a member (see section Member References)

Returns:

this object after replacing the POV members with the specified members

Throws:

java.lang.Exception - if one of more dimensions for the members being set are already represented on another axis. An exception is also thrown if the dimensions for the members being set or the order in which they are being set does not match the dimensions previously set either implicitly (via a call to setPovDimensions()) or explicitly by calling this method.

setPovDimensions

FlexibleDataGridDefinitionBuilder setPovDimensions(java.lang.Object... dimensionRefs)

Returns this object after setting the dimensions to be represented on the POV of the data grid.

Parameters:

dimensionRefs - one or more objects representing a reference to a dimension (see section Dimension References)

Returns:

this object after setting the dimensions to be represented on the POV of the data grid

Throws:

java.lang.Exception - if one of more dimensions being set are already represented on another axis. An exception is also thrown if the dimensions being set or the order in which they are being set does not match the dimensions previously set either implicitly (via a call to setPov()) or explicitly by calling this method.

setRowDimensions

FlexibleDataGridDefinitionBuilder setRowDimensions(java.lang.Object... dimensionRefs)

Returns this object after setting the dimensions to be represented on the rows of the data grid.

Parameters:

dimensionRefs - one or more objects representing a reference to a dimension (see section Dimension References)

Returns:

this object after setting the dimensions to be represented on the rows of the data grid

Throws:

java.lang.Exception - if one of more dimensions being set are already represented on another axis. An exception is also thrown if the dimensions being set or the order in which they are being set does not match the dimensions previously set either implicitly (via a call to addRow()) or explicitly by calling this method.

setSuppressInvalidColumns

FlexibleDataGridDefinitionBuilder setSuppressInvalidColumns(boolean suppressInvalidColumns)

Returns this object after setting the value of suppress invalid columns option.

This option is honored when the data is loaded in the defined region.

Parameters:

suppressInvalidColumns - true to suppress invalid columns

Returns:

this object after setting the value of suppress invalid columns option

setSuppressInvalidRows

FlexibleDataGridDefinitionBuilder setSuppressInvalidRows(boolean suppressInvalidRows)

Returns this object after setting the value of suppress invalid rows option.

This option is honored when the data is loaded in the defined region.

Parameters:

suppressInvalidRows - true to suppress invalid rows

Returns:

this object after setting the value of suppress invalid rows option

setSuppressInvalidScenarioTps

FlexibleDataGridDefinitionBuilder setSuppressInvalidScenarioTps(boolean suppressInvalidScenarioTps)

Returns this object after setting the value of suppress invalid scenario time periods option.

This option is honored when the data is loaded in the defined region.

Parameters:

suppressInvalidScenarioTps - true to suppress invalid scenario time periods

Returns:

this object after setting the value of suppress invalid scenario time periods option

setSuppressMissingBlocks

FlexibleDataGridDefinitionBuilder setSuppressMissingBlocks(boolean suppressMissingBlocks)

Returns this object after setting the suppress missing blocks option.

This option is honored when the data is loaded in the defined region.

Parameters:

suppressMissingBlocks - suppress missing blocks option

Returns:

this object after setting the suppress missing blocks option

setSuppressMissingColumns

FlexibleDataGridDefinitionBuilder setSuppressMissingColumns(boolean suppressMissingColumns)

Returns this object after setting the suppress missing columns option.

This option is honored when the data is loaded in the defined region.

Parameters:

suppressMissingColumns - suppress missing columns option

Returns:

this object after setting the suppress missing columns option

setSuppressMissingRows

FlexibleDataGridDefinitionBuilder setSuppressMissingRows(boolean suppressMissingRows)

Returns this object after setting the suppress missing rows option.

This option is honored when the data is loaded in the defined region.

Parameters:

suppressMissingRows - suppress missing rows option

Returns:

this object after setting the suppress missing rows option

setSuppressMissingRowsNative

FlexibleDataGridDefinitionBuilder setSuppressMissingRowsNative(boolean suppressMissingRowsNative)

Returns this object after setting the suppress missing rows native option.

This option is honored when the data is loaded in the defined region.

Parameters:

suppressMissingRowsNative - suppress missing rows native option

setSuppressMissingSuppressesZero

FlexibleDataGridDefinitionBuilder setSuppressMissingSuppressesZero(boolean suppressMissingSuppressesZero)

Returns this object after setting the value of suppress missing also suppresses zeros option.

This option is honored when the data is loaded in the defined region.

Parameters:

suppressMissingSuppressesZero - true to treat zeros as missing when suppressing missing rows

Returns:

this object after setting the value of suppress missing also suppresses zeros option