oracle.AWXML
Class BaseObject

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

Direct Known Subclasses:

AggregationArgument, AggregationOperator, Allocation, AllocationArgument, AllocationOperator, Attribute, AW, AWDatabaseNull, AWObject, CalculatedMember, CalculatedMemberRef, CalculationSpecification, CubeDimRef, DimensionMemberExpression, DimensionMemberSelection, ExternalSourceExpression, ForcastArgumentValue, ForecastArgument, ForecastArgumentValue, ForeCastKeyWord, MappingGroup, Measure, Model, ModelDimRef, OlapMeasureInput, Operator, OperatorType, Parameter, PreComputeClause, Solve, SolveDefDimRef, SolveDefinition, SourceColumn, WhereClause

public abstract class BaseObject

extends java.lang.Object

Specifies the basic characteristics of an object model. The model can specify a cube, a cube component, a dimension, or a dimension component. The model can also specify a solve definition, which is a set of rules for performing aggregation, allocation, or forecasting.

Each instance of the BaseObject class has a unique identifier. Most instances also have a parent identifier that associates it with the BaseObject instance that owns it. All objects except cubes, dimensions, and solve definitions have owners.

The BaseObject class provides methods for identifying an object as a whole. There are methods for setting the object's name and schema, and for providing long, short, and plural versions of the name. There are methods for determing the parent object, if one exists. For example, the parent of a level object is a dimension object.

The BaseObject class also provides methods for writing the object specification to XML.

Use the following link to view a graphical representation of oracle.AWXML.BaseObject.

OLAP Analytic Workspace Logical Object Model

m_name

protected java.lang.String m_name

m_longName

protected java.lang.String m_longName

m_shortName

protected java.lang.String m_shortName

m_pluralName

protected java.lang.String m_pluralName

m_id

protected java.lang.String m_id

m_owner

protected BaseObject m_owner

m_schema

protected java.lang.String m_schema

AWNULL

protected static java.lang.String AWNULL

s_EndElementTag

protected static java.lang.String s_EndElementTag

s_StartStartTag

protected static java.lang.String s_StartStartTag

s_StartEndTag

protected static java.lang.String s_StartEndTag

s_EndStartTag

protected static java.lang.String s_EndStartTag

s_EndEndTag

protected static java.lang.String s_EndEndTag

s_EndTag

protected static java.lang.String s_EndTag

s_JAVA_LINEEND

protected static java.lang.String s_JAVA_LINEEND

s_NEWLINE

protected static java.lang.String s_NEWLINE

s_Indent

protected static int s_Indent

s_objectCounter

protected static int s_objectCounter

m_listResults

protected java.lang.String[] m_listResults

m_commandResults

protected java.lang.String m_commandResults

m_commandResultText

protected java.lang.String m_commandResultText

DATABASENULL

public static java.lang.String DATABASENULL

BaseObject

public BaseObject(BaseObject input)

Provides the basic characteristics of an object. Every object has a unique identifer. Initially its short name and plural name are the same as its identifier. A default constructor is provided on the top level objects of the model (cubes, dimensions, and solve definitions, solves and models) all other objects are owned in the object hierarchy by one of these objects. To create a non-top level object create methods are provided to factory a specific instance of a given object.

Parameters:

input - A BaseObject

setSchema

public void setSchema(java.lang.String input)

Sets the schema of the current object. The schema class attribute is used to provide the top level portion of an objects identity. The schema is defaulted to AW$DEFAULT when a top level object is created. This value is replaced automatically when an object is created into a specific schema. If a user provides the schema, the schema must match the schema into which an object will be created. Schema only applies to the top-level objects: dimensions, cubes, solveDefinitions, solves and models.

Parameters:

input - A String containing the name of the schema.

getSchema

public java.lang.String getSchema()

Returns the schema of the current object or null. Only applies to top-level objects: dimensions, cubes, solveDefinitions, solves and models.

Returns:

A String containing the schema of the object.

setName

public void setName(java.lang.String input)

Sets the logical name of the current object and is used to create its unique identifier. In general, the simple logical name for an object, such as a cube or dimension, conforms to the rules for a SQL simple expression. The logical name is from 1 to 30 bytes and is not case-sensitive. An example of a simple logical name is PRODUCT.

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

Parameters:

input - A String containing the logical name of the object.

getName

public java.lang.String getName()

Returns the logical name of the current object.

Returns:

A String containing the logical name of the object.

setShortName

public void setShortName(java.lang.String input)

Sets the short name of the current object. You can specify any text string as the short name.

Parameters:

input - A String containing the short name of the object.

getLongName

public java.lang.String getLongName()

Returns the long name of the current object.

Returns:

A String containing the long name of the object.

setLongName

public void setLongName(java.lang.String input)

Sets the long name of the current object.

Parameters:

input - A String containing the long name of the object.

getShortName

public java.lang.String getShortName()

Returns the short name of the current object.

Returns:

A String containing the short name of the object.

setPluralName

public void setPluralName(java.lang.String input)

Sets the plural name of the current object. You can specify any text string as the plural name. It should represent the plural version of the simple logical object name.

Parameters:

input - A String containing the plural name of the object.

getPluralName

public java.lang.String getPluralName()

Returns the plural name of the current object.

Returns:

A String containing the plural name of the object.

getId

public java.lang.String getId()

Returns the full name of the current object. Standard form conventions specify a full name for each logical object, because simple logical names are not unique outside their name space. The full name includes the simple logical name, but also indicates the name space to which the object belongs and its object type.

The following is an example of a full name for an attribute whose simple name is TIME_SPAN and whose parent object is a dimension called TIME.

GLOBAL_AW.TIME.TIME_SPAN.ATTRIBUTE

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

Returns:

A String containing the full name of the object.

getParentId

public java.lang.String getParentId()

Returns the identifier of the parent of the current object. If the current object is a top-level object, such as a cube or a dimension, this method returns the ID of the current object.

Returns:

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

WriteToXML

public java.lang.String WriteToXML()

Returns the object as an XML string.

Returns:

A String containing the XML that represents the object.

getOwner

public BaseObject getOwner()

Returns the owner of the current object.

Returns:

The BaseObject that owns the current object.

Create

public java.lang.String Create(AWConnection connection)

Creates the current object in the analytic workspace.

Parameters:

connection - A AWConnection that represents the current OLAP session

Returns:

String

CreateFirst

public java.lang.String CreateFirst(AWConnection connection)

Creates the current object in the analytic workspace first as part of an ordered set of objects.

Parameters:

connection - A AWConnection that represents the current OLAP session

Returns:

String

CreateAfter

public java.lang.String CreateAfter(AWConnection connection,
BaseObject referencedObj)

Creates the current object in the analytic workspace as part of an ordered set of objects after the specified object.

Parameters:

connection - A AWConnection that represents the current OLAP session

referencedObj - A BaseObject that represents where in the ordered collection to insert the new object.

Returns:

String

CreateBefore

public java.lang.String CreateBefore(AWConnection connection,
BaseObject referencedObj)

Creates the current object in the analytic workspace as part of an ordered set of objects before the specified object.

Parameters:

connection - A AWConnection that represents the current OLAP session

referencedObj - A BaseObject that represents where in the ordered collection to insert the new object.

Returns:

String

Delete

public java.lang.String Delete(AWConnection connection)

Deletes the current object from the analytic workspace.

Parameters:

connection - A AWConnection that represents the current OLAP session

Returns:

String

Alter

public java.lang.String Alter(AWConnection connection)

Alters the current object in the analytic workspace. The alter method is for altering the class attributes of a specific object, to alter the structure of an object create or remove owned object elements.

Parameters:

connection - A AWConnection that represents the current OLAP session

Returns:

String