oracle.AWXML
Class Dimension

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.AWObject
              |
              +--oracle.AWXML.Dimension

public class Dimension

extends AWObject

Specifies the basic characteristics of a dimension. Methods for setting the schema, the logical name, and other text identifiers are inherited from BaseObject. Methods for applying attributes and defining a mapping to the data source are inherited from AWObject.

A Dimension is a top-level object in the hierarchy of model objects. Every dimension must be associated with a schema. Dimensions may be associated with an analytic workspace.

A Dimension has one or more levels. Its levels may be organized in hierarchies. Dimensions support methods for defining calculations that result in new dimension members. Calculated members may be created permanently or on a session basis.

Dimension

public Dimension()

Default Constructor

Dimension

public Dimension(BaseObject input)

Parameters:

-  

Dimension

public Dimension(java.lang.String name,
                 java.lang.String id)

Parameters:

name - a String containing the logical name of the dimension

name - a String containing the full name of the dimension

WriteToXML

public java.lang.String WriteToXML()

Returns the Dimension object as an XML string.

Overrides:

WriteToXML in class AWObject

Returns:

A String containing the XML that represents the Dimension.

getId

public java.lang.String getId()

Returns the full name of the Dimension. The full name consists of the schema, object name, and object type. For example:

    GLOBAL_AW.PRODUCT.DIMENSION

For more information on standard form naming conventions, see the Oracle OLAP Application Developer's Guide.

Overrides:

getId in class BaseObject

Returns:

A String containing the full name of the object.

getParentId

public java.lang.String getParentId()

Returns the full name of the parent of the object.

Overrides:

getParentId in class BaseObject

Returns:

A String containing the ID of the parent object or the ID of the current object if it has no parent.

getUseNativeKey

public boolean getUseNativeKey()

Returns a boolean to indicate whether or not the primary key of the dimension table contains the lowest-level dimension members

Returns:

boolean

setUseNativeKey

public void setUseNativeKey(boolean input)

Sets a boolean to indicate whether or not the primary key of the dimension table contains the lowest-level dimension members

Parameters:

input - boolean

isNativeKeyUnique

public boolean isNativeKeyUnique()

Returns a boolean to indicate whether or not the dimension contains duplicate members

Returns:

boolean

setIsNativeKeyUnique

public void setIsNativeKeyUnique(boolean input)

Sets a boolean to indicate whether or not the dimension contains duplicate members

Returns:

boolean

setUseNativeKey

public void setUseNativeKey(java.lang.Boolean input)

isTime

public boolean isTime()

Returns a boolean to indicate whether or not the dimension is a time dimension

Returns:

boolean

setIsTime

public void setIsTime(boolean input)

Sets a boolean to indicate whether or not the dimension is a time dimension

Parameters:

input - boolean

setIsTime

public void setIsTime(java.lang.Boolean input)

Returns:

 

isMeasure

public boolean isMeasure()

Returns:

boolean

setIsMeasure

public void setIsMeasure(boolean input)

Parameters:

input - boolean

setIsMeasure

public void setIsMeasure(java.lang.Boolean input)

Parameters:

input - boolean

addMemberSelection

public void addMemberSelection( input)

Adds a MemberSelection to a Dimension. A MemberSelection defines a set of members of the dimension

Parameters:

input - The MemberSelection to add to the Dimension

removeMemberSelection

public void removeMemberSelection( input)

Removes a MemberSelection from a Dimension. A MemberSelection defines a set of members of the dimension

Parameters:

input - The MemberSelection to remove from the Dimension

getMemberSelections

public java.util.Vector getMemberSelections()

Returns the MemberSelections associated with the Dimension

Returns:

A Vector containing the MemberSelection objects defined for this dimension

addLevel

public void addLevel(Level input)

Adds a Level to a Dimension.

Parameters:

input - The Level to add to the Dimension

removeLevel

public void removeLevel(Level input)

Removes a Level from a Dimension.

Parameters:

input - The Level to remove from the Dimension

getLevels

public java.util.Vector getLevels()

Returns the Levels associated with the Dimension.

addHierarchy

public void addHierarchy(Hierarchy input)

Adds a Hierarchy to a Dimension.

Parameters:

input - The Hierarchy to add to the Dimension

removeHierarchy

public void removeHierarchy(Hierarchy input)

Removes a Hierarchy from a Dimension.

Parameters:

input - The Hierarchy to remove from the Dimension

getHierarchies

public java.util.Vector getHierarchies()

Returns the Hierarchies associated with the Dimension.

createMemberSelection

public createMemberSelection()

Creates a MemberSelection, which defines a set of dimension members

Returns:

The new MemberSelection

createLevel

public Level createLevel()

Creates a Level for the Dimension.

Returns:

The new Level

createHierarchy

public Hierarchy createHierarchy()

Creates a Hierarchy for the Dimension.

Returns:

The new Hierarchy

Create

public java.lang.String Create(AWConnection connection)

Creates the Dimension within the specified OLAP session.

Overrides:

Create in class BaseObject

Parameters:

connection - An AWConnection that defines the OLAP session.

Returns:

String

Delete

public java.lang.String Delete(AWConnection connection)

Deletes the Dimension in the specified OLAP session.

Overrides:

Delete in class BaseObject

Parameters:

connection - An AWConnection that defines the OLAP session.

Returns:

String

FindLevel

public Level FindLevel(java.lang.String input)

Finds the Level with the specified name.

Parameters:

input - String containing the name of the Level

Returns:

Level

FindHierarchy

public Hierarchy FindHierarchy(java.lang.String input)

Finds the Hierarchy with the specified name.

Parameters:

input - String containing the name of the Hierarchy

Returns:

Hierarchy

addPermanentCalculatedMember

public void addPermanentCalculatedMember(PermanentCalculatedMember input)

Adds a PermanentCalculatedMember to the Dimension. A PermanentCalculatedMember defines a set of calculations resulting in a set of new dimension members that are stored permanently in the analytic workspace.

Parameters:

input - The PermanentCalculatedMember to add to the Dimension

removePermanentCalculatedMember

public void removePermanentCalculatedMember(PermanentCalculatedMember input)

Removes a PermanentCalculatedMember from the Dimension. A PermanentCalculatedMember defines a set of calculations resulting in a set of new dimension members that are stored permanently in the analytic workspace.

Parameters:

input - The PermanentCalculatedMember to remove from the Dimension

addSessionCalculatedMember

public void addSessionCalculatedMember(SessionCalculatedMember input)

Adds a SessionCalculatedMember to the Dimension. A SessionCalculatedMember defines a set of calculations resulting in a set of new dimension members that are stored in the analytic workspace during the current session.

Parameters:

input - The SessionCalculatedMember to add to the Dimension

removeSessionCalculatedMember

public void removeSessionCalculatedMember(SessionCalculatedMember input)

Removes a SessionCalculatedMember from the Dimension. A SessionCalculatedMember defines a set of calculations resulting in a set of new dimension members that are stored in the analytic workspace during the current session.

Parameters:

input - The SessionCalculatedMember to remove from the Dimension

getCalculatedMembers

public java.util.Vector getCalculatedMembers()

Returns the CalculatedMembers, both permanent and session-based, associated with the Dimension

Returns:

A Vector containing the list of CalculatedMember objects

createPermanentCalculatedMember

public PermanentCalculatedMember createPermanentCalculatedMember()

Creates a new PermanentCalculatedMember for the Dimension. A PermanentCalculatedMember defines a set of calculations resulting in a set of new dimension members that are stored permanently in the analytic workspace.

Returns:

The new PermanentCalculatedMember

createSessionCalculatedMember

public SessionCalculatedMember createSessionCalculatedMember()

Creates a new SessionCalculatedMember for the Dimension. A SessionCalculatedMember defines a set of calculations resulting in a set of new dimension members that are stored in the analytic workspace during the current session.

Returns:

The new SessionCalculatedMember

getAttributeBasedOnRole

public Attribute getAttributeBasedOnRole(java.lang.String role)

Returns the Attribute that has the specified role. For a time dimension, the role can be END_DATE or TIME_SPAN

Parameters:

role - A String containing the role of the Attribute

Returns:

The Attribute with the specified role

readAWMetadata

public void readAWMetadata(AWConnection connection)