|
Oracle® OLAP Analytic Workspace Java API Reference 10g Release 2 (10.2.0.4) B14351-04 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectoracle.AWXML.BaseObject
oracle.AWXML.AWObject
oracle.AWXML.Dimension
An AWObject that specifies a dimension in the analytic workspace.
A dimension is a set of values that identify and categorize data.
A dimension forms an edge of a logical cube,
and thus of the measures within the cube.
A Dimension is logically owned by an AW object.
You create a Dimension by calling the
createDimension method of the AW object.
For a description and a diagram of the object model hierarchy, see
Object Hierarchy.
The Dimension class has methods for defining
CalculatedMember objects, which are Dimension
members that specify calculations.
The analytic workspace assigns the results of the calculation as the
Measure value for the calculated member.
A PermanentCalculatedMember is permanently stored by the
analytic workspace, while a SessionCalculatedMember exists only
in the current analytic workspace session.
| Field Summary |
| Fields inherited from class oracle.AWXML.BaseObject |
DATABASENULL |
| Constructor Summary | |
Dimension()
Creates a Dimension in an analytic workspace. |
|
| Method Summary | |
void |
addHierarchy(Hierarchy input)
Adds the specified Hierarchy to the Dimension. |
void |
addIndex(Index input)
Adds an Index to the Dimension. |
void |
addLevel(Level input)
Adds the specified Level to the Dimension. |
void |
addMemberSelection(MemberSelection input)
Adds the specified MemberSelection to the
Dimension. |
void |
addModel(Model input)
Adds the specified Model to the Dimension. |
void |
addPermanentCalculatedMember(PermanentCalculatedMember input)
Adds the specified PermanentCalculatedMember to the
Dimension. |
void |
addSessionCalculatedMember(SessionCalculatedMember input)
Adds the specified SessionCalculatedMember to the
Dimension. |
java.lang.String |
Alter(AWConnection connection)
Changes the textual attributes of the Dimension, such as
its short and long names, in the analytic workspace to those currently
specified by the Dimension. |
java.lang.String |
Create(AWConnection connection)
Creates the Dimension and the objects it owns in the current
analytic workspace of the specified database connection. |
Hierarchy |
createHierarchy()
Creates a Hierarchy and adds it to the Dimension. |
Index |
createIndex()
Creates an Index for the Dimension. |
Level |
createLevel()
Creates a Level and adds it to the Dimension. |
MemberSelection |
createMemberSelection()
Creates a MemberSelection for the Dimension. |
Model |
createModel()
Creates a Model and adds it to the Dimension. |
PermanentCalculatedMember |
createPermanentCalculatedMember()
Creates a PermanentCalculatedMember and adds it to the
Dimension. |
SessionCalculatedMember |
createSessionCalculatedMember()
Creates a SessionCalculatedMember and adds it to the
Dimension. |
java.lang.String |
Delete(AWConnection connection)
Deletes the Dimension in the current analytic workspace
of the specified database connection. |
Attribute |
FindAttribute(java.lang.String input)
Gets the Attribute with the specified name. |
Hierarchy |
FindHierarchy(java.lang.String input)
Gets the Hierarchy with the specified name. |
Level |
FindLevel(java.lang.String input)
Gets the Level with the specified name. |
Attribute |
getAttributeBasedOnRole(java.lang.String role)
Gets the Attribute that has the classification specified by
the role parameter. |
java.util.Vector |
getCalculatedMembers()
Gets a list of the CalculatedMember objects that the
Dimension owns. |
java.util.Vector |
getHierarchies()
Gets a list of the Hierarchy objects owned by the
Dimension. |
java.lang.String |
getId()
Gets the identifier of the Dimension. |
java.util.Vector |
getIndexes()
Gets the Index objects owned by the Dimension. |
java.util.Vector |
getLevels()
Gets a list of the Level objects owned by the
Dimension. |
java.util.Vector |
getMemberSelections()
Gets a list of the MemberSelection objects owned by the
Dimension. |
java.util.Vector |
getModels()
Gets the Model objects owned by the Dimension. |
boolean |
getUseNativeKey()
Indicates whether the primary key of the dimension table contains the lowest-level dimension members. |
boolean |
isMeasure()
Indicates whether the Dimension is a measure dimension,
which is a dimension that has Measure objects as its members. |
boolean |
isNativeKeyUnique()
Indicates whether the Dimension contains duplicate members. |
boolean |
isTime()
Indicates whether the Dimension is a dimension of
time values. |
void |
removeHierarchy(Hierarchy input)
Removes the specified Hierarchy from the Dimension. |
void |
removeIndex(Index input)
Removes an Index from the Dimension. |
void |
removeLevel(Level input)
Removes the specified Level from the Dimension. |
void |
removeMemberSelection(MemberSelection input)
Removes the specified MemberSelection from the
Dimension. |
void |
removeModel(Model input)
Removes the specified Model from the Dimension. |
void |
removePermanentCalculatedMember(PermanentCalculatedMember input)
Removes the specified PermanentCalculatedMember from the
Dimension. |
void |
removeSessionCalculatedMember(SessionCalculatedMember input)
Removes the specified SessionCalculatedMember from the
Dimension. |
void |
setIsMeasure(boolean input)
Specifies whether the Dimension is a measure dimension,
which is a dimension that has Measure objects as its members. |
void |
setIsMeasure(java.lang.Boolean input)
Specifies whether the Dimension is a measure dimension,
which is a dimension that has Measure objects as its members. |
void |
setIsNativeKeyUnique(boolean input)
Specifies whether the Dimension contains duplicate members. |
void |
setIsTime(boolean input)
Specifies whether the Dimension is a dimension of
time values. |
void |
setIsTime(java.lang.Boolean input)
Specifies whether the Dimension is a dimension of
time values. |
void |
setUseNativeKey(boolean input)
Specifies whether the primary key of the dimension table contains the lowest-level dimension members. |
void |
setUseNativeKey(java.lang.Boolean input)
Specifies whether the primary key of the dimension table contains the lowest-level dimension members. |
java.lang.String |
ValidateCalculatedMembers(AWConnection connection)
Determines the validity of the CalculatedMember objects of the
Dimension. |
java.lang.String |
WriteToXML()
Gets an XML representation of the Dimension. |
| Methods inherited from class oracle.AWXML.BaseObject |
CreateAfter, CreateBefore, CreateFirst, DataRead, getColumnName, getLongName, getLongName, getName, getOwner, getPluralName, getPluralName, getSchema, getShortName, getShortName, setColumnName, setLongName, setLongName, setName, setPluralName, setPluralName, setSchema, setShortName, setShortName |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public Dimension()
Dimension in an analytic workspace.
An application should create a Dimension by using the
createDimension method of an AW.
| Method Detail |
public java.lang.String WriteToXML()
Dimension.
WriteToXML in class AWObjectString that represents the
Dimension.public java.lang.String getId()
Dimension.
The identifier is the full name of the Dimension in the format
name.type.
For example, the identifier of a Dimension with the name
TIME_AW is TIME_AW.DIMENSION.
For more information on object identifiers, see Object Identifiers.
getId in class BaseObjectString that contains the identifier of the
Dimension.public boolean getUseNativeKey()
boolean that is true if the primary key
contains the lowest-level members or false otherwise.public void setUseNativeKey(boolean input)
input - A boolean that is true if the primary
key contains the lowest-level members or false
otherwise.public boolean isNativeKeyUnique()
Dimension contains duplicate members.
boolean that is true if the members
of the dimension are unique or false otherwise.public void setIsNativeKeyUnique(boolean input)
Dimension contains duplicate members.
input - A boolean that is true if the members
of the dimension are unique or false otherwise.public void setUseNativeKey(java.lang.Boolean input)
input - A Boolean that contains true if the
primary key contains the lowest-level members or
false otherwise.public boolean isTime()
Dimension is a dimension of
time values.
boolean that is true if the
dimension is a time dimension or false otherwise.public void setIsTime(boolean input)
Dimension is a dimension of
time values.
input - A boolean that is true if the
dimension is a time dimension or false
otherwise.public void setIsTime(java.lang.Boolean input)
Dimension is a dimension of
time values.
input - A Boolean that contains true if the
dimension is a time dimension or false
otherwise.public boolean isMeasure()
Dimension is a measure dimension,
which is a dimension that has Measure objects as its members.
boolean that is true if the
dimension is a measure dimension or false
otherwise.public void setIsMeasure(boolean input)
Dimension is a measure dimension,
which is a dimension that has Measure objects as its members.
input - A boolean that is true if the
dimension is a measure dimension or false
otherwise.public void setIsMeasure(java.lang.Boolean input)
Dimension is a measure dimension,
which is a dimension that has Measure objects as its members.
input - A Boolean that contains true if
the dimension is a measure dimension or false
otherwise.public void addMemberSelection(MemberSelection input)
MemberSelection to the
Dimension.
input - The MemberSelection to add.public void removeMemberSelection(MemberSelection input)
MemberSelection from the
Dimension.
input - The MemberSelection to remove.public java.util.Vector getMemberSelections()
MemberSelection objects owned by the
Dimension.
Vector of MemberSelection objects owned
by the Dimension.public void addLevel(Level input)
Level to the Dimension.
input - The Level to add.public void removeLevel(Level input)
Level from the Dimension.
input - The Level to remove.public java.util.Vector getLevels()
Level objects owned by the
Dimension.
Vector of the Level objects owned by
the Dimension.public void addHierarchy(Hierarchy input)
Hierarchy to the Dimension.
input - The Hierarchy to add.public void removeHierarchy(Hierarchy input)
Hierarchy from the Dimension.
input - The Hierarchy to remove.public java.util.Vector getHierarchies()
Hierarchy objects owned by the
Dimension.
Vector of the Hierarchy objects owned
by the Dimension.public MemberSelection createMemberSelection()
MemberSelection for the Dimension.
MemberSelection.public Level createLevel()
Level and adds it to the Dimension.
Level.public Hierarchy createHierarchy()
Hierarchy and adds it to the Dimension.
Hierarchy.public java.lang.String Create(AWConnection connection)
Dimension and the objects it owns in the current
analytic workspace of the specified database connection.
If it cannot create the Dimension, then this method throws
an AWException exception.
Create in class BaseObjectconnection - The AWConnection that represents the
database connection.
String that contains success if the
method successfully creates the Dimension.public java.lang.String Delete(AWConnection connection)
Dimension in the current analytic workspace
of the specified database connection.
If it cannot delete the Dimension, then this method throws
an AWException exception.
Delete in class BaseObjectconnection - The AWConnection that represents the database
connection.
String that contains success if the
method successfully deletes the Dimension.public java.lang.String Alter(AWConnection connection)
Dimension, such as
its short and long names, in the analytic workspace to those currently
specified by the Dimension.
If it cannot make the changes, then this method throws an
AWException exception.
Alter in class BaseObjectconnection - The AWConnection that represents the
database connection.
String that contains success if the
method successfully makes the changes.public Level FindLevel(java.lang.String input)
Level with the specified name.
input - The name of the level.
Level with the specified name.public Attribute FindAttribute(java.lang.String input)
Attribute with the specified name.
input - The name of the attribute.
Attribute with the specified name.public Hierarchy FindHierarchy(java.lang.String input)
Hierarchy with the specified name.
input - The name of the Hierarchy to find.
Hierarchy with the specified name.public void addPermanentCalculatedMember(PermanentCalculatedMember input)
PermanentCalculatedMember to the
Dimension.
input - The PermanentCalculatedMember to add.public void removePermanentCalculatedMember(PermanentCalculatedMember input)
PermanentCalculatedMember from the
Dimension.
input - The PermanentCalculatedMember to remove.public void addSessionCalculatedMember(SessionCalculatedMember input)
SessionCalculatedMember to the
Dimension.
input - The SessionCalculatedMember to add.public void removeSessionCalculatedMember(SessionCalculatedMember input)
SessionCalculatedMember from the
Dimension.
input - The SessionCalculatedMember to remove.public java.util.Vector getCalculatedMembers()
CalculatedMember objects that the
Dimension owns.
A CalculatedMember can be an instance of a
PermanentCalculatedMember or a
SessionCalculatedMember.
Vector of the CalculatedMember
objects owned by the Dimension.public PermanentCalculatedMember createPermanentCalculatedMember()
PermanentCalculatedMember and adds it to the
Dimension.
PermanentCalculatedMember.public SessionCalculatedMember createSessionCalculatedMember()
SessionCalculatedMember and adds it to the
Dimension.
SessionCalculatedMember.public Attribute getAttributeBasedOnRole(java.lang.String role)
Attribute that has the classification specified by
the role parameter.
For example a time dimension has an Attribute that has the
END_DATE classification and another that has the
TIME_SPAN classification.
role - A String that contains the role of the
Attribute.
Attribute with the specified role.public void addModel(Model input)
Model to the Dimension.
input - The Model to add.public void removeModel(Model input)
Model from the Dimension.
input - The Model to remove.public java.util.Vector getModels()
Model objects owned by the Dimension.
Vector that contains the Model objects
owned by the Dimension.public Model createModel()
Model and adds it to the Dimension.
Model.public Index createIndex()
Index for the Dimension.
Index for the Dimension.public void addIndex(Index input)
Index to the Dimension.
input - The Index to add to the Dimension.public void removeIndex(Index input)
Index from the Dimension.
input - The Index to remove from the Dimension.public java.util.Vector getIndexes()
Index objects owned by the Dimension.
Vector that contains the Index objects
owned by the Dimension.public java.lang.String ValidateCalculatedMembers(AWConnection connection)
CalculatedMember objects of the
Dimension.
If a calculated dimension member is not valid, then this method throws an
AWException exception.
connection - The AWConnection that represents the
database connection.
String that contains success if the
calculated dimension members are valid.
|
Oracle® OLAP Analytic Workspace Java API Reference 10g Release 2 (10.2.0.4) B14351-04 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||