public class Dimension extends java.lang.Object implements EssbaseCompatible
By default, parameters are case insensitive and may not be null or empty unless otherwise specified.
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object arg0) |
java.util.List<AttributeDimension> |
getAttributeDimensions()
Returns a list of attribute dimensions associated with this dimension.
|
java.util.List<AttributeDimension> |
getAttributeDimensions(boolean indexedOnly)
Returns a list of attribute dimensions associated with this dimension.
|
int |
getDeepestGeneration()
Returns the deepest generation for this dimension.
|
int |
getDensity(Cube cube)
Returns the density for this dimension in the specified cube.
|
java.lang.String |
getDescription()
Returns the description for this dimension.
|
java.util.List<Member> |
getEvalatedMembers(java.lang.String membersString,
Cube cube)
Deprecated.
|
java.util.List<Member> |
getEvaluatedMembers(java.lang.String membersString,
Cube cube)
Returns a list of members by evaluating the functions, expressions and/or
members specified in the membersString against the specified cube.
|
java.lang.String |
getFixValue()
Returns a value that can be used in a FIX statement.
|
int |
getId() |
Member |
getMember(java.lang.Object memberRef,
Cube... cubes)
Returns a member with the specified name.
|
java.util.List<Member> |
getMembersWithUda(java.lang.String uda,
boolean includeIndirectSharedMembers,
Cube... cubes)
Returns a list of all the members that have been tagged with the
specified user defined attribute.
|
java.util.List<Member> |
getMembersWithUdaInEssbase(java.lang.String uda,
Cube cube)
Returns a list of members in the specified cube that have been tagged
with the specified user defined attribute.
|
java.lang.String |
getName()
Returns the name of this dimension or the unique name if needed.
|
java.lang.String |
getName(MemberNameType memberNameType)
Returns the dimension name of this dimension based on the specified
member name type.
|
Member |
getRootMember(Cube... cubes)
Returns the root member for this dimension.
|
oracle.epm.api.model.DimensionType |
getType()
Returns the type of this dimension.
|
java.util.List<java.lang.String> |
getUdas()
Returns a list of all user defined attributes for this dimension.
|
UserVariable |
getUserVariable(java.lang.String name)
Returns a user variable with the specified name for this dimension.
|
java.util.List<UserVariable> |
getUserVariables()
Returns the list of user variables for this application.
|
int |
hashCode() |
boolean |
hasMember(java.lang.Object memberRef,
Cube... cubes)
Returns true if the specified member exists.
|
boolean |
hasUda(java.lang.String udaValue)
Returns true if a user defined attribute with the specified value exists
for this dimension.
|
boolean |
hasUserVariable(java.lang.String name)
Returns true if the specified user variable exists for this dimension.
|
boolean |
isAttributeDimension()
Return true if dimension is an attribute dimension, false otherwise.
|
Member |
saveMember(java.util.Map<java.lang.String,java.lang.Object> memberMap)
Returns the new or updated member that was saved with the specified
properties.
|
Member |
saveMember(java.util.Map<java.lang.String,java.lang.Object> memberMap,
DynamicChildStrategy strategy)
Returns the new or updated member that was saved with the specified
properties.
|
java.lang.String |
toString()
Returns a string representation of the object.
|
public java.util.List<AttributeDimension> getAttributeDimensions()
public java.util.List<AttributeDimension> getAttributeDimensions(boolean indexedOnly)
indexedOnly
- true to only return indexed attribute dimensions
false, to return all attribute dimensions.public int getDeepestGeneration()
public int getDensity(Cube cube)
A 0 is returned if the dimension is dense and 1 if it is sparse.
This property is only relevant to BSO cubes.
cube
- the cube to retrieve densitypublic java.lang.String getDescription()
@Deprecated public java.util.List<Member> getEvalatedMembers(java.lang.String membersString, Cube cube) throws java.lang.Exception
This method has been deprecated and replaced by
getEvaluatedMembers(java.lang.String, oracle.epm.api.model.Cube)
membersString
- a member
selection stringcube
- cube for which member is validjava.lang.Exception
- if an unexpected fault occurspublic java.util.List<Member> getEvaluatedMembers(java.lang.String membersString, Cube cube) throws java.lang.Exception
membersString
- a member
selection stringcube
- cube for which member is validjava.lang.Exception
- if an unexpected fault occurspublic java.lang.String getFixValue()
getFixValue
in interface EssbaseCompatible
public int getId()
public Member getMember(java.lang.Object memberRef, Cube... cubes)
If one or more cubes are specified, then the result contains only the objects that are valid for at least one of the specified cubes.
memberRef
- an object representing a reference to a member
(see section Member References)cubes
- an optional array of cubespublic java.util.List<Member> getMembersWithUda(java.lang.String uda, boolean includeIndirectSharedMembers, Cube... cubes)
If one or more cubes are specified, then the result contains only the objects that are valid for at least one of the specified cubes.
This method runs against the logical model. To query directly against
the underlying OLAP system, see getMembersWithUdaInEssbase(java.lang.String, oracle.epm.api.model.Cube)
.
In most cases, querying against the logical model will perform better and give more up to date answers. It also allows the caller to control which type of name is returned.
uda
- User defined attributeincludeIndirectSharedMembers
- true to include shared members when a
base member has the specified UDA or false to return only the basecubes
- an optional array of cubespublic java.util.List<Member> getMembersWithUdaInEssbase(java.lang.String uda, Cube cube)
This method runs against the physical olap model. To query against the
logical model, see getMembersWithUda(java.lang.String, boolean, oracle.epm.api.model.Cube...)
.
In most cases, querying against the logical model performs better and gives more up to date answers. It also allows the caller to control which type of name is returned.
uda
- user defined attributecube
- cube for which member is validpublic java.lang.String getName()
public java.lang.String getName(MemberNameType memberNameType)
If memberNameType is not specified, the default is MEMBER_NAME.
memberNameType
- a member name type, or null for the defaultpublic Member getRootMember(Cube... cubes)
cubes
- an optional array of cubespublic oracle.epm.api.model.DimensionType getType()
public java.util.List<java.lang.String> getUdas()
public UserVariable getUserVariable(java.lang.String name)
name
- the name of the user variablepublic java.util.List<UserVariable> getUserVariables()
public boolean hasMember(java.lang.Object memberRef, Cube... cubes)
If one or more cubes are specified, then the result contains only the objects that are valid for at least one of the specified cubes.
memberRef
- an object representing a reference to a member
(see section Member References)cubes
- an optional array of cubespublic boolean hasUda(java.lang.String udaValue)
udaValue
- user defined attribute valuepublic boolean hasUserVariable(java.lang.String name)
name
- the name of the user variablepublic boolean isAttributeDimension()
public Member saveMember(java.util.Map<java.lang.String,java.lang.Object> memberMap) throws java.lang.Exception
For properties, see section Member Properties.
This method runs against the logical model. To ensure that the users see consistent data, a database refresh is recommended after running a script that calls this method to synchronize the physical olap model with the logical model.
Users with administrative privileges can call this method to create, update or delete a member with the specified properties.
Users with non administrative privileges can call this method to either create dynamic members or to update any member they have access to with a limited set of properties such as name and aliases.
memberMap
- map with member propertiesjava.lang.Exception
- if an error occurspublic Member saveMember(java.util.Map<java.lang.String,java.lang.Object> memberMap, DynamicChildStrategy strategy) throws java.lang.Exception
The specified strategy is used when saving the member.
For properties, see section Member Properties.
This method runs against the logical model. To ensure that the users see consistent data, a database refresh is recommended after running a script that calls this method to synchronize the physical olap model with the logical model.
Users with administrative privileges can call this method to create, update or delete a member with the specified properties.
Users with non administrative privileges can call this method to either create dynamic members or to update any member they have access to with a limited set of properties such as name and aliases.
memberMap
- map with member propertiesstrategy
- the strategy to use when saving a dynamic member.java.lang.Exception
- if an error occurspublic java.lang.String toString()
toString
in class java.lang.Object
public boolean equals(java.lang.Object arg0)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
Copyright © 2017, 2024, Oracle and/or its affiliates. All rights reserved.