|
Oracle® OLAP Analytic Workspace Java API Reference 10g Release 2 (10.2.0.3) B14351-03 Beta Draft |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectoracle.AWXML.BaseObject
public abstract class BaseObject
An abstract class that specifies an object in the Analytic Workspace Java
API object model.
For a diagram of some of the BaseObject class hierarchy and
associations, see Analytic Workspace
Java API Object Model.
The object model identifies an object hierarchy that defines ownership
relationships between instances of BaseObject.
For a description of the object hierarchy and other diagrams, see
Object Hierarchy.
At the top of the hierarchy is the AW object, which represents
an analytic workspace.
An AW owns objects at the next level, which are
Cube, Dimension, and SolveGroup
objects.
Each of those can own other objects.
For example, a Measure is owned by a
Cube, a Hierarchy is owned by a
Dimension, and a Level is owned by a
Hierarchy.
Each BaseObject instance has a unique name, which is used
to construct its identifier.
For information on naming conventions and object identifiers, see
Object Identifiers.
The BaseObject class provides methods for obtaining the name,
identifer, owner (if one exists), and schema of the object.
You can move the object by resetting its schema.
You can also use BaseObject methods to
assign long, short, and plural descriptive names to the object.
A BaseObject can have methods that interact
with the Oracle Database through a JDBC connection.
You can use these action methods to physically create, delete, or alter
the object in the Database.
For objects that exist within a sequence, you can create the object and
specify its position.
For example, you can specify the order of a dimension reference for a cube,
or the position within the solve group for a solve.
The BaseObject class provides a method for obtaining the full
object specification as an XML string.
| Field Summary | |
|---|---|
static java.lang.String |
DATABASENULL
A constant that specifies that a text reference is intentionally null. |
| Constructor Summary | |
|---|---|
BaseObject(BaseObject input)
Creates a BaseObject for the specified owner. |
|
| Method Summary | |
|---|---|
java.lang.String |
Alter(AWConnection connection)
Alters the textual attributes of the object in the current analytic workspace of the specified database connection. |
java.lang.String |
Create(AWConnection connection)
Creates a BaseObject in the current analytic workspace
of the specified database connection. |
java.lang.String |
CreateAfter(AWConnection connection,
BaseObject referencedObj)
Creates a BaseObject in the current analytic workspace of the
specified database connection and adds it after the referenced object in
a list of similar objects. |
java.lang.String |
CreateBefore(AWConnection connection,
BaseObject referencedObj)
Creates a BaseObject in the current analytic workspace of the
specified database connection and adds it before the referenced object in
a list of similar objects. |
java.lang.String |
CreateFirst(AWConnection connection)
Creates a BaseObject in the current analytic workspace
of the specified database connection and adds it at the beginning of a
list of similar objects. |
boolean |
DataRead()
Indicates whether the object definition has been read into memory from the analytic workspace by the readAWDefinitions method of
the AW object in use. |
java.lang.String |
Delete(AWConnection connection)
Deletes the object in the current analytic workspace of the specified database connection. |
java.lang.String |
getColumnName()
Gets the column name of the object. |
java.lang.String |
getId()
Gets the identifier of the object. |
java.lang.String |
getLongName()
Gets the long descriptive name of the object. |
java.lang.String |
getLongName(java.lang.String lang)
Gets the long descriptive name of the object in the specified language. |
java.lang.String |
getName()
Gets the logical name of the object. |
BaseObject |
getOwner()
Gets the owner of this object. |
java.lang.String |
getPluralName()
Gets the plural name of the object. |
java.lang.String |
getPluralName(java.lang.String lang)
Gets the plural name of the object in the specified language. |
java.lang.String |
getSchema()
Gets the relational schema of a Cube, Dimension,
and SolveGroup. |
java.lang.String |
getShortName()
Gets the short descriptive name of the object. |
java.lang.String |
getShortName(java.lang.String lang)
Gets the short descriptive name of the object in the specified language. |
void |
setColumnName(java.lang.String input)
Specifies a column name for the object. |
void |
setLongName(java.lang.String input)
Specifies a long descriptive name for the object. |
void |
setLongName(java.lang.String lang,
java.lang.String input)
Assigns to the object a long descriptive name in the specified language. |
void |
setName(java.lang.String input)
Specifies the logical name of the object. |
void |
setPluralName(java.lang.String input)
Specifies a plural name to the object. |
void |
setPluralName(java.lang.String lang,
java.lang.String input)
Assigns to the object a plural name in the specified language. |
void |
setSchema(java.lang.String input)
Specifies the relational schema of the object. |
void |
setShortName(java.lang.String input)
Assigns a short descriptive name to the object. |
void |
setShortName(java.lang.String lang,
java.lang.String input)
Assigns to the object a short descriptive name in the specified language. |
java.lang.String |
WriteToXML()
Gets an XML representation of the BaseOjbect. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static java.lang.String DATABASENULL
null.
| Constructor Detail |
|---|
public BaseObject(BaseObject input)
BaseObject for the specified owner.
An application should create BaseObject objects, other than
an AW object, by using factory methods of the owning object
such as AW.createCube() or Cube.createMeasure().
input - The BaseObject to own the new object.| Method Detail |
|---|
public boolean DataRead()
readAWDefinitions method of
the AW object in use.
This method returns true unless a partial read has been
executed by the readAWTopLevelDefinitions
method of the AW.
boolean that is true if the object
definition has been completely read into memory, or
false otherwise.public void setSchema(java.lang.String input)
Cube, Dimension,
and SolveGroup objects, which exist within the namespace of
the schema.
All other objects inherit the schema of the object that owns them.
For example, a Measure inherits the schema of the
Cube that owns it.
If you specify a different schema for a Cube,
Dimension, or SolveGroup, then the schema must
match the schema in which the object is physically created.
input - A String that contains the name of the schema
for this BaseObject.public java.lang.String getSchema()
Cube, Dimension,
and SolveGroup.
String that contains the name of the schema,
or null if the object is not a Cube,
Dimension, or SolveGroup.public void setName(java.lang.String input)
The logical name is also the default long, short, and plural descriptive name for the object. In general, the simple logical name for an object conforms to the rules for a SQL simple expression. The length of the name can be from 1 to 30 bytes and is not case-sensitive.
input - A String that contains a logical name for
the object.public java.lang.String getName()
String that contains the logical name of
the object.public void setColumnName(java.lang.String input)
input - A String that contains a column name for
the object.public java.lang.String getColumnName()
String that contains the column name of
the object.public void setShortName(java.lang.String input)
input - A String that contains a short name
for the object.public java.lang.String getLongName()
String that contains the long name of the object.public java.lang.String getLongName(java.lang.String lang)
lang - A String that specifies the language for the
long name.
String that contains the long name of the object
in the specified language.public void setLongName(java.lang.String input)
input - A String that contains a long name
for the object.public java.lang.String getShortName()
String that contains the short name of
the object.public java.lang.String getShortName(java.lang.String lang)
lang - A String that specifies the language for the
short name.
String that contains the short name of
the object in the specified language.public void setPluralName(java.lang.String input)
input - A String that contains a plural name
for the object.public java.lang.String getPluralName()
String that contains the plural name of
the object.public java.lang.String getPluralName(java.lang.String lang)
lang - A String that specifies the language for the
plural name.
String that contains the plural name of
the object in the specified language.public java.lang.String getId()
The identifier of an AW, Cube,
Dimension, or SolveGroup object is in the
format name.type.
The identifier of an object at a lower level in the object hierarchy is
in the format owner.name.type.
For more information on object identifiers, see Object Identifiers.
String that contains the identifier of the object.public java.lang.String WriteToXML()
BaseOjbect.
String that represents the
BaseOjbect.public BaseObject getOwner()
BaseObject that owns this object.public java.lang.String Create(AWConnection connection)
BaseObject in the current analytic workspace
of the specified database connection.
connection - The AWConnection that represents
the database connection.
BaseObject that do not implement a
Create method, this method throws an exception.public java.lang.String CreateFirst(AWConnection connection)
BaseObject in the current analytic workspace
of the specified database connection and adds it at the beginning of a
list of similar objects.
connection - The AWConnection that represents
the database connection.
BaseObject that do not implement a
CreateFirst method, this method throws an exception.
public java.lang.String CreateAfter(AWConnection connection,
BaseObject referencedObj)
BaseObject in the current analytic workspace of the
specified database connection and adds it after the referenced object in
a list of similar objects.
connection - The AWConnection that represents
the database connection.referencedObj - The BaseObject in the list after
which to add the new BaseObject.
BaseObject that do not implement a
CreateAfter method, this method throws an exception.
public java.lang.String CreateBefore(AWConnection connection,
BaseObject referencedObj)
BaseObject in the current analytic workspace of the
specified database connection and adds it before the referenced object in
a list of similar objects.
connection - The AWConnection that represents
the database connection.referencedObj - The BaseObject in the list before
which to add the new BaseObject.
BaseObject that do not implement a
CreateBefore method, this method throws an exception.public java.lang.String Delete(AWConnection connection)
connection - The AWConnection that represents
database connection.
BaseObject that do not implement a
Delete method, this method throws an exception.public java.lang.String Alter(AWConnection connection)
setName, setLongName, or resetting the schema
for a Cube, Dimension, or SolveGroup
with the setSchema method, you call the
the Alter method to effect the changes in the analytic
workspace.
To change the structural definition of a BaseObject by adding
or removing an object owned by the BaseObject, you call a
Create or Delete method of the object.
connection - The AWConnection that represents
the database connection.
BaseObject that do not implement an
Alter method, this method returns a
String that contains no op.
public void setPluralName(java.lang.String lang,
java.lang.String input)
lang - A String that specifies the language for the
plural name.input - A String that contains a plural name
for the object in the specified language.
public void setLongName(java.lang.String lang,
java.lang.String input)
lang - A String that specifies the language for the
long name.input - A String that contains a long name
for the object in the specified language.
public void setShortName(java.lang.String lang,
java.lang.String input)
lang - A String that specifies the language for the
short name.input - A String that contains a short name
for the object in the specified language.
|
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||