|
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.AW
Serves as a container for objects. An AW
object does not participate in the hierarchy of logical objects, but each object that will be instantiated in an analytic workspace must be associated with an AW
object.
The top-level objects in the hierarchy are owned by a schema, not by an AW
object. Top-level objects are: Cubes, Dimensions, SolveDefinitions, Solves, and Models.
oracle.AWXML.AWObject
Field Summary | |
static java.lang.String |
s_aggSolveDefCatalogObj |
static java.lang.String |
s_aggSolveDefPropObj |
static java.lang.String |
s_allAttributesObject |
static java.lang.String |
s_allDimsObj |
static java.lang.String |
s_allHierarchiesObject |
static java.lang.String |
s_allLevelsObject |
static java.lang.String |
s_allObjectsObj |
static java.lang.String |
s_allocSolveDefCatalogObj |
static java.lang.String |
s_allocSolveDefPropObj |
static java.lang.String |
s_allSolvesBaseObj |
static java.lang.String |
s_allSolvesMSObj |
static java.lang.String |
s_allSolvesObj |
static java.lang.String |
s_allSolvesOrderObj |
static java.lang.String |
s_allSolvesSolveDfnObj |
static java.lang.String |
s_allSolvesSourceObj |
static java.lang.String |
s_allSolvesTargetObj |
static java.lang.String |
s_attrVisibleObject |
static java.lang.String |
s_cubeDfltAggregationObj |
static java.lang.String |
s_cubeDfltHierPartObj |
static java.lang.String |
s_cubeDfltLvlPartObj |
static java.lang.String |
s_cubeListObject |
static java.lang.String |
s_cubeSparseDimsObj |
static AW |
s_curAW |
static java.lang.String |
s_forecastCatalogObj |
static java.lang.String |
s_forecastPropObj |
static java.lang.String |
s_mapAttrObject |
static java.lang.String |
s_mapGroupListObject |
static java.lang.String |
s_mapKeyObject |
static java.lang.String |
s_mapMeasureObject |
static java.lang.String |
s_mapParentObject |
static java.lang.String |
s_measAggregationObj |
static java.lang.String |
s_measCatalogObj |
static java.lang.String |
s_measHierPartObj |
static java.lang.String |
s_measLvlPartObj |
static java.lang.String |
s_measPropObj |
static java.lang.String |
s_measSparseDimsObj |
static java.lang.String |
s_measureListObject |
static java.lang.String |
s_relationalAttributeData |
static java.lang.String |
s_solveDfnCalculationOrderObj |
static java.lang.String |
s_solveDfnObj |
static java.lang.String |
s_solveDfnSolveOrderObj |
static java.lang.String |
s_solveDfnTypeObj |
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 | |
AW() Constructor for AW . |
Method Summary | |
void |
addCube(Cube input) Adds a cube to an analytic workspace. |
void |
addDimension(Dimension input) Adds a dimension to an analytic workspace. |
void |
addModel(Model input) Adds a Model to an analytic workspace. |
void |
addSolve(Solve input) Adds a Solve to an analytic workspace. |
void |
addSolveAfter(Solve input, BaseObject reference) Adds a Solve after the specified object in the analytic workspace. |
void |
addSolveBefore(Solve input, BaseObject reference) Adds a Solve before the specified object in the analytic workspace. |
void |
addSolveDefinition(SolveDefinition input) Adds a SolveDefinition to an analytic workspace. |
void |
addSolveFirst(Solve input) Adds a Solve as the first in a collection of Solves in the analytic workspace. |
void |
Attach(AWConnection connection, java.lang.String mode) In the specified OLAP session, attaches the analytic workspace. |
void |
Commit(AWConnection connection) In the specified OLAP session, commits the changes to the analytic workspace. |
java.lang.String |
Create(AWConnection connection) In the specified OLAP session, creates the analytic workspace and defines the workspace objects. |
AggregationDefinition |
createAggregationDefinition() Creates an AggregationDefinition . |
AggregationSolve |
createAggregationSolve() Creates an AggregationSolve . |
AggregationSolve |
createAggregationSolveAfter(Solve input) Creates a new AggregationSolve after the specified Solve in the analytic workspace. |
AggregationSolve |
createAggregationSolveBefore(Solve input) Creates a new AggregationSolve before the specified Solve in the analytic workspace. |
AggregationSolve |
createAggregationSolveFirst() Creates the first AggregationSolve in a series of AggregationSolve objects in the analytic workspace. |
AllocationDefinition |
createAllocationDefinition() Creates an AllocationDefinition . |
AllocationSolve |
createAllocationSolve() Creates an AllocationSolve . |
AllocationSolve |
createAllocationSolveAfter(Solve input) Creates a new AllocationSolve after the specified Solve in the analytic workspace. |
AllocationSolve |
createAllocationSolveBefore(Solve input) Creates a new AllocationSolve before the specified Solve in the analytic workspace. |
AllocationSolve |
createAllocationSolveFirst() Creates the first AllocationSolve in a series of AllocationSolve objects in the analytic workspace. |
Cube |
createCube() Creates a Cube . |
Dimension |
createDimension() Creates a Dimension . |
ForecastDefinition |
createForecastDefinition() Creates a ForecastDefinition . |
ForecastSolve |
createForecastSolve() Creates a ForecastSolve . |
ForecastSolve |
createForecastSolveAfter(Solve input) Creates a new ForecastSolve after the specified Solve in the analytic workspace. |
ForecastSolve |
createForecastSolveBefore(Solve input) Creates a new ForecastSolve before the specified Solve in the analytic workspace. |
ForecastSolve |
createForecastSolveFirst() Creates the first ForecastSolve in a series of ForecastSolve objects in the analytic workspace. |
Model |
createModel() Creates a Model . |
void |
Detach(AWConnection connection) In the specified OLAP session, detaches the analytic workspace. |
AggregationDefinition |
findAggregationDefinition(java.lang.String name) |
AllocationDefinition |
findAllocationDefinition(java.lang.String name) |
Cube |
findCube(java.lang.String inputName) |
Dimension |
findDimension(java.lang.String inputName) |
ForecastDefinition |
findForecastDefinition(java.lang.String name) |
java.util.Vector |
getCubes() Returns the cubes that are stored in the analytic workspace. |
static AW |
getCurAW() Returns the current AW object. |
java.util.Vector |
getDimensions() Returns the dimensions that are stored in the analytic workspace. |
java.util.Vector |
getModels() Returns the Models in the analytic workspace. |
static void |
getPhysicalMetaDataNames(AWConnection connection) |
java.util.Vector |
getSolveDefinitions() Returns the SolveDefinitions that are stored in the analytic workspace. |
java.util.Vector |
getSolves() Returns the Solves in the analytic workspace. |
static AW |
readAWDefinitions(AWConnection connection, java.lang.String awName) In the specified OLAP session, reads the standard form object definitions in the specified analytic workspace and copies them into a new AW . |
static AW |
readAWTopLevelDefinitions(AWConnection connection, java.lang.String awName) In the specified OLAP session, reads the standard form top level object definitions in the specified analytic workspace and copies them into a new AW . |
void |
removeCube(Cube input) Removes a cube from an analytic workspace. |
void |
removeDimension(Dimension input) Removes a dimension from an analytic workspace. |
void |
removeModel(Model input) Removes a Model from an analytic workspace. |
void |
removeSolve(Solve input) Removes a Solve from an analytic workspace. |
void |
removeSolveDefinition(SolveDefinition input) Removes a SolveDefinition from an analytic workspace. |
static void |
setCurAW(AW input) Sets the current AW object. |
java.lang.String |
WriteToXML() Returns the AW object as an XML string. |
Methods inherited from class oracle.AWXML.BaseObject |
Alter, CreateAfter, CreateBefore, CreateFirst, Delete, getId, getLongName, getName, getOwner, getParentId, 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 |
Field Detail |
public static AW s_curAW
public static java.lang.String s_allObjectsObj
public static java.lang.String s_allDimsObj
public static java.lang.String s_allLevelsObject
public static java.lang.String s_allHierarchiesObject
public static java.lang.String s_allAttributesObject
public static java.lang.String s_relationalAttributeData
public static java.lang.String s_cubeListObject
public static java.lang.String s_measureListObject
public static java.lang.String s_mapGroupListObject
public static java.lang.String s_mapMeasureObject
public static java.lang.String s_mapKeyObject
public static java.lang.String s_mapAttrObject
public static java.lang.String s_mapParentObject
public static java.lang.String s_attrVisibleObject
public static java.lang.String s_solveDfnObj
public static java.lang.String s_solveDfnTypeObj
public static java.lang.String s_solveDfnSolveOrderObj
public static java.lang.String s_solveDfnCalculationOrderObj
public static java.lang.String s_aggSolveDefPropObj
public static java.lang.String s_aggSolveDefCatalogObj
public static java.lang.String s_allocSolveDefPropObj
public static java.lang.String s_allocSolveDefCatalogObj
public static java.lang.String s_forecastPropObj
public static java.lang.String s_forecastCatalogObj
public static java.lang.String s_cubeSparseDimsObj
public static java.lang.String s_cubeDfltAggregationObj
public static java.lang.String s_cubeDfltHierPartObj
public static java.lang.String s_cubeDfltLvlPartObj
public static java.lang.String s_measSparseDimsObj
public static java.lang.String s_measCatalogObj
public static java.lang.String s_measPropObj
public static java.lang.String s_measLvlPartObj
public static java.lang.String s_measHierPartObj
public static java.lang.String s_measAggregationObj
public static java.lang.String s_allSolvesObj
public static java.lang.String s_allSolvesTargetObj
public static java.lang.String s_allSolvesSourceObj
public static java.lang.String s_allSolvesBaseObj
public static java.lang.String s_allSolvesMSObj
public static java.lang.String s_allSolvesOrderObj
public static java.lang.String s_allSolvesSolveDfnObj
Constructor Detail |
public AW()
AW
. Creates a new AW
object.Method Detail |
public static AW getCurAW()
AW
object.AW
.public static void setCurAW(AW input)
AW
object.input
- An AW
.public java.lang.String WriteToXML()
AW
object as an XML string.String
containing the XML that represents the AW
.public void addDimension(Dimension input)
input
- The Dimension
to add to the AW
.Dimension
public void removeDimension(Dimension input)
input
- The Dimension
to remove from the AW
.public java.util.Vector getDimensions()
Vector
containing the list of dimensions in the AW
.public void addCube(Cube input)
input
- The Cube
to add to the AW
.Cube
public void removeCube(Cube input)
input
- The Cube
to remove from the AW
.public java.util.Vector getCubes()
Vector
containing the list of cubes in the AW
.public void addSolveDefinition(SolveDefinition input)
SolveDefinition
to an analytic workspace. A SolveDefinition
contains static information used to generate Solves (Aggregations, Allocations, and Forecasts).
The SolveDefinition
for an Aggregation is an aggmap, a workspace object that contains instructions for storing aggregate data. The SolveDefinition
for an Allocation is an allocmap, a workspace object that contains instructions for storing allocated data. The SolveDefinition
for a Forecast is a collection of properties that can be reused by different forecasts.
input
- The SolveDefinition
object to add to the AW
.SolveDefinition
public void removeSolveDefinition(SolveDefinition input)
SolveDefinition
from an analytic workspace.input
- The SolveDefinition
to remove from the AW
.public java.util.Vector getSolveDefinitions()
Vector
containing the list of SolveDefinition
objects in the AW
.public void addSolve(Solve input)
Solve
to an analytic workspace. A Solve
can be an Aggregation
, an Allocation
, or a ForecastSolve
.input
- The SolveDefinition
object to add to the AW
.Solve
public void addSolveBefore(Solve input, BaseObject reference)
Solve
before the specified object in the analytic workspace.input
- A Solve
to add to the workspace.reference
- The BaseObject
that should be preceded by the Solve
.public void addSolveAfter(Solve input, BaseObject reference)
Solve
after the specified object in the analytic workspace.input
- A Solve
to add to the workspace.reference
- The BaseObject
that should precede the Solve
.public void addSolveFirst(Solve input)
Solve
as the first in a collection of Solves in the analytic workspace.input
- The Solve
to add.public void removeSolve(Solve input)
Solve
from an analytic workspace.input
- The Solve
to remove.public java.util.Vector getSolves()
Vector
containing a list of Solve
objects.public void addModel(Model input)
Model
to an analytic workspace. A Model
is a workspace object that contains a set of interrelated equations. The results of a model can be assigned to a derived measure or dimension member.input
- The Model
object to add to the AW
.Model
public void removeModel(Model input)
Model
from an analytic workspace.input
- The Model
object to remove from the AW
.public java.util.Vector getModels()
Vector
containing a list of Model
objects.public Dimension createDimension()
Dimension
. The new Dimension
may be be added to an analytic workspace with the AddDimension
method, or it may be added to a user-defined container.Dimension
Dimension
public Cube createCube()
Cube
. The new Cube
may be be added to an analytic workspace with the AddCube
method, or it may be added to a user-defined container.Cube
Cube
public ForecastDefinition createForecastDefinition()
ForecastDefinition
. The new ForecastDefinition
may be be added to an analytic workspace with the AddForecastDefinition
method, or it may be added to a user-defined container.ForecastDefinition
ForecastDefinition
public AllocationDefinition createAllocationDefinition()
AllocationDefinition
. The new AllocationDefinition
may be be added to an analytic workspace with the AddAllocationDefinition
method, or it may be added to a user-defined container.AllocationDefinition
AllocationDefinition
public AggregationDefinition createAggregationDefinition()
AggregationDefinition
. The new AggregationDefinition
may be be added to an analytic workspace with the AddAggregationDefinition
method, or it may be added to a user-defined container.AggregationDefinition
AggregationDefinition
public AggregationSolve createAggregationSolve()
AggregationSolve
. The new AggregationSolve
may be be added to an analytic workspace with the AddAggregationSolve
method, or it may be added to a user-defined container.AggregationSolve
AggregationSolve
public AggregationSolve createAggregationSolveAfter(Solve input)
AggregationSolve
after the specified Solve
in the analytic workspace.input
- A Solve
.AggregationSolve
that should be preceded by the Solve
.public AggregationSolve createAggregationSolveBefore(Solve input)
AggregationSolve
before the specified Solve
in the analytic workspace.input
- A Solve
.AggregationSolve
that should precede the Solve
.public AggregationSolve createAggregationSolveFirst()
AggregationSolve
in a series of AggregationSolve
objects in the analytic workspace.AggregationSolve
that should be first in the series.public AllocationSolve createAllocationSolve()
AllocationSolve
. The new AllocationSolve
may be be added to an analytic workspace with the AddAllocationSolve
method, or it may be added to a user-defined container.AllocationSolve
AllocationSolve
public AllocationSolve createAllocationSolveAfter(Solve input)
AllocationSolve
after the specified Solve
in the analytic workspace.input
- A Solve
.AllocationSolve
that should be preceded by the Solve
.public AllocationSolve createAllocationSolveBefore(Solve input)
AllocationSolve
before the specified Solve
in the analytic workspace.input
- A Solve
.AllocationSolve
that should precede the Solve
.public AllocationSolve createAllocationSolveFirst()
AllocationSolve
in a series of AllocationSolve
objects in the analytic workspace.AllocationSolve
that should be first in the series.public ForecastSolve createForecastSolve()
ForecastSolve
. The new ForecastSolve
may be be added to an analytic workspace with the AddForecastSolve
method, or it may be added to a user-defined container.ForecastSolve
ForecastSolve
public ForecastSolve createForecastSolveAfter(Solve input)
ForecastSolve
after the specified Solve
in the analytic workspace.input
- A Solve
.ForecastSolve
that should be preceded by the Solve
.public ForecastSolve createForecastSolveBefore(Solve input)
ForecastSolve
before the specified Solve
in the analytic workspace.input
- A Solve
.ForecastSolve
that should precede the Solve
.public ForecastSolve createForecastSolveFirst()
ForecastSolve
in a series of ForecastSolve
objects in the analytic workspace.ForecastSolve
that should be first in the series.public Model createModel()
Model
. A Model
is a workspace object that contains a set of interrelated equations. The results of a model can be assigned to a derived measure or dimension member.
The new Model
may be be added to an analytic workspace with the AddModel
method, or it may be added to a user-defined container.
Model
Model
public java.lang.String Create(AWConnection connection)
connection
- an AWConnection
String
public void Attach(AWConnection connection, java.lang.String mode)
connection
- an AWConnection
mode
- a String
specifying the attach mode. "RO" for read-only. "RW" for read-write.public void Detach(AWConnection connection)
connection
- an AWConnection
public void Commit(AWConnection connection)
connection
- an AWConnection
public static AW readAWDefinitions(AWConnection connection, java.lang.String awName)
AW
.connection
- an AWConnection
awName
- a String
specifying the name of an analytic workspaceAW
containing the object definitionspublic Dimension findDimension(java.lang.String inputName)
public Cube findCube(java.lang.String inputName)
public AggregationDefinition findAggregationDefinition(java.lang.String name)
public AllocationDefinition findAllocationDefinition(java.lang.String name)
public ForecastDefinition findForecastDefinition(java.lang.String name)
public static void getPhysicalMetaDataNames(AWConnection connection)
public static AW readAWTopLevelDefinitions(AWConnection connection, java.lang.String awName)
AW
.connection
- an AWConnection
awName
- a String
specifying the name of an analytic workspaceAW
containing the object definitions
|
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 |