|
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
oracle.AWXML.AW
public class AW
Represents an analytic workspace.
An AW is a container for other Oracle OLAP Analytic Workspace
Java API objects.
For a diagram of AW class associations, see
AW Class Associations.
For a description and a diagram of the Analytic Workspace Java API object
model hierarchy, see
Object Hierarchy.
Within the object model hierarchy, an AW owns the top-level
objects assigned to it.
However, the AW does not participate in the lineage that
defines the namespace of the objects it owns.
Top-level objects owned by an AW exist within the namespace
of the relational schema.
The AW class has methods for adding objects to the analytic
workspace and creating objects in the analytic workspace.
These methods create the logical objects in memory and associate them with
the logical AW object.
For example, the addDimension method adds a
Dimension to the collection of objects associated with the
AW, but has no affect on any analytic workspace that exists
in the Oracle Database.
To create or modify an analytic workspace within the Oracle Database,
use methods that take an AWConnection argument.
To load and calculate data in the workspace, use the
BuildDatabase method in the AWAction package.
BuildDatabase| Field Summary |
|---|
| Fields inherited from class oracle.AWXML.BaseObject |
|---|
DATABASENULL |
| Constructor Summary | |
|---|---|
AW()
Creates an AW. |
|
| Method Summary | |
|---|---|
void |
addCube(Cube input)
Adds the specified Cube to the AW. |
void |
addDimension(Dimension input)
Adds the specified Dimension to the AW. |
void |
addLanguage(java.lang.String input)
Adds the specified language to the languages available to the analytic workspace. |
void |
addMeasureFolder(MeasureFolder input)
Adds the specified MeasureFolder
to the AW. |
void |
addSolveGroup(SolveGroup input)
Adds the specified SolveGroup
to the AW. |
void |
Attach(AWConnection connection,
java.lang.String mode)
Attaches the AW in the specified access mode within the
specified database connection. |
void |
Commit(AWConnection connection)
Commits the AW within the specified database connection. |
java.lang.String |
Create(AWConnection connection)
Creates the AW in the
specified database connection. |
Cube |
createCube()
Creates a Cube and adds it to the AW. |
Dimension |
createDimension()
Creates a Dimension and adds it to the AW. |
ExtendedProperty |
createGlobalAttributeExtension(java.lang.String name,
Attribute input,
AWConnection conn)
Creates an ExtendedProperty object, which is managed by the
analytic workspace, that extends the specified Attribute
so that it applies to to all Hierarchy,
HierarchyLevelAssociation, and Level objects
owned by the AW. |
void |
CreateLanguage(AWConnection connection,
java.lang.String language)
Adds the specified language to the languages available to the analytic workspace in memory and to the static analytic workspace. |
MeasureFolder |
createMeasureFolder()
Creates a MeasureFolder and adds it to the AW. |
SolveGroup |
createSolveGroup()
Creates a SolveGroup and adds it to the AW. |
void |
DeleteLanguage(AWConnection connection,
java.lang.String language)
Deletes the specified language from the languages available to the analytic workspace in memory and from the static analytic workspace. |
void |
Detach(AWConnection connection)
Detaches the AW within the specified database connection. |
Cube |
findCube(java.lang.String inputName)
Gets the specified Cube owned by the AW. |
Dimension |
findDimension(java.lang.String inputName)
Gets the specified Dimension owned by
the AW. |
java.util.Vector |
getCubes()
Gets the Cube objects associated with the
AW. |
static AW |
getCurAW()
Gets the current AW. |
java.lang.String |
getDefaultLanguage()
Gets the default language of the analytic workspace. |
java.util.Vector |
getDimensions()
Gets dimensions associated with the AW. |
java.util.Vector |
getLanguages()
Gets the languages that are available to the analytic workspace. |
java.util.Vector |
getMeasureFolders()
Gets the MeasureFolder objects
associated with the AW. |
double |
getMetaDataFormat()
Gets the metadata format of the Oracle Database instance. |
java.util.Vector |
getSolveGroups()
Gets the SolveGroup objects
associated with the AW. |
java.lang.String |
getTableSpace()
Gets the name of the tablespace in which the analytic workspace is stored in the relational database. |
static AW |
readAWDefinitions(AWConnection connection,
java.lang.String awName)
Attaches the specified analytic workspace for read-only access within the specified database connection; reads the objects owned by the workspace into memory, thereby making them available for processing. |
static AW |
readAWDefinitions(AWConnection connection,
java.lang.String awName,
java.lang.String attachMode)
Attaches an analytic workspace in the specified mode within a database connection; reads the objects owned by the workspace into memory, thereby making them available for processing. |
static AW |
readAWTopLevelDefinitions(AWConnection connection,
java.lang.String awName,
java.lang.String attachMode)
Attaches an analytic workspace in the specified access mode within the specified database connection; reads the top-level objects owned by the workspace into memory, thereby making them available for processing. |
void |
removeCube(Cube input)
Removes the specified Cube from the AW. |
void |
removeDimension(Dimension input)
Removes the specified Dimension from the AW. |
void |
removeLanguage(java.lang.String input)
Removes the specified language from the languages available to the analytic workspace. |
void |
removeMeasureFolder(MeasureFolder input)
Removes the specified MeasureFolder
from the AW. |
void |
removeSolveGroup(SolveGroup input)
Removes the specified SolveGroup
from the AW. |
static void |
setCurAW(AW input)
Specifies an AW as the current AW. |
void |
setDefaultLanguage(AWConnection connection,
java.lang.String input)
Specifies a default language for the analytic workspace. |
void |
setDefaultLanguage(java.lang.String input)
Specifies a default language for the analytic workspace. |
void |
setLanguages(java.lang.String input)
Specifies a set of languages for the analytic workspace. |
void |
setTableSpace(java.lang.String input)
Specifies the tablespace in which you want the relational database to store the analytic workspace. |
void |
ValidateDerivedMeasures(AWConnection connection)
Synchronizes the derived measures in memory with those in the stored analytic workspace. |
java.lang.String |
WriteToXML()
Gets an XML representation of the AW. |
| Methods inherited from class oracle.AWXML.BaseObject |
|---|
Alter, CreateAfter, CreateBefore, CreateFirst, DataRead, Delete, getColumnName, getId, 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 AW()
AW.
| Method Detail |
|---|
public static AW getCurAW()
AW.
AW that is currently active.public static void setCurAW(AW input)
AW as the current AW.
input - The AW that you want to be the active
AW.public void setTableSpace(java.lang.String input)
input - A String containing the name of the
tablespace in which to store the analytic workspace.public java.lang.String getTableSpace()
String containing the name of the
tablespace.public java.lang.String WriteToXML()
AW.
WriteToXML in class BaseObjectString that contains an XML representation
of the AW.public void addDimension(Dimension input)
Dimension to the AW.
input - The Dimension to add.public void removeDimension(Dimension input)
Dimension from the AW.
input - The Dimension to remove.public java.util.Vector getDimensions()
AW.
Vector that contains the
Dimension objects associated with the
AW.public void addCube(Cube input)
Cube to the AW.
input - The Cube to add.public void removeCube(Cube input)
Cube from the AW.
input - The Cube to remove.public java.util.Vector getCubes()
Cube objects associated with the
AW.
Vector that contains the Cube
objects associated with the AW.public Dimension createDimension()
Dimension and adds it to the AW.
Dimension.public Cube createCube()
Cube and adds it to the AW.
Cube.public java.lang.String Create(AWConnection connection)
AW in the
specified database connection.
Create in class BaseObjectconnection - The AWConnection that specifies the
database connection.
String that contains the value
success if the method succeeds.
public void Attach(AWConnection connection,
java.lang.String mode)
AW in the specified access mode within the
specified database connection.
The valid values for mode are the following.
RW specifies read/write access.RO specifies read-only access.RWX specifies read/write exclusive access.MULTI specifies multiwriter access.
connection - The AWConnection that specifies the
database connection.mode - A String that specifies the type of access
to the database.public void Detach(AWConnection connection)
AW within the specified database connection.
connection - The AWConnection that specifies the connection.public void Commit(AWConnection connection)
AW within the specified database connection.
connection - An AWConnection that specifies the
database connection.
public static AW readAWDefinitions(AWConnection connection,
java.lang.String awName)
connection - An AWConnection that specifies the
database connection.awName - A String that contains the name of the
analytic workspace.
AW with the specified name.
public static AW readAWDefinitions(AWConnection connection,
java.lang.String awName,
java.lang.String attachMode)
attachMode, see the
Attach
method.
connection - An AWConnection that specifies the
database connection.awName - A String that contains the name of the
analytic workspace.attachMode - A String that specifies the access mode.
AW with the specified name.public Dimension findDimension(java.lang.String inputName)
Dimension owned by
the AW.
inputName - The name of the Dimension to get.
Dimension.public Cube findCube(java.lang.String inputName)
Cube owned by the AW.
inputName - The name of the Cube to get.
Cube.public void addSolveGroup(SolveGroup input)
SolveGroup
to the AW.
input - The SolveGroup to add.public void removeSolveGroup(SolveGroup input)
SolveGroup
from the AW.
input - The SolveGroup to remove.public java.util.Vector getSolveGroups()
SolveGroup objects
associated with the AW.
Vector that contains the
SolveGroup objects of the AW.public SolveGroup createSolveGroup()
SolveGroup and adds it to the AW.
SolveGroup.public void addMeasureFolder(MeasureFolder input)
MeasureFolder
to the AW.
input - The MeasureFolder to add.public void removeMeasureFolder(MeasureFolder input)
MeasureFolder
from the AW.
input - The MeasureFolder to remove.public java.util.Vector getMeasureFolders()
MeasureFolder objects
associated with the AW.
Vector that contains the
MeasureFolder objects of the
AW.public MeasureFolder createMeasureFolder()
MeasureFolder and adds it to the AW.
MeasureFolder.
public static AW readAWTopLevelDefinitions(AWConnection connection,
java.lang.String awName,
java.lang.String attachMode)
Cube, Dimension,
and SolveGroup.
For the valid values for attachMode, see the
Attach
method.
connection - An AWConnection that specifies the
database connection.awName - A String that contains the name of the
analytic workspace.attachMode - A String that specifies the access mode.
AW with the specified name.
public ExtendedProperty createGlobalAttributeExtension(java.lang.String name,
Attribute input,
AWConnection conn)
ExtendedProperty object, which is managed by the
analytic workspace, that extends the specified Attribute
so that it applies to to all Hierarchy,
HierarchyLevelAssociation, and Level objects
owned by the AW.
name - A String that contains a name for the
attribute extension.input - The Attribute.conn - An AWConnection that specifies the
database connection.public void ValidateDerivedMeasures(AWConnection connection)
connection - The AWConnection that specifies the
database connection.public void setLanguages(java.lang.String input)
input object, separate the languages with double
colons, as in the following example.
aw.setLanguages("French::Spanish::German");
input - A String containing the names of the languages
that you want the analytic workspace to support.public java.util.Vector getLanguages()
Vector containing the languages that are available
to the analytic workspace.public void addLanguage(java.lang.String input)
AW.
aw.addLanguage("French");
input - The language to add to the analytic workspace.public void removeLanguage(java.lang.String input)
input - The language to remove from the analytic workspace.
public void CreateLanguage(AWConnection connection,
java.lang.String language)
AW object
and to the analytic workspace stored in the database.
aw.CreateLanguage("French");
connection - The AWConnection that specifies the
database connection.language - The language to add to the analytic workspace.
public void DeleteLanguage(AWConnection connection,
java.lang.String language)
connection - The AWConnection that specifies the
database connection.language - The language to delete from the analytic workspace.public java.lang.String getDefaultLanguage()
String containing the name of the default language.public void setDefaultLanguage(java.lang.String input)
input - A String containing the name of the language that
you want as the default language.
public void setDefaultLanguage(AWConnection connection,
java.lang.String input)
connection - The AWConnection that specifies the
database connection.input - A String containing the name of the language that
you want as the default language.public double getMetaDataFormat()
10.1 and 10.2.
double that indicates the metadata format of the
database instance.
|
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||