oracle.olapi.metadata.mdm
Class MdmTimeMember

java.lang.Object
  oracle.olapi.metadata.BaseMetadataObject
      oracle.olapi.metadata.mdm.MdmObject
          oracle.olapi.metadata.mdm.MdmSource
              oracle.olapi.metadata.mdm.MdmTimeMember

All Implemented Interfaces:

MdmMember, MetadataObject

public class MdmTimeMember
extends MdmSource
implements MdmMember

An object that represents a custom member of an MdmTimeDimension. You can create a custom member of the dimension with methods of an MdmCustomObjectFactory or with the convenience methods of an MdmTimeDimension.

Method Summary

java.lang.Object	acceptVisitor(MdmObjectVisitor visitor, java.lang.Object context) Calls the visitMdmTimeMember method of the MdmObjectVisitor and passes that method the MdmTimeMember and an Object.
java.util.Date	getEndDate() Gets the end date of the time period that the MdmTimeMember represents.
MdmLevel	getLevel() Gets the MdmLevel of which the MdmTimeMember is a member.
int	getLevelDepth() Gets the depth in the hierarchy of the level of which the MdmTimeMember is a member.
java.lang.String	getLocalValue() Gets the local value of the MdmTimeMember.
MdmPrimaryDimension	getOwnerDimension() Gets the MdmPrimaryDimension of which the MdmTimeMember is a member.
MdmLevel	getParentLevel() Gets the MdmLevel of which the parent of the MdmTimeMember is a member.
java.lang.String	getParentLocalValue() Gets the local value of the parent of the MdmTimeMember.
java.lang.String	getParentValue() Gets the unique value of the parent of the MdmTimeMember.
int	getPrecedence() Gets the precedence of the MdmTimeMember.
MdmTimeDimension	getTimeDimension() Gets the MdmTimeDimension of which the MdmTimeMember is a member.
int	getTimeSpan() Gets the number of time periods that is the time span of the time period that the MdmTimeMember represents.
MetadataObject	getType() Gets the type of this MdmTimeMember, which is the type of the Source for the member.
java.lang.String	getValue() Gets the unique value of the MdmTimeMember.
MdmValueHierarchy	getValueHierarchy() Gets the MdmValueHierarchy of which the MdmTimeMember is a member.
void	setEndDate(java.util.Date endDate) Specifies an end date for the time period that the MdmTimeMember represents.
void	setLevel(MdmLevel level) Specifies the MdmLevel to which you want to add the MdmTimeMember as a member.
void	setParentLevel(MdmLevel parentLevel) Specifies an MdmLevel for the parent of the MdmTimeMember.
void	setParentLocalValue(java.lang.String parentLocal) Specifies a local value for the parent of the MdmTimeMember.
void	setPrecedence(int precedence) Specifies a precedence for the MdmTimeMember, with the higher integer value indicating a higher precedence.
void	setTimeSpan(int timeSpan) Specifies a time span for the time period that the MdmTimeMember represents.
void	setValueHierarchy(MdmValueHierarchy valueHier) Specifies the MdmValueHierarchy to which you want to add the MdmTimeMember as a member.

Methods inherited from class oracle.olapi.metadata.mdm.MdmSource

getDataType, getSource

Methods inherited from class oracle.olapi.metadata.mdm.MdmObject

addDescription, addObjectClassification, findOrCreateDescription, getDescription, getDescription, getDescription, getDescriptions, getMetadataProvider, getName, getNewName, getObjectClassifications, getShortDescription, isClassifiedAs, removeDescription, removeObjectClassification, setDescription, setDescription, setDescription, setName, setShortDescription

Methods inherited from class oracle.olapi.metadata.BaseMetadataObject

getContainedByObject, getID, getOwner

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.olapi.metadata.mdm.MdmMember

getDataType, getDescription, getShortDescription, getSource

Method Detail

acceptVisitor

public java.lang.Object acceptVisitor(MdmObjectVisitor visitor,
                                      java.lang.Object context)

Calls the visitMdmTimeMember method of the MdmObjectVisitor and passes that method the MdmTimeMember and an Object.

Specified by:

acceptVisitor in class MdmObject

Parameters:

visitor - An MdmObjectVisitor.

context - An Object.

Returns:

The Object returned by the visitMdmTimeMember method.

getEndDate

public java.util.Date getEndDate()

Gets the end date of the time period that the MdmTimeMember represents.

Returns:

A Date that represents the end date of the time period for the MdmTimeMember.

getTimeSpan

public int getTimeSpan()

Gets the number of time periods that is the time span of the time period that the MdmTimeMember represents.

Returns:

An integer that represents the time span of the time period for the MdmTimeMember.

getPrecedence

public int getPrecedence()

Gets the precedence of the MdmTimeMember.

Specified by:

getPrecedence in interface MdmMember

Returns:

An integer that specifies the precedence of the MdmTimeMember.

setPrecedence

public void setPrecedence(int precedence)

Specifies a precedence for the MdmTimeMember, with the higher integer value indicating a higher precedence.

Parameters:

precedence - An integer that specifies the precedence for the MdmTimeMember.

setEndDate

public void setEndDate(java.util.Date endDate)

Specifies an end date for the time period that the MdmTimeMember represents.

Parameters:

endDate - A Date that specifies the end date that you want the MdmTimeMember to have.

setTimeSpan

public void setTimeSpan(int timeSpan)

Specifies a time span for the time period that the MdmTimeMember represents.

Parameters:

timeSpan - An int that specifies the number of time periods that you want the time span of the MdmTimeMember to be.

getOwnerDimension

public MdmPrimaryDimension getOwnerDimension()

Gets the MdmPrimaryDimension of which the MdmTimeMember is a member.

Specified by:

getOwnerDimension in interface MdmMember

Returns:

The MdmPrimaryDimension of which the MdmTimeMember is a member.

getValue

public java.lang.String getValue()

Gets the unique value of the MdmTimeMember.

Specified by:

getValue in interface MdmMember

Returns:

A String that contains the unique value of the MdmTimeMember.

getLocalValue

public java.lang.String getLocalValue()

Gets the local value of the MdmTimeMember.

Specified by:

getLocalValue in interface MdmMember

Returns:

A String that contains the local value of the MdmTimeMember.

getLevel

public MdmLevel getLevel()

Gets the MdmLevel of which the MdmTimeMember is a member.

Specified by:

getLevel in interface MdmMember

Returns:

The MdmLevel of which the MdmTimeMember is a member.

setLevel

public void setLevel(MdmLevel level)

Specifies the MdmLevel to which you want to add the MdmTimeMember as a member.

Parameters:

level - The MdmLevel to which you want to add the MdmTimeMember as a member.

getValueHierarchy

public MdmValueHierarchy getValueHierarchy()

Gets the MdmValueHierarchy of which the MdmTimeMember is a member.

Returns:

The MdmValueHierarchy of which the MdmTimeMember is a member.

setValueHierarchy

public void setValueHierarchy(MdmValueHierarchy valueHier)

Specifies the MdmValueHierarchy to which you want to add the MdmTimeMember as a member.

Parameters:

valueHier - The MdmValueHierarchy to which you want to add the MdmTimeMember as a member.

getLevelDepth

public int getLevelDepth()

Gets the depth in the hierarchy of the level of which the MdmTimeMember is a member.

Specified by:

getLevelDepth in interface MdmMember

Returns:

An integer that identifies the depth in the hierarchy of the level of which the MdmTimeMember is a member.

getParentValue

public java.lang.String getParentValue()

Gets the unique value of the parent of the MdmTimeMember.

Specified by:

getParentValue in interface MdmMember

Returns:

A String that contains the unique value of the parent of the MdmTimeMember.

getParentLocalValue

public java.lang.String getParentLocalValue()

Gets the local value of the parent of the MdmTimeMember.

Specified by:

getParentLocalValue in interface MdmMember

Returns:

A String that contains the local value of the parent of the MdmTimeMember.

setParentLocalValue

public void setParentLocalValue(java.lang.String parentLocal)

Specifies a local value for the parent of the MdmTimeMember.

Parameters:

parentLocal - A String that contains the local value that you want the parent of the MdmTimeMember to have.

getParentLevel

public MdmLevel getParentLevel()

Gets the MdmLevel of which the parent of the MdmTimeMember is a member.

Specified by:

getParentLevel in interface MdmMember

Returns:

The MdmLevel of which the parent of the MdmTimeMember is a member.

setParentLevel

public void setParentLevel(MdmLevel parentLevel)

Specifies an MdmLevel for the parent of the MdmTimeMember.

Parameters:

parentLevel - The MdmLevel that you want to specify for the parent of the MdmTimeMember.

getTimeDimension

public final MdmTimeDimension getTimeDimension()

Gets the MdmTimeDimension of which the MdmTimeMember is a member.

Returns:

The MdmTimeDimension of which the MdmTimeMember is a member.

getType

public MetadataObject getType()

Gets the type of this MdmTimeMember, which is the type of the Source for the member.

Specified by:

getType in class MdmSource

Returns:

A MetadataObject that represents the type of this custom dimension member.