Skip navigation links


com.essbase.eas.essbase.defs.outline
Interface Member

All Known Subinterfaces:
AccessibleMember
All Known Implementing Classes:
DefaultASOMember, DefaultMember, DefaultViewMember

public interface Member

defines the properties for an outline member.

The hybrid analysis fields are only available in Essbase 6.5.0 and later; the hasHADescendants field cannot be updated by any outline editor.

There are six methods relating to availability of formuals, UDAs, and aliases that were added during the 7.0.0 release. These are used primarily by the Hyperion-provided classes DefaultMember and other classes used by the Essbase Administration Services outline editor, outline viewer, and other outline related tools.

Since:
6.5.1
Version:
7.0.0
Author:
Hank Cox

Field Summary
static short DIMENSION_GENERATION
          indicates the generation number of dimension members.
static Member[] EMPTY
           
static short GENERATION_MINIMUM
          minimum value that a generation can have.
static short HIERARCHY_GENERATION
           
static short LEVEL_MINIMUM
          minimum value that a level can normally have.
static short MAXLEN_COMMENT
          maximum length of a comment, expressed in bytes, not characters.
static short MAXLEN_MEMBER_NAME
          maximum length of a member name, expressed in bytes, not characters

 

Method Summary
 void addMemberAttribute(java.lang.String dimension, java.lang.String value, long handle)
          adds a single member attribute mapping for this member.
 void addMemberAttributes(MemberAttribute[] values)
          adds the mapped attributes for this member.
 void addMemberListener(MemberListener l)
          adds the requested listener to events on this object
 void addUDA(java.lang.String value)
          adds a single UDA for this member.
 void changeMemberAttribute(java.lang.String dimension, java.lang.String value, long handle)
          modifies a single member attribute mapping for this member.
 void childrenSorted()
          this method is used for nothing but to fire events when the children of a member have been sorted.
 void clear()
          clears the data fields; ensures that this member object can be used in a caching situation by restoring values to their defaults.
 void fireGenericEvent(MemberEvent e)
          fires a generic member event.
 java.lang.String generateMemberHashKey()
          Returns a member hash key unique to the member
 MemberAlias getAlias(java.lang.String table)
          gets a specific alias table assignment.
 MemberAlias[] getAliases()
          gets the alias table mappings for this member.
 boolean getAlternateHierarchyEnabled()
           
 AttributeType getAttributeType()
          gets this member's attribute type.
 java.lang.String getBaseDimension()
           
 long getChildCount()
          gets this member's child count.
 java.lang.String getCombinedName()
          Return the combined name for a non unique member
 java.lang.String getComment()
          gets this member's comment.
 Consolidation getConsolidation()
          retrieves the member's consolidation type.
 CurrencyConversion getCurrencyConversionType()
          return's this member's currency conversion type.
 java.lang.String getCurrencyMember()
          gets this member's currency category.
 DimensionCategory getDimensionCategory()
          gets this member's dimension category.
 long getDimensionHandle()
          retrieves the handle of the dimension for this member.
 boolean getDimensionMemberNamesUnique()
          this method can be called to determine if the members are unique within a dimension
 java.lang.String getDimensionName()
          retrieves the dimension name for this member.
 SolveOrder getDimensionSolveOrder()
           
 DimensionStorageType getDimensionStorageType()
          gets this member's dimension storage type.
 java.lang.String getExtendedShareMember()
          Get the extended share for this member
 java.lang.String getFormula()
          retrieves the formula for this member.
 short getGeneration()
          gets the generation for this member.
 long getHandle()
          retrieves the handle for this member.
 boolean getHasHybridDescendants()
          indicates the member has hybrid analysis children; returns true if so, false otherwise.
 HierarchyType getHierarchyType()
           
 boolean getHoldEventFiring()
          retrieves whether or not this member will fire events.
 short getLevel()
          gets the level for this member.
 LevelWeight getLevelWeight()
           
 MemberAttribute[] getMemberAttributes()
          gets the mapped attributes for this member.
 MemberContext getMemberContext()
          gets the member context which helps identify a member uniquely.
 java.lang.Object getMemberFormatString()
          Gets the format string for a member
 SolveOrder getMemberSolveOrder()
           
 java.lang.String getName()
          retrieves the name of this member.
 java.lang.Object getOutlineTreeNode()
           
 Share getShare()
          gets this member's share option.
 java.lang.Object getSmartListObject()
          Returns the Smartlist Object associated with the member
 TimeBalance getTimeBalanceOption()
          gets this member's time balance option.
 TimeBalanceSkip getTimeBalanceSkipOption()
          gets this member's time balance skip option.
 java.lang.Object getType()
          Returns the type of member to be Numeric/Date/Text
 java.lang.String[] getUDAs()
          gets the UDAs for this member.
 boolean isAccountsDimension()
          this method can be called to determine if the member is an accounts dimension.
 boolean isAliasAvailable()
          indicates whether alias definitions are available for this member.
 boolean isAttributeCalculationDimension()
          this method can be called to determine if the member is an attribute calculations dimension.
 boolean isAttributed()
          retrieves the field that tells whether this member has attributes.
 boolean isAttributeDimension()
          this method can be called to determine if the member is an attribute dimension.
 boolean isCompressionDimension()
          return's whether this member is a compression dimension.
 boolean isCountryDimension()
          this method can be called to determine if the member is a country dimension.
 boolean isCutCopyMember()
          return's whether this member is a cut/copied member.
 boolean isDimension()
          this method can be called to determine if the member is a dimension.
 boolean isExpenseMember()
          return's whether this member is an expense member.
 boolean isFlowMetricMember()
          return's whether this member is an flow metric member.
 boolean isFormulaAvailable()
          indicates whether a formula is available for this member.
 boolean isHybridAnalysisEnabled()
          indicates whether a dimension has hybrid analysis enabled or disabled.
 boolean isIndependentDimension()
          Returns true if a dimension is marked as an independent dimension
 boolean isLinkedAttributeDimension()
          this method can be called to determine if the member is a linked attribute dimension.
 boolean isModified()
          retrieves the field that tells whether this member has modified
 boolean isNonUnique()
           
 boolean isTimeDateDimension()
          this method can be called to determine if the member is a time dimension created using 'Create Time Dimension' wizard
 boolean isTimeDimension()
          this method can be called to determine if the member is a time dimension.
 boolean isTwoPassCalculation()
          return's whether this member is set for two pass calculation.
 boolean isUDAAvailable()
          indicates whether UDAs are available for this member.
 void removeAlias(java.lang.String table)
          removes an alias assignment.
 void removeMemberAttribute(java.lang.String dimension)
          removes a single member attribute mapping for this member.
 void removeMemberAttribute(VaryingMemberAttribute varAttr)
          removes a varying member attribute mapping for this member.
 void removeMemberListener(MemberListener l)
          removes the requested listener from events on this object.
 void removeUDA(java.lang.String value, boolean isCaseSensitive)
          removes a single UDA for this member.
 void renameAliasTable(java.lang.String origName, java.lang.String newName)
          renames an alias table.
 void setAlias(java.lang.String table, java.lang.String value)
          adds/updates an alias table mapping for this member.
 void setAliasAvailable(boolean value)
          updates whether alias definitions are available for this member.
 void setAliases(MemberAlias[] values)
          sets the alias table mappings for this member.
 void setAlternateHierarchyEnabled(boolean enabled)
           
 void setAttributed(boolean value)
          sets whether this member has attributes.
 void setAttributeType(AttributeType value)
          sets this member's attribute type.
 void setAttributeType(short value)
          sets this member's attribute type.
 void setBaseDimension(java.lang.String baseDimensionValue)
           
 void setChildCount(long value)
          sets this member's child count.
 void setCombinedName(java.lang.String name)
          Set the combined name for a non unique member
 void setComment(java.lang.String value)
          sets this member's comment.
 void setCompressionDimension(boolean value)
          set's this dimension's compression property.
 void setConsolidation(Consolidation value)
          sets the member's consolidation type.
 void setConsolidation(short value)
          sets the member's consolidation type.
 void setCurrencyConversionType(CurrencyConversion value)
          set's the member's currency conversion type.
 void setCurrencyConversionType(short value)
          set's the member's currency conversion type.
 void setCurrencyMember(java.lang.String value)
          sets this member's currency category.
 void setCutCopyMember(boolean value)
          set's this member's cut/copied property.
 void setDimensionCategory(DimensionCategory value)
          sets this member's dimension category.
 void setDimensionCategory(short value)
          sets this member's dimension category.
 void setDimensionHandle(long value)
          sets the handle of the dimension for this member.
 void setDimensionMemberNamesUnique(boolean value)
           
 void setDimensionName(java.lang.String value)
          sets the dimension name for this member.
 void setDimensionSolveOrder(short solveOrder)
           
 void setDimensionStorageType(DimensionStorageType value)
          sets this member's dimension storage type.
 void setDimensionStorageType(short value)
          sets this member's dimension storage type.
 void setExpenseMember(boolean value)
          set's this member's expense property.
 void setExtendedShareMember(java.lang.String memberName)
          Set the extended share member for this member
 void setFlowMetricMember(boolean value)
          set's this member's flow metric property.
 void setFormula(java.lang.String value)
          sets the formula for this member.
 void setFormulaAvailable(boolean value)
          updates whether a formula is availabe for this member.
 void setGeneration(short value)
          sets the generation for this member.
 void setHandle(long value)
          sets the handle for this member.
 void setHasHybridDescendants(boolean value)
          changes the has hybrid descendants setting for a member; this should never be set by the user interface.
 void setHierarchyType(HierarchyType hierarchyValue)
           
 void setHierarchyType(short hierarchyValue)
           
 void setHoldEventFiring(boolean value)
          enables/disables the firing of events.
 void setHoldExceptions(boolean value)
          sets a value that prohibits the throwing of exceptions when attempting to update properties.
 void setHybridAnalysisEnabled(boolean value)
          changes the hybrid analysis enabled field.
 void setIndependentDimension(boolean isIndependent)
          Sets/Resets a dimension as independent
 void setLevel(short value)
          sets the level for this member.
 void setLevelWeight(LevelWeight levelValue)
           
 void setLevelWeight(short levelValue)
           
 void setMemberAttributes(MemberAttribute[] values)
          sets the mapped attributes for this member.
 void setMemberContext(MemberContext context)
          sets the member context which helps identify a member uniquely.
 void setMemberFormatString(java.lang.Object format)
          Sets the format string for a member
 void setMemberSolveOrder(short solveOrder)
           
 void setModified(boolean value)
          sets whether this member has modified.
 void setName(java.lang.String value)
          sets this member's name.
 void setNonUnique(boolean b)
          Set the non unique status for the member
 void setOutlineTreeNode(java.lang.Object o)
           
 void setShare(Share value)
          sets this member's share option.
 void setShare(short value)
          sets this member's share option.
 void setSmartListObject(java.lang.Object type)
          Sets the Smartlist Object associated with the member
 void setTimeBalanceOption(short value)
          sets this member's time balance option.
 void setTimeBalanceOption(TimeBalance value)
          sets this member's time balance option.
 void setTimeBalanceSkipOption(short value)
          sets this member's time balance skip option.
 void setTimeBalanceSkipOption(TimeBalanceSkip value)
          sets this member's time balance skip option.
 void setTwoPassCalculation(boolean value)
          set's this member's two pass calculation property.
 void setType(java.lang.Object type)
          Sets the type of member to be Numeric/Date/Text
 void setUDAAvailable(boolean value)
          updates whether UDAs are available for this member.
 void setUDAs(java.lang.String[] values)
          sets the UDAs for this member.
 void updateFrom(Member m)
          updates the member's properties in a "batch" process.

 

Field Detail

EMPTY

static final Member[] EMPTY

MAXLEN_MEMBER_NAME

static final short MAXLEN_MEMBER_NAME
maximum length of a member name, expressed in bytes, not characters
See Also:
Constant Field Values

MAXLEN_COMMENT

static final short MAXLEN_COMMENT
maximum length of a comment, expressed in bytes, not characters.
See Also:
Constant Field Values

LEVEL_MINIMUM

static final short LEVEL_MINIMUM
minimum value that a level can normally have.
See Also:
Constant Field Values

GENERATION_MINIMUM

static final short GENERATION_MINIMUM
minimum value that a generation can have.
See Also:
Constant Field Values

DIMENSION_GENERATION

static final short DIMENSION_GENERATION
indicates the generation number of dimension members.
See Also:
Constant Field Values

HIERARCHY_GENERATION

static final short HIERARCHY_GENERATION
See Also:
Constant Field Values

Method Detail

addMemberListener

void addMemberListener(MemberListener l)
adds the requested listener to events on this object

removeMemberListener

void removeMemberListener(MemberListener l)
removes the requested listener from events on this object.

getName

java.lang.String getName()
retrieves the name of this member.

setName

void setName(java.lang.String value)
             throws MemberNameException
sets this member's name.
Throws:
MemberNameException

getHandle

long getHandle()
retrieves the handle for this member. This handle is analogous to the C API member handle. It might be better to implement this as an object but wanted to save the object creation.

setHandle

void setHandle(long value)
sets the handle for this member.

getLevel

short getLevel()
gets the level for this member. The level property is normally only valid when set while retrieving from the Essbase server. During manipulation by editors, this property can become dated.

setLevel

void setLevel(short value)
              throws InvalidLevelException
sets the level for this member. Normally, this would only be done when retrieving the member information from the Essbase server; however, editors are free to maintain the value of this property if they need to. Valid values are in the range { 0..n }.
Throws:
InvalidLevelException

getGeneration

short getGeneration()
gets the generation for this member. The generation property is normally only valid when set while retrieving from the Essbase server. During manipulation by editors, this property can become dated.

setGeneration

void setGeneration(short value)
                   throws InvalidGenerationException
sets the generation for this member. Normally, this would only be done when retrieving the member information from the Essbase server; however, editors are free to maintain the value of this property if they need to. Valid values are in the range { 1..n }.
Throws:
InvalidGenerationException

getConsolidation

Consolidation getConsolidation()
retrieves the member's consolidation type.

setConsolidation

void setConsolidation(Consolidation value)
sets the member's consolidation type.

setConsolidation

void setConsolidation(short value)
sets the member's consolidation type.

isTwoPassCalculation

boolean isTwoPassCalculation()
return's whether this member is set for two pass calculation.

setTwoPassCalculation

void setTwoPassCalculation(boolean value)
set's this member's two pass calculation property.

isExpenseMember

boolean isExpenseMember()
return's whether this member is an expense member.

setExpenseMember

void setExpenseMember(boolean value)
set's this member's expense property.

isCutCopyMember

boolean isCutCopyMember()
return's whether this member is a cut/copied member.

setCutCopyMember

void setCutCopyMember(boolean value)
set's this member's cut/copied property.

getCurrencyConversionType

CurrencyConversion getCurrencyConversionType()
return's this member's currency conversion type.

setCurrencyConversionType

void setCurrencyConversionType(CurrencyConversion value)
set's the member's currency conversion type.

setCurrencyConversionType

void setCurrencyConversionType(short value)
set's the member's currency conversion type.

getCurrencyMember

java.lang.String getCurrencyMember()
gets this member's currency category. This field is only relevant if the member is in the "Country" dimension.

setCurrencyMember

void setCurrencyMember(java.lang.String value)
                       throws CurrencyMemberException
sets this member's currency category.
Throws:
CurrencyMemberException

getTimeBalanceOption

TimeBalance getTimeBalanceOption()
gets this member's time balance option. This is valid only for members of an "Accounts" dimension.

setTimeBalanceOption

void setTimeBalanceOption(TimeBalance value)
sets this member's time balance option.

setTimeBalanceOption

void setTimeBalanceOption(short value)
sets this member's time balance option.

getTimeBalanceSkipOption

TimeBalanceSkip getTimeBalanceSkipOption()
gets this member's time balance skip option. This is valid only for members of an "Accounts" dimension.

setTimeBalanceSkipOption

void setTimeBalanceSkipOption(TimeBalanceSkip value)
sets this member's time balance skip option.

setTimeBalanceSkipOption

void setTimeBalanceSkipOption(short value)
sets this member's time balance skip option.

isFlowMetricMember

boolean isFlowMetricMember()
return's whether this member is an flow metric member.

setFlowMetricMember

void setFlowMetricMember(boolean value)
set's this member's flow metric property.

getShare

Share getShare()
gets this member's share option.

setShare

void setShare(Share value)
sets this member's share option.

setShare

void setShare(short value)
sets this member's share option.

getDimensionStorageType

DimensionStorageType getDimensionStorageType()
gets this member's dimension storage type.

setDimensionStorageType

void setDimensionStorageType(DimensionStorageType value)
sets this member's dimension storage type.

setDimensionStorageType

void setDimensionStorageType(short value)
sets this member's dimension storage type.

getDimensionCategory

DimensionCategory getDimensionCategory()
gets this member's dimension category. This property is valid only for dimensions and attribute members.

setDimensionCategory

void setDimensionCategory(DimensionCategory value)
sets this member's dimension category.

setDimensionCategory

void setDimensionCategory(short value)
sets this member's dimension category.

getComment

java.lang.String getComment()
gets this member's comment.

setComment

void setComment(java.lang.String value)
                throws CommentException
sets this member's comment.
Throws:
CommentException

getChildCount

long getChildCount()
gets this member's child count. For the most part, this is set when interfacing to the native Essbase APIs. User interface components (such as editors) are free to update it for display purposes.

setChildCount

void setChildCount(long value)
sets this member's child count.

getAttributeType

AttributeType getAttributeType()
gets this member's attribute type. Used only for attribute dimensions and members.

setAttributeType

void setAttributeType(AttributeType value)
sets this member's attribute type.

setAttributeType

void setAttributeType(short value)
sets this member's attribute type.

setHoldExceptions

void setHoldExceptions(boolean value)
sets a value that prohibits the throwing of exceptions when attempting to update properties. This would normally be called by the JNI layer since presumably values coming from there would bo Ok; if this property is set to true, then the set methods should take an appropriate action.

getFormula

java.lang.String getFormula()
retrieves the formula for this member.

setFormula

void setFormula(java.lang.String value)
sets the formula for this member.

getDimensionName

java.lang.String getDimensionName()
retrieves the dimension name for this member.

setDimensionName

void setDimensionName(java.lang.String value)
sets the dimension name for this member.

getDimensionHandle

long getDimensionHandle()
retrieves the handle of the dimension for this member. This will only work with outline editor objects and APIS, not with viewing tools.

setDimensionHandle

void setDimensionHandle(long value)
sets the handle of the dimension for this member. This will only work with outline editor tools, not with viewing tools.

isAttributed

boolean isAttributed()
retrieves the field that tells whether this member has attributes.

setAttributed

void setAttributed(boolean value)
sets whether this member has attributes.

isModified

boolean isModified()
retrieves the field that tells whether this member has modified

setModified

void setModified(boolean value)
sets whether this member has modified.

getMemberAttributes

MemberAttribute[] getMemberAttributes()
gets the mapped attributes for this member.

setMemberAttributes

void setMemberAttributes(MemberAttribute[] values)
sets the mapped attributes for this member.

addMemberAttributes

void addMemberAttributes(MemberAttribute[] values)
adds the mapped attributes for this member.

addMemberAttribute

void addMemberAttribute(java.lang.String dimension,
                        java.lang.String value,
                        long handle)
adds a single member attribute mapping for this member.

removeMemberAttribute

void removeMemberAttribute(java.lang.String dimension)
removes a single member attribute mapping for this member.

removeMemberAttribute

void removeMemberAttribute(VaryingMemberAttribute varAttr)
removes a varying member attribute mapping for this member.

changeMemberAttribute

void changeMemberAttribute(java.lang.String dimension,
                           java.lang.String value,
                           long handle)
modifies a single member attribute mapping for this member.

getUDAs

java.lang.String[] getUDAs()
gets the UDAs for this member.

setUDAs

void setUDAs(java.lang.String[] values)
sets the UDAs for this member.

addUDA

void addUDA(java.lang.String value)
adds a single UDA for this member.

removeUDA

void removeUDA(java.lang.String value,
               boolean isCaseSensitive)
removes a single UDA for this member.

getAliases

MemberAlias[] getAliases()
gets the alias table mappings for this member.

setAliases

void setAliases(MemberAlias[] values)
sets the alias table mappings for this member.

setAlias

void setAlias(java.lang.String table,
              java.lang.String value)
adds/updates an alias table mapping for this member.

removeAlias

void removeAlias(java.lang.String table)
                 throws AliasTableException
removes an alias assignment. If the alias table doesn't exist in this member's mappings an AliasTableException is thrown.
Throws:
AliasTableException

renameAliasTable

void renameAliasTable(java.lang.String origName,
                      java.lang.String newName)
renames an alias table.

getAlias

MemberAlias getAlias(java.lang.String table)
                     throws AliasTableException
gets a specific alias table assignment. If the alias table doesn't exist in this member's, an AliasTableException is thrown.
Throws:
AliasTableException

isDimension

boolean isDimension()
this method can be called to determine if the member is a dimension.

isAccountsDimension

boolean isAccountsDimension()
this method can be called to determine if the member is an accounts dimension.

isCountryDimension

boolean isCountryDimension()
this method can be called to determine if the member is a country dimension.

isAttributeDimension

boolean isAttributeDimension()
this method can be called to determine if the member is an attribute dimension.

isAttributeCalculationDimension

boolean isAttributeCalculationDimension()
this method can be called to determine if the member is an attribute calculations dimension.

isTimeDimension

boolean isTimeDimension()
this method can be called to determine if the member is a time dimension.

isTimeDateDimension

boolean isTimeDateDimension()
this method can be called to determine if the member is a time dimension created using 'Create Time Dimension' wizard

isLinkedAttributeDimension

boolean isLinkedAttributeDimension()
this method can be called to determine if the member is a linked attribute dimension.

getDimensionMemberNamesUnique

boolean getDimensionMemberNamesUnique()
this method can be called to determine if the members are unique within a dimension

setDimensionMemberNamesUnique

void setDimensionMemberNamesUnique(boolean value)
Parameters:
value -

childrenSorted

void childrenSorted()
this method is used for nothing but to fire events when the children of a member have been sorted.

getHasHybridDescendants

boolean getHasHybridDescendants()
indicates the member has hybrid analysis children; returns true if so, false otherwise.

setHasHybridDescendants

void setHasHybridDescendants(boolean value)
changes the has hybrid descendants setting for a member; this should never be set by the user interface.

isHybridAnalysisEnabled

boolean isHybridAnalysisEnabled()
indicates whether a dimension has hybrid analysis enabled or disabled.

setHybridAnalysisEnabled

void setHybridAnalysisEnabled(boolean value)
changes the hybrid analysis enabled field.

isFormulaAvailable

boolean isFormulaAvailable()
indicates whether a formula is available for this member. The semantics are defined by the class implementing this interface.

setFormulaAvailable

void setFormulaAvailable(boolean value)
updates whether a formula is availabe for this member. The semantics are defined by the class implementing this interface.

isUDAAvailable

boolean isUDAAvailable()
indicates whether UDAs are available for this member. The semantics are defined by the class implementing this interface.

setUDAAvailable

void setUDAAvailable(boolean value)
updates whether UDAs are available for this member. The semantics are defined by the class implementing this interface.

isAliasAvailable

boolean isAliasAvailable()
indicates whether alias definitions are available for this member. The semantics are defined by the class implementing this interface.

setAliasAvailable

void setAliasAvailable(boolean value)
updates whether alias definitions are available for this member. The semantics are defined by the class implementing this interface.

updateFrom

void updateFrom(Member m)
updates the member's properties in a "batch" process. This changes all members and sends out one generic event at the end stating that all properties may have been changed.
Parameters:
m - - the source member to use for updating.

fireGenericEvent

void fireGenericEvent(MemberEvent e)
fires a generic member event. This is public and should only be used in places where information/settings outside the member itself can have an impact on the display/behavior of the member. For example: DTS definitions are changed in an editor and the display of the time dimension member needs to be updated.

clear

void clear()
clears the data fields; ensures that this member object can be used in a caching situation by restoring values to their defaults.

setMemberContext

void setMemberContext(MemberContext context)
sets the member context which helps identify a member uniquely.

getMemberContext

MemberContext getMemberContext()
gets the member context which helps identify a member uniquely.

setDimensionSolveOrder

void setDimensionSolveOrder(short solveOrder)
Parameters:
solveOrder -

getDimensionSolveOrder

SolveOrder getDimensionSolveOrder()
Returns:

setMemberSolveOrder

void setMemberSolveOrder(short solveOrder)
Parameters:
solveOrder -

getMemberSolveOrder

SolveOrder getMemberSolveOrder()
Returns:

setAlternateHierarchyEnabled

void setAlternateHierarchyEnabled(boolean enabled)
Parameters:
enabled -

getAlternateHierarchyEnabled

boolean getAlternateHierarchyEnabled()
Returns:

setHierarchyType

void setHierarchyType(short hierarchyValue)
Parameters:
hierarchyValue -

setHierarchyType

void setHierarchyType(HierarchyType hierarchyValue)
Parameters:
hierarchyValue -

setLevelWeight

void setLevelWeight(short levelValue)

setLevelWeight

void setLevelWeight(LevelWeight levelValue)

isCompressionDimension

boolean isCompressionDimension()
return's whether this member is a compression dimension.

setCompressionDimension

void setCompressionDimension(boolean value)
set's this dimension's compression property.

getHierarchyType

HierarchyType getHierarchyType()
Returns:

getLevelWeight

LevelWeight getLevelWeight()

setBaseDimension

void setBaseDimension(java.lang.String baseDimensionValue)
Parameters:
baseDimensionValue -

getBaseDimension

java.lang.String getBaseDimension()
Returns:

setNonUnique

void setNonUnique(boolean b)
Set the non unique status for the member
Parameters:
b -

isNonUnique

boolean isNonUnique()
Returns:
true if the member is non unique

getCombinedName

java.lang.String getCombinedName()
Return the combined name for a non unique member
Returns:

setCombinedName

void setCombinedName(java.lang.String name)
Set the combined name for a non unique member
Parameters:
name -

setHoldEventFiring

void setHoldEventFiring(boolean value)
enables/disables the firing of events. This should only be used in very specific circumstances.

getHoldEventFiring

boolean getHoldEventFiring()
retrieves whether or not this member will fire events.

generateMemberHashKey

java.lang.String generateMemberHashKey()
Returns a member hash key unique to the member
Returns:
key

getOutlineTreeNode

java.lang.Object getOutlineTreeNode()

setOutlineTreeNode

void setOutlineTreeNode(java.lang.Object o)

setExtendedShareMember

void setExtendedShareMember(java.lang.String memberName)
Set the extended share member for this member
Parameters:
memberName -

getExtendedShareMember

java.lang.String getExtendedShareMember()
Get the extended share for this member
Returns:
the String original member name

isIndependentDimension

boolean isIndependentDimension()
Returns true if a dimension is marked as an independent dimension

setIndependentDimension

void setIndependentDimension(boolean isIndependent)
Sets/Resets a dimension as independent

setType

void setType(java.lang.Object type)
Sets the type of member to be Numeric/Date/Text

getType

java.lang.Object getType()
Returns the type of member to be Numeric/Date/Text

setSmartListObject

void setSmartListObject(java.lang.Object type)
Sets the Smartlist Object associated with the member

getSmartListObject

java.lang.Object getSmartListObject()
Returns the Smartlist Object associated with the member

setMemberFormatString

void setMemberFormatString(java.lang.Object format)
Sets the format string for a member

getMemberFormatString

java.lang.Object getMemberFormatString()
Gets the format string for a member

Skip navigation links


Copyright © 2001, 2012, Oracle. All rights reserved.