oracle.epm.api.model

Interface DataValue

All Known Subinterfaces:

DataGrid.DataCell

public interface DataValue

An interface representing a data value.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAccountName() Returns the account name for this cell.
java.lang.String	getAccountName(MemberNameType memberNameType) Returns the account name for this cell based on the specified member name type.
java.util.Date	getDataAsDate() Returns a date representation of the data value in this data cell if the data type is DATE; otherwise null is returned.
double	getDataAsDouble() Returns the data value in this data cell.
java.lang.String	getDataAsSmartListMemberName() Returns the name of the member from which this data cell's smart list value is derived.
java.lang.String	getDataAsSmartListMemberName(MemberNameType memberNameType) Returns the name of the member based on the specified member name type from which this data cell's smart list value is derived.
java.lang.String	getEntityName() Returns the entity name for this cell.
java.lang.String	getEntityName(MemberNameType memberNameType) Returns the entity name for this cell based on the specified member name type.
java.lang.String	getFormattedValue() Returns the formatted value for this data cell.
java.lang.String	getMemberName(oracle.epm.api.model.DimensionType dimType) Returns the member name for the specified dimension type that the cell represents.
java.lang.String	getMemberName(oracle.epm.api.model.DimensionType dimType, MemberNameType memberNameType) Returns the member name based on the specified member name type for the specified dimension type that the cell represents.
java.lang.String	getMemberName(java.lang.String dimName) Returns the member name for the specified dimension that the cell represents.
java.lang.String	getMemberName(java.lang.String dimName, MemberNameType memberNameType) Returns the member name based on the specified member name type for the specified dimension that the cell represents.
java.util.List<java.lang.String>	getMemberNames() Returns a list of members from all dimensions that the cell represents.
java.util.List<java.lang.String>	getMemberNames(MemberNameType memberNameType) Returns a list of members based on the specified member name type from all dimensions that the cell represents.
java.lang.String	getPeriodName() Returns the period name for this cell.
java.lang.String	getPeriodName(MemberNameType memberNameType) Returns the period name for this cell based on the specified member name type.
java.lang.String	getScenarioName() Returns the scenario name for this cell.
java.lang.String	getScenarioName(MemberNameType memberNameType) Returns the scenario name for this cell based on the specified member name type.
java.lang.String	getVersionName() Returns the version name for this cell.
java.lang.String	getVersionName(MemberNameType memberNameType) Returns the version name for this cell based on the specified member name type.
java.lang.String	getYearName() Returns the year name for this cell.
java.lang.String	getYearName(MemberNameType memberNameType) Returns the year name for this cell based on the specified member name type.
boolean	isEdited() Returns true if this data cell is edited.
boolean	isMissing() Returns true if this data cell value is missing.

Method Detail

getAccountName

java.lang.String getAccountName()

Returns the account name for this cell.

The returned name is based on the default member name type set for the iterator.

Returns:

the account name for this cell

getAccountName

java.lang.String getAccountName(MemberNameType memberNameType)

Returns the account name for this cell based on the specified member name type.

Parameters:

memberNameType - member name type

Returns:

the account name for this cell based on the specified member name type

getDataAsDate

java.util.Date getDataAsDate()

Returns a date representation of the data value in this data cell if the data type is DATE; otherwise null is returned.

Returns:

a Date representation of the data value in this data cell if the data type is DATE; otherwise null is returned

getDataAsDouble

double getDataAsDouble()

Returns the data value in this data cell.

Returns:

the data value in this data cell

getDataAsSmartListMemberName

java.lang.String getDataAsSmartListMemberName()

Returns the name of the member from which this data cell's smart list value is derived.

Returns:

the name of the member from which this data cell's smart list value is derived

getDataAsSmartListMemberName

java.lang.String getDataAsSmartListMemberName(MemberNameType memberNameType)

Returns the name of the member based on the specified member name type from which this data cell's smart list value is derived.

Parameters:

memberNameType - member name type

Returns:

the name of the member based on the specified member name type from which this data cell's smart list value is derived

getEntityName

java.lang.String getEntityName()

Returns the entity name for this cell.

The returned name is based on the default member name type set for the iterator.

Returns:

the entity name for this cell

getEntityName

java.lang.String getEntityName(MemberNameType memberNameType)

Returns the entity name for this cell based on the specified member name type.

Parameters:

memberNameType - member name type

Returns:

the entity name for this cell based on the specified member name type

getFormattedValue

java.lang.String getFormattedValue()

Returns the formatted value for this data cell.

This is the logical string representation of the value in case of smart list, text and date type of cells.

This should not be used in comparisons in code as the values will change depending on the user's locale.

Returns:

the formatted value for this data cell

getMemberName

java.lang.String getMemberName(oracle.epm.api.model.DimensionType dimType)

Returns the member name for the specified dimension type that the cell represents.

Parameters:

dimType - dimension type

Returns:

the member name for the specified dimension type that the cell represents.

getMemberName

java.lang.String getMemberName(oracle.epm.api.model.DimensionType dimType,
                               MemberNameType memberNameType)

Returns the member name based on the specified member name type for the specified dimension type that the cell represents.

Parameters:

dimType - dimension type

memberNameType - the member name type

Returns:

the member name based on the specified member name type for the specified dimension type that the cell represents

getMemberName

java.lang.String getMemberName(java.lang.String dimName)

Returns the member name for the specified dimension that the cell represents.

Parameters:

dimName - Dimension name

Returns:

the member name for the specified dimension that the cell represents

getMemberName

java.lang.String getMemberName(java.lang.String dimName,
                               MemberNameType memberNameType)

Returns the member name based on the specified member name type for the specified dimension that the cell represents.

Parameters:

dimName - Dimension name

memberNameType - the member name type

Returns:

the member name based on the specified member name type for the specified dimension that the cell represents

getMemberNames

java.util.List<java.lang.String> getMemberNames()

Returns a list of members from all dimensions that the cell represents.

Returns:

a list of members from all dimensions that the cell represents.

getMemberNames

java.util.List<java.lang.String> getMemberNames(MemberNameType memberNameType)

Returns a list of members based on the specified member name type from all dimensions that the cell represents.

Parameters:

memberNameType - member name type

Returns:

a list of members based on the specified member name type from all dimensions that the cell represents

getPeriodName

java.lang.String getPeriodName()

Returns the period name for this cell.

The returned name is based on the default member name type set for the iterator.

Returns:

the period name for this cell

getPeriodName

java.lang.String getPeriodName(MemberNameType memberNameType)

Returns the period name for this cell based on the specified member name type.

Parameters:

memberNameType - member name type

Returns:

the period name for this cell based on the specified member name type

getScenarioName

java.lang.String getScenarioName()

Returns the scenario name for this cell.

The returned name is based on the default member name type set for the iterator.

Returns:

the scenario name for this cell

getScenarioName

java.lang.String getScenarioName(MemberNameType memberNameType)

Returns the scenario name for this cell based on the specified member name type.

Parameters:

memberNameType - member name type

Returns:

the scenario name for this cell based on the specified member name type

getVersionName

java.lang.String getVersionName()

Returns the version name for this cell.

The returned name is based on the default member name type set for the iterator.

Returns:

the version name for this cell

getVersionName

java.lang.String getVersionName(MemberNameType memberNameType)

Returns the version name for this cell based on the specified member name type.

Parameters:

memberNameType - member name type

Returns:

the version name for this cell based on the specified member name type

getYearName

java.lang.String getYearName()

Returns the year name for this cell.

The returned name is based on the default member name type set for the iterator.

Returns:

the year name for this cell

getYearName

java.lang.String getYearName(MemberNameType memberNameType)

Returns the year name for this cell based on the specified member name type.

Parameters:

memberNameType - member name type

Returns:

the year name for this cell based on the specified member name type

isEdited

boolean isEdited()

Returns true if this data cell is edited.

Returns:

true if this data cell is edited

isMissing

boolean isMissing()

Returns true if this data cell value is missing.

Returns:

true if this data cell value is missing