public class Member 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 |
---|---|
Member |
addDynamicChild(java.lang.Object memberRef)
Returns the new child member that was created and saved with the
specified name if this member was enabled for dynamic children.
|
void |
delete()
Deletes this member and all descendants of this member from the Planning
application outline.
|
void |
deleteDynamicMember()
Deletes this member and all descendants of this member from the Planning
application outline if the parent was enabled for dynamic children.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getAlias(java.lang.String tableName)
Returns the alias for this member from the specified alias table or null
if it does not have one.
|
java.util.Map<java.lang.String,java.lang.String> |
getAliases()
Returns a mapping of alias table names and the aliases set for this
member.
|
AttributeMember |
getAttributeValue(AttributeDimension attribDimension)
Returns either the attribute member in the specified attribute dimension
associated with this member or null.
|
java.util.List<Member> |
getBaseAndSharedMembers(Cube... cubes)
Returns a list of the base and shared members that are shared with this
member.
|
Member |
getChild(java.lang.Object memberRef)
Returns the child member with the specified name of this member.
|
DataType |
getDataType()
Returns the data type for this member.
|
java.lang.String |
getDescription()
Returns the description for this member.
|
Dimension |
getDimension()
Returns the dimension this member belongs to.
|
java.lang.String |
getFixValue()
Returns a value that can be used in a FIX statement.
|
int |
getId() |
java.lang.String |
getName()
Returns the name of this member or the unique name if needed.
|
java.lang.String |
getName(MemberNameType memberNameType)
Returns the member name of this member based on the specified
member name type.
|
java.util.Set<java.lang.String> |
getNames(MemberNameType... memberNameTypes) |
java.util.List<Member> |
getSharedMembers(Cube... cubes)
Returns a list of the shared members that are shared with this member.
|
SmartList |
getSmartList()
Returns the smart list associated with this member.
|
java.util.List<java.lang.String> |
getUdas()
Returns a list of all user defined attributes for this member.
|
java.lang.String |
getUniqueAliasOrMemberName(java.lang.String tableName)
Returns a unique alias name for this member from the specified alias
table.
|
boolean |
hasChild(java.lang.Object memberRef)
Returns true if the specified child member exists for this member.
|
int |
hashCode() |
boolean |
hasSmartList()
Returns true if there is a smartlist associated with this member.
|
boolean |
hasUda(java.lang.String udaValue)
Returns true if the specified user defined attribute exists for this
member.
|
boolean |
isDynamicMember()
Returns true if this is a dynamic member.
|
java.util.Map<java.lang.String,java.lang.Object> |
newChildAsMap(java.lang.Object memberRef)
Returns a new map of properties for a child member of this member.
|
Member |
rename(java.lang.Object memberRef)
Returns the renamed member and leaves this member instance unchanged.
|
java.util.Map<java.lang.String,java.lang.Object> |
toMap()
Returns a new map containing the properties for this member.
|
java.lang.String |
toString()
Returns a string representation of the object.
|
public Member addDynamicChild(java.lang.Object memberRef) throws com.hyperion.planning.HspDynamicChildrenExhaustedException
memberRef
- an object representing a reference to a member
(see section Member References)com.hyperion.planning.HspDynamicChildrenExhaustedException
- if no remaining dynamic
buckets under this memberjava.lang.RuntimeException
- if this member is not enabled for dynamic
childrenpublic void delete() throws java.lang.Exception
An exception is thrown if planning units have been started in the subtree.
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.
This is a privileged method, see section Privileged Method
java.lang.SecurityException
- if the current user is not permitted to delete
this memberjava.lang.Exception
- if an unexpected fault occurspublic void deleteDynamicMember() throws java.lang.Exception
java.lang.Exception
- if an unexpected fault occurspublic boolean equals(java.lang.Object obj)
obj
- public java.lang.String getAlias(java.lang.String tableName)
tableName
- alias table namepublic java.util.Map<java.lang.String,java.lang.String> getAliases()
public AttributeMember getAttributeValue(AttributeDimension attribDimension)
For example, if asked for the Color of a particular Entity, it will return Red.
Unlike other methods, this method returns null if no attribute from the specified attribute dimension is assigned to this member.
attribDimension
- attribute dimensionpublic java.util.List<Member> getBaseAndSharedMembers(Cube... cubes) throws java.lang.Exception
If one or more cubes are specified, then the result only contains the objects that are valid for at least one of the specified cubes.
cubes
- an optional array of cubesjava.lang.Exception
- if an unexpected fault occurspublic Member getChild(java.lang.Object memberRef)
memberRef
- an object representing a reference to a member
(see section Member References)public DataType getDataType()
public java.lang.String getDescription()
public Dimension getDimension()
public java.lang.String getFixValue()
getFixValue
in interface EssbaseCompatible
public int getId()
public 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 java.util.Set<java.lang.String> getNames(MemberNameType... memberNameTypes)
public java.util.List<Member> getSharedMembers(Cube... cubes) throws java.lang.Exception
If one or more cubes are specified, then the result only contains the objects that are valid for at least one of the specified cubes.
cubes
- an optional array of cubesjava.lang.Exception
- if an unexpected fault occurspublic SmartList getSmartList()
public java.util.List<java.lang.String> getUdas()
public java.lang.String getUniqueAliasOrMemberName(java.lang.String tableName)
When building the qualified name if at any time an alias does not exist for an ancestor or the intial member the member name is returned as the unique name.
tableName
- alias table namepublic boolean hasChild(java.lang.Object memberRef)
memberRef
- an object representing a reference to a member
(see section Member References)public boolean hasSmartList()
public boolean hasUda(java.lang.String udaValue)
udaValue
- user defined attribute valuepublic boolean isDynamicMember()
The member is considered dynamic if the parent for this member is enabled for dynamic children.
public java.util.Map<java.lang.String,java.lang.Object> newChildAsMap(java.lang.Object memberRef)
The values in this map can be modified before the child is added via
the Dimension.saveMember(Map member)
method and related methods.
For properties, see section Member
Properties.
Example call from Groovy to add a new employee as a dynamic child under Total Employees:
/*RTPS: {EmployeeName} */ // Get the parent employee Dimension employeeDim = operation.application.getDimension("Employee") Member parentEmployee = employeeDim.getMember("Total Employees")
// Get a map of properties for the new employee to be added Map newEmployee = parentEmployee.newChildAsMap(rtps.EmployeeName)
// Save the new employee as a dynamic child member always Member employee = employeeDim.saveMember(newEmployee, DynamicChildStrategy.ALWAYS_DYNAMIC)
memberRef
- an object representing a reference to a member
(see section Member References)public Member rename(java.lang.Object memberRef) throws java.lang.Exception
memberRef
- an object representing a reference to a member
(see section Member References)java.lang.IllegalStateException
- if the renamed member is not foundjava.lang.Exception
- if an unexpected fault occurspublic java.util.Map<java.lang.String,java.lang.Object> toMap()
For properties, see section Member Properties.
Example call from Groovy that modifies the name of an employee:
/*RTPS: {Employee} {NewName} */ Member employee = rtps.Employee.member employee = employee.dimension.saveMember(employee.toMap() << (["New Name" : rtps.NewName.enteredValue] as Map<String, Object>) )
public java.lang.String toString()
toString
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.