Oracle OLAP Analytic Workspace Java API Reference
10g Release 1 (10.1)

B12180-01

oracle.AWXML
Class Cube

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

public class Cube
extends AWObject

Specifies the basic characteristics of a cube. A cube defines the multidimensional framework for data. Methods for setting the schema, the logical name, and other text identifiers are inherited from BaseObject. Methods for defining a mapping to the data source are inherited from AWObject.

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


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
Cube()
          Default Constructor
Cube(BaseObject input)
           

 

Method Summary
 void addCubeDimRef(CubeDimRef input)
          Adds a dimension identified by a CubeDimRef object to the cube.
 void addCubeDimRefAfter(CubeDimRef input, BaseObject reference)
          Adds a dimension after another of the cube's dimensions.
 void addCubeDimRefBefore(CubeDimRef input, BaseObject reference)
          Adds a dimension before another of the cube's dimensions.
 void addCubeDimRefFirst(CubeDimRef input)
          Adds a dimension to a cube and makes it the first dimension.
 void addDerivedMeasure(DerivedMeasure input)
           
 void addMeasure(Measure input)
          Adds a measure to the cube.
 void addOlapMeasure(OlapMeasure input)
           
 java.lang.String Create(AWConnection connection)
          Creates the current object in the analytic workspace.
 CubeDimRef createCubeDimRef()
           
 CubeDimRef createCubeDimRefAfter(CubeDimRef input)
           
 CubeDimRef createCubeDimRefBefore(CubeDimRef input)
           
 CubeDimRef createCubeDimRefFirst()
           
 DerivedMeasure createDerivedMeasure()
           
 Measure createMeasure()
           
 OlapMeasure createOlapMeasure()
           
 java.lang.String Delete(AWConnection connection)
          Deletes the current object from the analytic workspace.
 Measure findMeasure(java.lang.String input)
           
 java.lang.String getAutoSolve()
           
 java.util.Vector getCubeDimRefs()
          Returns the dimensions of the cube.
 AggregationDefinition getDefaultAggregationDefinition()
           
 java.lang.String getDefaultDataType()
           
 java.util.Vector getDerivedMeasures()
           
 java.lang.String getId()
          Returns the full name of the current object.
 java.util.Vector getMeasures()
          Returns the measures of the cube.
 java.lang.String getParentId()
          Returns the identifier of the parent of the current object.
 Hierarchy getPartitionHierarchy()
           
 Level getPartitionLevel()
           
 java.lang.String getSparseType()
           
 java.lang.Boolean getUseGlobalIndex()
           
 void readAWMetaData(AWConnection connection)
           
 void removeCubeDimRef(CubeDimRef input)
          Removes a dimension from a cube.
 void removeDerivedMeasure(DerivedMeasure input)
           
 void removeMeasure(Measure input)
          Removes a measure from the cube.
 void removeOlapMeasure(OlapMeasure input)
           
 java.lang.String Rename(AWConnection connection, java.lang.String newName)
           
 void setAutoSolve(java.lang.String input)
           
 void setDefaultAggregationDefinition(AggregationDefinition input)
           
 void setDefaultDataType(java.lang.String input)
           
 void setPartitionHierarchy(Hierarchy input)
           
 void setPartitionLevel(Level input)
           
 void setSparseType(java.lang.String input)
           
 void setUseGlobalIndex(java.lang.Boolean input)
           
protected  boolean validateDim(CubeDimRef input)
           
 java.lang.String WriteAttributesToXML()
          This procedure will write the local attributes of the cube to xml schema format
 java.lang.String WriteToXML()
          Returns the object as an XML string.

 

Methods inherited from class oracle.AWXML.AWObject
addAttribute, addAttributeProjection, addRefreshMapGroup, addSourceCubeMapGroup, addSourceDimensionMapGroup, addSourceMappingGroup, createAttribute, createAttributeProjection, createSourceCubeMapGroup, createSourceDimensionMapGroup, getAttributes, getRefreshMapGroup, getSourceMapGroup, removeAttribute, removeAttributeProjection, removeSourceMappingGroup

 

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

Cube

public Cube()
Default Constructor

Cube

public Cube(BaseObject input)
Method Detail

getId

public java.lang.String getId()
Description copied from class: BaseObject
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.

Overrides:
getId in class BaseObject
Returns:
 

getParentId

public java.lang.String getParentId()
Description copied from class: BaseObject
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.
Overrides:
getParentId in class BaseObject
Returns:
 

setDefaultAggregationDefinition

public void setDefaultAggregationDefinition(AggregationDefinition input)
Returns:
 

getDefaultAggregationDefinition

public AggregationDefinition getDefaultAggregationDefinition()
Returns:
 

getDefaultDataType

public java.lang.String getDefaultDataType()
Returns:
 

setDefaultDataType

public void setDefaultDataType(java.lang.String input)
Returns:
 

setAutoSolve

public void setAutoSolve(java.lang.String input)
Returns:
 

getAutoSolve

public java.lang.String getAutoSolve()
Returns:
 

WriteToXML

public java.lang.String WriteToXML()
Returns the object as an XML string.
Overrides:
WriteToXML in class AWObject
Returns:
A String containing the XML that represents the object.

WriteAttributesToXML

public java.lang.String WriteAttributesToXML()
This procedure will write the local attributes of the cube to xml schema format
Overrides:
WriteAttributesToXML in class AWObject

validateDim

protected boolean validateDim(CubeDimRef input)

addCubeDimRef

public void addCubeDimRef(CubeDimRef input)
Adds a dimension identified by a CubeDimRef object to the cube.
Parameters:
input - CubeDimRef

addCubeDimRefAfter

public void addCubeDimRefAfter(CubeDimRef input,
BaseObject reference)
Adds a dimension after another of the cube's dimensions.
Parameters:
input - CubeDimRef identifying the dimension to add to the cube.
reference - BaseObject identifying the dimension after which the new dimension should be added.

addCubeDimRefBefore

public void addCubeDimRefBefore(CubeDimRef input,
BaseObject reference)
Adds a dimension before another of the cube's dimensions.
Parameters:
input - CubeDimRef identifying the dimension to add to the cube.
reference - BaseObject identifying the dimension before which the new dimension should be added.

addCubeDimRefFirst

public void addCubeDimRefFirst(CubeDimRef input)
Adds a dimension to a cube and makes it the first dimension.
Parameters:
input - CubeDimRef identifying the dimension to add to the cube.

removeCubeDimRef

public void removeCubeDimRef(CubeDimRef input)
Removes a dimension from a cube.
Parameters:
input - CubeDimRef

getCubeDimRefs

public java.util.Vector getCubeDimRefs()
Returns the dimensions of the cube.
Returns:
A Vector containing the dimensions of the cube.

addMeasure

public void addMeasure(Measure input)
Adds a measure to the cube.
Parameters:
input - easure

removeMeasure

public void removeMeasure(Measure input)
Removes a measure from the cube.
Parameters:
input - easure

getMeasures

public java.util.Vector getMeasures()
Returns the measures of the cube.
Returns:
A Vector containing the measures of the cube.

addOlapMeasure

public void addOlapMeasure(OlapMeasure input)
Returns:
 

removeOlapMeasure

public void removeOlapMeasure(OlapMeasure input)
Returns:
 

addDerivedMeasure

public void addDerivedMeasure(DerivedMeasure input)
Returns:
 

removeDerivedMeasure

public void removeDerivedMeasure(DerivedMeasure input)
Returns:
 

getDerivedMeasures

public java.util.Vector getDerivedMeasures()
Returns:
 

setSparseType

public void setSparseType(java.lang.String input)
Returns:
 

getSparseType

public java.lang.String getSparseType()
Returns:
 

createMeasure

public Measure createMeasure()
Returns:
 

createDerivedMeasure

public DerivedMeasure createDerivedMeasure()
Returns:
 

createOlapMeasure

public OlapMeasure createOlapMeasure()
Returns:
 

createCubeDimRef

public CubeDimRef createCubeDimRef()
Returns:
 

createCubeDimRefAfter

public CubeDimRef createCubeDimRefAfter(CubeDimRef input)
Returns:
 

createCubeDimRefBefore

public CubeDimRef createCubeDimRefBefore(CubeDimRef input)
Returns:
 

createCubeDimRefFirst

public CubeDimRef createCubeDimRefFirst()
Returns:
 

Create

public java.lang.String Create(AWConnection connection)
Description copied from class: BaseObject
Creates the current object in the analytic workspace.
Overrides:
Create in class BaseObject
Returns:
 

Delete

public java.lang.String Delete(AWConnection connection)
Description copied from class: BaseObject
Deletes the current object from the analytic workspace.
Overrides:
Delete in class BaseObject
Returns:
 

Rename

public java.lang.String Rename(AWConnection connection,
                               java.lang.String newName)
Overrides:
Rename in class BaseObject
Returns:
 

findMeasure

public Measure findMeasure(java.lang.String input)
Returns:
 

setPartitionHierarchy

public void setPartitionHierarchy(Hierarchy input)
Returns:
 

getPartitionHierarchy

public Hierarchy getPartitionHierarchy()
Returns:
 

setPartitionLevel

public void setPartitionLevel(Level input)
Returns:
 

getPartitionLevel

public Level getPartitionLevel()
Returns:
 

setUseGlobalIndex

public void setUseGlobalIndex(java.lang.Boolean input)
Returns:
 

getUseGlobalIndex

public java.lang.Boolean getUseGlobalIndex()
Returns:
 

readAWMetaData

public void readAWMetaData(AWConnection connection)

Oracle OLAP Analytic Workspace Java API Reference
10g Release 1 (10.1)

B12180-01

Copyright © 2003, Oracle. All Rights Reserved.