|
Oracle® OLAP Java API Reference 11g Release 2 (11.2) E10794-06 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.olapi.metadata.BaseMetadataObject
oracle.olapi.metadata.mdm.MdmObject
oracle.olapi.metadata.mdm.MdmSource
oracle.olapi.metadata.mdm.MdmDimension
oracle.olapi.metadata.mdm.MdmPrimaryDimension
oracle.olapi.metadata.mdm.MdmTimeDimension
public final class MdmTimeDimension
An MdmPrimaryDimension
that represents an Oracle OLAP dimension of time periods. An application creates an MdmTimeDimension
by calling the
method of an findOrCreateTimeDimension
MdmDatabaseSchema
.
Method Summary | |
---|---|
java.lang.Object |
acceptVisitor(MdmObjectVisitor visitor, java.lang.Object context) Calls the visitMdmTimeDimension method of the MdmObjectVisitor and passes that method the MdmTimeDimension and the Object . |
void |
addCustomMember(MdmTimeMember customMember) Adds a custom member to the MdmTimeDimension . |
MdmTimeMember |
createCustomMember(java.lang.String name, MdmLevel level, java.lang.String parent, java.util.Date endDate, int timeSpan, Source source, int precedence) Creates a custom dimension member with the specified parent for the MdmTimeDimension . |
MdmTimeMember |
createCustomMember(java.lang.String name, MdmLevel level, java.lang.String parent, MdmLevel parentLevel, java.util.Date endDate, int timeSpan, Source source, int precedence) Creates a custom dimension member with the specified parent and parent level for the MdmTimeDimension . |
MdmTimeMember |
createCustomMember(java.lang.String name, MdmValueHierarchy valueHier, java.util.Date endDate, int timeSpan, Source source, int precedence) Creates a custom dimension member for the MdmTimeDimension . |
java.util.List |
getCustomMembers() Gets the custom members of the MdmTimeDimension . |
MdmAttribute |
getEndDateAttribute() Gets an MdmAttribute that relates each member of the MdmSubDimension components of the MdmTimeDimension to the end date of the time period that the member represents. |
MdmAttribute |
getStartDateAttribute() Gets an MdmAttribute that relates each member of the MdmSubDimension components of the MdmTimeDimension to the start date of the time period that the member represents. |
MdmAttribute |
getTimeSpanAttribute() Gets an MdmAttribute that relates each member of the MdmSubDimension components of the MdmTimeDimension to the time span of the time period that the member represents. |
void |
removeCustomMember(MdmTimeMember customMember) Removes a custom member from the MdmTimeDimension . |
void |
setEndDateAttribute(MdmAttribute endDateAttr) Specifies an MdmAttribute as the end date attribute for the dimension. |
void |
setStartDateAttribute(MdmAttribute startDateAttr) Specifies an MdmAttribute as the start date attribute for the dimension. |
void |
setTimeSpanAttribute(MdmAttribute timeSpanAttr) Specifies an MdmAttribute as the time span attribute for the dimension. |
Methods inherited from class oracle.olapi.metadata.mdm.MdmDimension |
---|
getCardinality, getCustomOrder, getPluralDescription, getPrimaryDimension, getShortPluralDescription, setCardinality, setCustomOrder, setPluralDescription, setShortPluralDescription |
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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public java.lang.Object acceptVisitor(MdmObjectVisitor visitor, java.lang.Object context)
visitMdmTimeDimension
method of the MdmObjectVisitor
and passes that method the MdmTimeDimension
and the Object
.acceptVisitor
in class MdmObject
visitor
- An MdmObjectVisitor
.context
- An Object
.Object
returned by the MdmObjectVisitor
.public final MdmAttribute getStartDateAttribute()
MdmAttribute
that relates each member of the MdmSubDimension
components of the MdmTimeDimension
to the start date of the time period that the member represents.MdmAttribute
that relates each member of the MdmSubDimension
components of the MdmTimeDimension
to the start date of the time period that the member represents.public final MdmAttribute getEndDateAttribute()
MdmAttribute
that relates each member of the MdmSubDimension
components of the MdmTimeDimension
to the end date of the time period that the member represents.MdmAttribute
that relates each member of the MdmSubDimension
components of the MdmTimeDimension
to the end date of the time period that the member represents.public final MdmAttribute getTimeSpanAttribute()
MdmAttribute
that relates each member of the MdmSubDimension
components of the MdmTimeDimension
to the time span of the time period that the member represents.MdmAttribute
that relates each member of the MdmSubDimension
components of the MdmTimeDimension
to the time span of the time period that the member represents.public void setStartDateAttribute(MdmAttribute startDateAttr)
MdmAttribute
as the start date attribute for the dimension.startDateAttr
- An MdmAttribute
that has start date values for members of the dimension.public void setEndDateAttribute(MdmAttribute endDateAttr)
MdmAttribute
as the end date attribute for the dimension.endDateAttr
- An MdmAttribute
that has end date values for members of the dimension.public void setTimeSpanAttribute(MdmAttribute timeSpanAttr)
MdmAttribute
as the time span attribute for the dimension.timeSpanAttr
- An MdmAttribute
that has time span values for members of the dimension.public MdmTimeMember createCustomMember(java.lang.String name, MdmLevel level, java.lang.String parent, java.util.Date endDate, int timeSpan, Source source, int precedence)
MdmTimeDimension
.name
- A String
that contains the local value for the member.level
- The MdmLevel
to which you want the member to belong.parent
- A String
that contains the local value of the parent of the member. The parent must be a member of the level that is one level above the level to which the custom member belongs.endDate
- A Date
that specifies the end date for the member.timeSpan
- An integer that specifies the time span for the member.source
- A Source
that specifies the value of the custom member; this value is the measure value that is specified by the custom member for an MdmMeasure
that is dimensioned by the MdmTimeDimension
.precedence
- An integer that specifies the precedence for the custom member.MdmTimeMember
that is a custom member of the dimension.public MdmTimeMember createCustomMember(java.lang.String name, MdmLevel level, java.lang.String parent, MdmLevel parentLevel, java.util.Date endDate, int timeSpan, Source source, int precedence)
MdmTimeDimension
.name
- A String
that contains the local value for the member.level
- The MdmLevel
to which you want the member to belong.parent
- A String
that contains the local value of the parent of the member.parentLevel
- The MdmLevel
to which the parent of the member belongs.endDate
- A Date
that specifies the end date for the member.timeSpan
- An integer that specifies the time span for the member.source
- A Source
that specifies the value of the custom member; the value is the measure value that is specified by the custom member for an MdmMeasure
that is dimensioned by the MdmTimeDimension
.precedence
- An integer that specifies the precedence for the custom member.MdmTimeMember
that is a custom member of the dimension.public MdmTimeMember createCustomMember(java.lang.String name, MdmValueHierarchy valueHier, java.util.Date endDate, int timeSpan, Source source, int precedence)
MdmTimeDimension
.name
- A String
that contains the local value for the member.valueHier
- The MdmValueHierarchy
to which you want the member to belong.endDate
- A Date
that specifies the end date for the member.timeSpan
- An integer that specifies the time span for the member.source
- A Source
that specifies the value of the custom member; this value is the measure value that is specified by the custom member for an MdmMeasure
that is dimensioned by the MdmTimeDimension
.precedence
- An integer that specifies the precedence for the custom member.MdmTimeMember
that is a custom member of the dimension.public final java.util.List getCustomMembers()
MdmTimeDimension
.List
that contains the MdmTimeMember
objects that are the custom members of the MdmTimeDimension
.public final void addCustomMember(MdmTimeMember customMember)
MdmTimeDimension
. Use this method to add a custom member that you create with the constructor of the MdmTimeMember
class.customMember
- The custom MdmTimedMember
to add to the MdmTimeDimension
.public final void removeCustomMember(MdmTimeMember customMember)
MdmTimeDimension
.customMember
- The custom MdmTimedMember
to remove from the MdmTimeDimension
.
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |