oracle.epm.api.model

Interface Tuple

All Superinterfaces:

java.util.Map

public interface Tuple
extends java.util.Map

This object represents a map of members from different dimensions. It is possible that this has one or many dimensions, but only a single member from each dimension will be present.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
boolean	contains(java.lang.Object memberRef) Returns true if this tuple contains a mapping with the specified member as the value.
boolean	containsEntry(java.lang.Object dimensionRef, java.lang.Object memberRef) Returns true if this tuple contains a mapping for the specified dimension.
boolean	containsKey(java.lang.Object key) Returns true if this tuple contains a mapping for the specified dimension.
boolean	containsValue(java.lang.Object value) Returns true if this tuple contains a mapping with the specified member as the value.
oracle.epm.api.model.Account	getAccount() Returns the member mappped to the Account dimension in this tuple or null.
java.lang.Object	getAt(java.lang.Object dimensionRef) Returns the member to which the specified dimension is mapped, or null if this map contains no mapping for the dimension.
oracle.epm.api.model.Currency	getCurrency() Returns the member mappped to the Currency dimension in this tuple or null.
java.util.Set<Dimension>	getDimensions() Returns a collection of dimensions this tuple has mappings for.
java.util.Collection<Member>	getMembers() Returns a collection of members that make up the values in this tuple.
oracle.epm.api.model.Period	getPeriod() Returns the member mappped to the Period dimension in this tuple or null.
oracle.epm.api.model.Year	getYear() Returns the member mappped to the Year dimension in this tuple or null.
Tuple	plus(java.util.Map map) Returns a new Tuple containing all entries from the tuple and the provided map.
java.lang.Object	putAt(java.lang.Object dimensionRef, java.lang.Object memberRef) Associates the specified member with the specified dimenison in this tuple.

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

contains

boolean contains(java.lang.Object memberRef)

Returns true if this tuple contains a mapping with the specified member as the value.

Parameters:

memberRef - an object representing a reference to a member (see section Member References)

Returns:

true if this tuple contains a mapping with the specified member as the value

containsEntry

boolean containsEntry(java.lang.Object dimensionRef,
                      java.lang.Object memberRef)

Returns true if this tuple contains a mapping for the specified dimension.

Parameters:

dimensionRef - an object representing a reference to a dimension (see section Dimension References)

memberRef - an object representing a reference to a member (see section Member References)

Returns:

true if this tuple contains a mapping for the specified dimension

containsKey

boolean containsKey(java.lang.Object key)

Returns true if this tuple contains a mapping for the specified dimension.

Specified by:

containsKey in interface java.util.Map

Parameters:

key - an object representing a reference to a dimension (see section Dimension References)

Returns:

true if this tuple contains a mapping for the specified dimension

containsValue

boolean containsValue(java.lang.Object value)

Returns true if this tuple contains a mapping with the specified member as the value.

Specified by:

containsValue in interface java.util.Map

Parameters:

value - an object representing a reference to a member (see section Member References)

Returns:

true if this tuple contains a mapping with the specified member as the value

getAccount

oracle.epm.api.model.Account getAccount()

Returns the member mappped to the Account dimension in this tuple or null.

Returns:

the member mappped to the Account dimension in this tuple or null

getAt

java.lang.Object getAt(java.lang.Object dimensionRef)

Returns the member to which the specified dimension is mapped, or null if this map contains no mapping for the dimension.

Parameters:

dimensionRef - an object representing a reference to a dimension (see section Dimension References)

Returns:

the member to which the specified dimension is mapped, or null if this map contains no mapping for the key

getCurrency

oracle.epm.api.model.Currency getCurrency()

Returns the member mappped to the Currency dimension in this tuple or null.

Returns:

the member mappped to the Currency dimension in this tuple or null

getDimensions

java.util.Set<Dimension> getDimensions()

Returns a collection of dimensions this tuple has mappings for.

Returns:

a collection of dimensions this tuple has mappings for

getMembers

java.util.Collection<Member> getMembers()

Returns a collection of members that make up the values in this tuple.

Returns:

a collection of vmembers that make up the values in this tuple

getPeriod

oracle.epm.api.model.Period getPeriod()

Returns the member mappped to the Period dimension in this tuple or null.

Returns:

the member mappped to the Period dimension in this tuple or null

getYear

oracle.epm.api.model.Year getYear()

Returns the member mappped to the Year dimension in this tuple or null.

Returns:

the member mappped to the Year dimension in this tuple or null

plus

Tuple plus(java.util.Map map)

Returns a new Tuple containing all entries from the tuple and the provided map.

Parameters:

map - m mappings to be stored in this tuple

Returns:

a new Tuple containing all entries from the tuple and the provided map

putAt

java.lang.Object putAt(java.lang.Object dimensionRef,
                       java.lang.Object memberRef)

Associates the specified member with the specified dimenison in this tuple. If the tuple previously contained a mapping for the dimension, the old member is replaced by the specified member.

Parameters:

dimensionRef - an object representing a reference to a dimension (see section Dimension References)

memberRef - an object representing a reference to a member (see section Member References)

Returns:

the previous member associated with specified dimension or null