public interface DataGridDefinitionBuilder
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:
Note: TheCube cube = operation.application.getCube("Plan1") DataGridDefinitionBuilder builder = cube.dataGridDefinitionBuilder() builder.addPov(['Years', 'Scenario', 'Currency', 'Period', 'Version', 'Entity'], [['FY16'], ['Current'], ['Local'], ['BegBalance'], ['BU Version_1'], ['No Entity']]) builder.addColumn(['Account'], [ ['Min Salary', 'Max Salary', 'Min Bonus', 'Max Bonus'] ]) builder.addRow(['Grades'], [ ['ILvl0Descendants("Grades")'] ]) // Load a data grid from the specified grid definition and cube cube.loadGrid(builder.build(), false).withCloseable { grid -> // grid operations go here }
FlexibleDataGridDefinitionBuilder
should be preferred over
this builder if exclusion support is needed.
Modifier and Type | Method and Description |
---|---|
void |
addColumn(java.util.List<java.lang.String> dimensions,
java.util.List<java.util.List<java.lang.String>> memberSelections)
Add column members to this grid definition.
|
void |
addRow(java.util.List<java.lang.String> dimensions,
java.util.List<java.util.List<java.lang.String>> memberSelections)
Add row members to this grid definition.
|
DataGridDefinition |
build()
Returns a data grid definition built from the region defined by
the caller.
|
void |
setPov(java.util.List<java.lang.String> dimensions,
java.util.List<java.util.List<java.lang.String>> members)
Replaces the POV members with the specified members.
|
void |
setSuppressInvalidColumns(boolean suppressInvalidColumns)
Sets the value of suppress invalid columns option, which is honored
when the data is loaded in the defined region.
|
void |
setSuppressInvalidRows(boolean suppressInvalidRows)
Sets the value of suppress invalid rows option, which is honored
when the data is loaded in the defined region.
|
void |
setSuppressInvalidScenarioTps(boolean suppressInvalidScenarioTps)
Sets the value of suppress invalid scenario time periods option, which
is honored when the data is loaded in the defined region.
|
void |
setSuppressMissingBlocks(boolean suppressMissingBlocks)
Sets the suppress missing blocks option, which is honored
when the data is loaded in the defined region.
|
void |
setSuppressMissingColumns(boolean suppressMissingColumns)
Sets the suppress missing columns option, which is honored
when the data is loaded in the defined region.
|
void |
setSuppressMissingRows(boolean suppressMissingRows)
Sets the suppress missing rows option, which is honored
when the data is loaded in the defined region.
|
void |
setSuppressMissingRowsNative(boolean suppressMissingRowsNative)
Sets the suppress missing rows native option, which is honored
when the data is loaded in the defined region.
|
void |
setSuppressMissingSuppressesZero(boolean suppressMissingSuppressesZero)
Sets the value of suppress missing also suppresses zeros option, which
is honored when the data is loaded in the defined region.
|
void addColumn(java.util.List<java.lang.String> dimensions, java.util.List<java.util.List<java.lang.String>> memberSelections)
dimensions
- a list of dimension namesmemberSelections
- a list of member selection strings grouped by
the specified dimensionsvoid addRow(java.util.List<java.lang.String> dimensions, java.util.List<java.util.List<java.lang.String>> memberSelections)
dimensions
- a list of dimension namesmemberSelections
- a list of member selection strings grouped by
the specified dimensionsDataGridDefinition build() throws java.lang.Exception
java.lang.Exception
- if an unexpected fault occursvoid setPov(java.util.List<java.lang.String> dimensions, java.util.List<java.util.List<java.lang.String>> members)
dimensions
- dimension namesmembers
- member names for the corresponding dimensionsvoid setSuppressInvalidColumns(boolean suppressInvalidColumns)
suppressInvalidColumns
- true to suppress invalid columnsvoid setSuppressInvalidRows(boolean suppressInvalidRows)
suppressInvalidRows
- true to suppress invalid rowsvoid setSuppressInvalidScenarioTps(boolean suppressInvalidScenarioTps)
suppressInvalidScenarioTps
- true to suppress invalid scenario
time periodsvoid setSuppressMissingBlocks(boolean suppressMissingBlocks)
suppressMissingBlocks
- suppress missing blocks optionvoid setSuppressMissingColumns(boolean suppressMissingColumns)
suppressMissingColumns
- suppress missing columns optionvoid setSuppressMissingRows(boolean suppressMissingRows)
suppressMissingRows
- suppress missing rows optionvoid setSuppressMissingRowsNative(boolean suppressMissingRowsNative)
suppressMissingRowsNative
- suppress missing rows native optionvoid setSuppressMissingSuppressesZero(boolean suppressMissingSuppressesZero)
suppressMissingSuppressesZero
- true to treat zeros as missing when
suppressing missing rowsCopyright © 2017, 2024, Oracle and/or its affiliates. All rights reserved.