|
Oracle OLAP Analytic Workspace Java API Reference 10g Release 1 (10.1) B12180-01 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.AWXML.BaseObject | +--oracle.AWXML.AWObject | +--oracle.AWXML.Dimension
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.
Fields inherited from class oracle.AWXML.AWObject |
m_attributes, m_refreshMapGroup, m_sourceMapGroup |
Fields inherited from class oracle.AWXML.BaseObject |
AWNULL, DATABASENULL, m_commandResults, m_commandResultText, m_id, m_listResults, m_longName, m_name, m_owner, m_pluralName, m_schema, m_shortName, s_EndElementTag, s_EndEndTag, s_EndStartTag, s_EndTag, s_Indent, s_JAVA_LINEEND, s_NEWLINE, s_objectCounter, s_StartEndTag, s_StartStartTag |
Constructor Summary | |
Dimension() Default Constructor | |
Dimension(BaseObject input) | |
Dimension(java.lang.String name, java.lang.String id) |
Method Summary | |
void |
addHierarchy(Hierarchy input) Adds a Hierarchy to a Dimension . |
void |
addLevel(Level input) Adds a Level to a Dimension . |
void |
addMemberSelection( input) Adds a MemberSelection to a Dimension . |
void |
addPermanentCalculatedMember(PermanentCalculatedMember input) Adds a PermanentCalculatedMember to the Dimension . |
void |
addSessionCalculatedMember(SessionCalculatedMember input) Adds a SessionCalculatedMember to the Dimension . |
java.lang.String |
Create(AWConnection connection) Creates the Dimension within the specified OLAP session. |
Hierarchy |
createHierarchy() Creates a Hierarchy for the Dimension . |
Level |
createLevel() Creates a Level for the Dimension . |
interface |
createMemberSelection() Creates a MemberSelection , which defines a set of dimension members |
PermanentCalculatedMember |
createPermanentCalculatedMember() Creates a new PermanentCalculatedMember for the Dimension . |
SessionCalculatedMember |
createSessionCalculatedMember() Creates a new SessionCalculatedMember for the Dimension . |
java.lang.String |
Delete(AWConnection connection) Deletes the Dimension in the specified OLAP session. |
Hierarchy |
FindHierarchy(java.lang.String input) Finds the Hierarchy with the specified name. |
Level |
FindLevel(java.lang.String input) Finds the Level with the specified name. |
Attribute |
getAttributeBasedOnRole(java.lang.String role) Returns the Attribute that has the specified role. |
java.util.Vector |
getCalculatedMembers() Returns the CalculatedMembers, both permanent and session-based, associated with the Dimension |
java.util.Vector |
getHierarchies() Returns the Hierarchies associated with the Dimension. |
java.lang.String |
getId() Returns the full name of the Dimension . |
java.util.Vector |
getLevels() Returns the Levels associated with the Dimension. |
java.util.Vector |
getMemberSelections() Returns the MemberSelections associated with the Dimension |
java.lang.String |
getParentId() Returns the full name of the parent of the object. |
boolean |
getUseNativeKey() Returns a boolean to indicate whether or not the primary key of the dimension table contains the lowest-level dimension members |
boolean |
isMeasure() |
boolean |
isNativeKeyUnique() Returns a boolean to indicate whether or not the dimension contains duplicate members |
boolean |
isTime() Returns a boolean to indicate whether or not the dimension is a time dimension |
void |
readAWMetadata(AWConnection connection) |
void |
removeHierarchy(Hierarchy input) Removes a Hierarchy from a Dimension . |
void |
removeLevel(Level input) Removes a Level from a Dimension . |
void |
removeMemberSelection( input) Removes a MemberSelection from a Dimension . |
void |
removePermanentCalculatedMember(PermanentCalculatedMember input) Removes a PermanentCalculatedMember from the Dimension . |
void |
removeSessionCalculatedMember(SessionCalculatedMember input) Removes a SessionCalculatedMember from the Dimension . |
void |
setIsMeasure(boolean input) |
void |
setIsMeasure(java.lang.Boolean input) |
void |
setIsNativeKeyUnique(boolean input) Sets a boolean to indicate whether or not the dimension contains duplicate members |
void |
setIsTime(boolean input) Sets a boolean to indicate whether or not the dimension is a time dimension |
void |
setIsTime(java.lang.Boolean input) |
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 |
void |
setUseNativeKey(java.lang.Boolean input) |
java.lang.String |
WriteToXML() Returns the Dimension object as an XML string. |
Methods inherited from class oracle.AWXML.BaseObject |
Alter, CreateAfter, CreateBefore, CreateFirst, getLongName, getName, getOwner, getPluralName, getSchema, getShortName, setLongName, setName, setPluralName, setSchema, setShortName |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Dimension()
public Dimension(BaseObject input)
public Dimension(java.lang.String name, java.lang.String id)
name
- a String
containing the logical name of the dimensionname
- a String
containing the full name of the dimensionMethod Detail |
public java.lang.String WriteToXML()
Dimension
object as an XML string.String
containing the XML that represents the Dimension
.public java.lang.String getId()
Dimension
. The full name consists of the schema, object name, and object type. For example:
GLOBAL_AW.PRODUCT.DIMENSIONFor more information on standard form naming conventions, see the Oracle OLAP Application Developer's Guide.
String
containing the full name of the object.public java.lang.String getParentId()
String
containing the ID of the parent object or the ID of the current object if it has no parent.public boolean getUseNativeKey()
boolean
public void setUseNativeKey(boolean input)
input
- boolean
public boolean isNativeKeyUnique()
boolean
public void setIsNativeKeyUnique(boolean input)
boolean
public void setUseNativeKey(java.lang.Boolean input)
public boolean isTime()
boolean
public void setIsTime(boolean input)
input
- boolean
public void setIsTime(java.lang.Boolean input)
public boolean isMeasure()
boolean
public void setIsMeasure(boolean input)
input
- boolean
public void setIsMeasure(java.lang.Boolean input)
input
- boolean
public void addMemberSelection( input)
MemberSelection
to a Dimension
. A MemberSelection defines a set of members of the dimensioninput
- The MemberSelection
to add to the Dimensionpublic void removeMemberSelection( input)
MemberSelection
from a Dimension
. A MemberSelection defines a set of members of the dimensioninput
- The MemberSelection
to remove from the Dimensionpublic java.util.Vector getMemberSelections()
Dimension
Vector
containing the MemberSelection
objects defined for this dimensionpublic void addLevel(Level input)
Level
to a Dimension
.input
- The Level
to add to the Dimensionpublic void removeLevel(Level input)
Level
from a Dimension
.input
- The Level
to remove from the Dimensionpublic java.util.Vector getLevels()
public void addHierarchy(Hierarchy input)
Hierarchy
to a Dimension
.input
- The Hierarchy
to add to the Dimensionpublic void removeHierarchy(Hierarchy input)
Hierarchy
from a Dimension
.input
- The Hierarchy
to remove from the Dimensionpublic java.util.Vector getHierarchies()
public createMemberSelection()
MemberSelection
, which defines a set of dimension membersMemberSelection
public Level createLevel()
Level
for the Dimension
.Level
public Hierarchy createHierarchy()
Hierarchy
for the Dimension
.Hierarchy
public java.lang.String Create(AWConnection connection)
Dimension
within the specified OLAP session.connection
- An AWConnection
that defines the OLAP session.String
public java.lang.String Delete(AWConnection connection)
Dimension
in the specified OLAP session.connection
- An AWConnection
that defines the OLAP session.String
public Level FindLevel(java.lang.String input)
Level
with the specified name.input
- String
containing the name of the LevelLevel
public Hierarchy FindHierarchy(java.lang.String input)
Hierarchy
with the specified name.input
- String
containing the name of the HierarchyHierarchy
public void addPermanentCalculatedMember(PermanentCalculatedMember input)
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.input
- The PermanentCalculatedMember
to add to the Dimensionpublic void removePermanentCalculatedMember(PermanentCalculatedMember input)
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.input
- The PermanentCalculatedMember
to remove from the Dimensionpublic void addSessionCalculatedMember(SessionCalculatedMember input)
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.input
- The SessionCalculatedMember
to add to the Dimensionpublic void removeSessionCalculatedMember(SessionCalculatedMember input)
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.input
- The SessionCalculatedMember
to remove from the Dimensionpublic java.util.Vector getCalculatedMembers()
Dimension
Vector
containing the list of CalculatedMember
objectspublic PermanentCalculatedMember createPermanentCalculatedMember()
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.PermanentCalculatedMember
public SessionCalculatedMember createSessionCalculatedMember()
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.SessionCalculatedMember
public Attribute getAttributeBasedOnRole(java.lang.String role)
Attribute
that has the specified role. For a time dimension, the role can be END_DATE
or TIME_SPAN
role
- A String
containing the role of the AttributeAttribute
with the specified rolepublic void readAWMetadata(AWConnection connection)
|
Oracle OLAP Analytic Workspace Java API Reference 10g Release 1 (10.1) B12180-01 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |