public interface DataGrid extends java.io.Closeable, java.lang.Iterable<DataGrid.DataCell>, DataValueProvider
Example call from Groovy that iterates over all data cells and prints the cell member names and data to the job console:
Example call from Groovy that iterates over Min Salary and Min Bonus data cells and prints the cell member names and data to the job console:operation.grid.dataCellIterator().each { println("$it.memberNames, cell data: $it.data") }
Example call from Groovy that iterates over edited data cells and prints the cell member names and data to the job console:operation.grid.dataCellIterator('Min Salary', 'Min Bonus').each { println("$it.memberNames, cell data: $it.data") }
operation.grid.dataCellIterator({DataCell cell -> cell.edited}).each { println("$it.memberNames, cell data: $it.data") }
Modifier and Type | Interface and Description |
---|---|
static interface |
DataGrid.Cell
A base interface for all cells.
|
static interface |
DataGrid.DataCell
An interface representing a data cell in a data grid.
|
static interface |
DataGrid.HeaderCell
An interface representing a header cell in a data grid.
|
static interface |
DataGrid.Row
An interface representing a row in the data grid.
|
Modifier and Type | Method and Description |
---|---|
GridIterator |
dataCellIterator()
Returns an iterator to iterate over all data cells in this data grid.
|
GridIterator |
dataCellIterator(MemberNameType defaultMemberNameType)
Returns an iterator to iterate over all data cells in this data grid.
|
GridIterator |
dataCellIterator(MemberNameType defaultMemberNameType,
java.lang.String... mbrNames)
Returns an iterator to iterate over data cells with the specified members
in this data grid.
|
GridIterator |
dataCellIterator(org.apache.commons.collections.Predicate predicate)
Returns an iterator to iterate over data cells in this data grid where
the data cells match the specified predicate conditions.
|
GridIterator |
dataCellIterator(org.apache.commons.collections.Predicate predicate,
MemberNameType defaultMemberNameType)
Returns an iterator to iterate over data cells in this data grid where
the data cells match the specified predicate conditions.
|
GridIterator |
dataCellIterator(java.lang.String... mbrNames)
Returns an iterator to iterate over data cells with the specified members
in this data grid.
|
DataGrid.DataCell |
getCellWithMembers(java.lang.String... mbrNames)
Returns the first matching (top left) cell in this grid that
represents the specified members or null if no matching cells are found.
|
java.util.List<java.util.List<DataGrid.HeaderCell>> |
getColumns()
Returns a list of column header cells grouped by dimension for this data
grid.
|
java.util.List<DataGrid.HeaderCell> |
getPov()
Returns a list of POV header cells for this data grid.
|
java.util.List<DataGrid.Row> |
getRows()
Returns a list of rows for this data grid.
|
SmartPush |
getSmartPush(java.lang.String dataMapName)
Returns a smart push for the DataMap with the specified name
attached to this grid.
|
java.util.List<SmartPush> |
getSmartPushes()
Returns all the smart pushes attached to this grid.
|
java.util.Map<java.lang.String,java.lang.Object> |
getSourceInfo()
Returns miscellaneous information about the source of this grid.
|
boolean |
hasSmartPush(java.lang.String dataMapName)
Returns true if a smart push for the DataMap with the specified
name is attached to the form.
|
boolean |
isEmpty()
Returns true if there are zero data cells in this grid.
|
int |
size()
Returns the number of data cells in this grid.
|
dataValueIterator
GridIterator dataCellIterator()
The default member name type is set to MemberNameType.MEMBER_NAME.
GridIterator dataCellIterator(MemberNameType defaultMemberNameType)
The default member name type specified here is used unless a specific member name type is provided when the member names for cells are asked for.
defaultMemberNameType
- default member name typejava.lang.IllegalArgumentException
- if defaultMemberNameType is nullGridIterator dataCellIterator(MemberNameType defaultMemberNameType, java.lang.String... mbrNames)
The default member name type specified here is used unless a specific member name type is provided when the member names for cells are asked for. If no member names are specified, this will return an iterator to iterate over all data cells in this data grid.
defaultMemberNameType
- default member name typembrNames
- member namesGridIterator dataCellIterator(org.apache.commons.collections.Predicate predicate)
predicate
- the predicateGridIterator dataCellIterator(org.apache.commons.collections.Predicate predicate, MemberNameType defaultMemberNameType)
The default member name type specified here is used unless a specific member name type is provided when the member names for cells are asked for.
predicate
- the predicatedefaultMemberNameType
- default meber name typeGridIterator dataCellIterator(java.lang.String... mbrNames)
If no member names are specified, this returns an iterator to iterate over all data cells in this data grid.
mbrNames
- member namesDataGrid.DataCell getCellWithMembers(java.lang.String... mbrNames)
The specified member names can be from zero or more dimensions.
mbrNames
- member namesjava.util.List<java.util.List<DataGrid.HeaderCell>> getColumns()
java.util.List<DataGrid.HeaderCell> getPov()
java.util.List<DataGrid.Row> getRows()
SmartPush getSmartPush(java.lang.String dataMapName)
dataMapName
- name of the DataMap attached to this gridoracle.epm.api.model.IllegalScriptArgumentException
- if a smart push with the
specified name is not attached to the gridjava.util.List<SmartPush> getSmartPushes()
java.util.Map<java.lang.String,java.lang.Object> getSourceInfo()
For the grid obtained from the operation, the source information will have the name of the form this grid was created from.
boolean hasSmartPush(java.lang.String dataMapName)
dataMapName
- name of the DataMap attached to this gridboolean isEmpty()
int size()
Copyright © 2017, 2024, Oracle and/or its affiliates. All rights reserved.