oracle.AWXML
Class MeasureFolder

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

public class MeasureFolder

extends BaseObject

A collection of measures.

Measure folders provide a mechanism for grouping measures according to the needs of an application. For example, you might create separate measure folders for financials, sales, and human resources.

Measures from different cubes can be assigned to the same measure folder.

Measure folders can be nested within other measure folders.

MeasureFolder does not participate in the object model hierarchy. Measures can be grouped in measure folders, but they are owned by cubes.

Fields inherited from class oracle.AWXML.BaseObject

DATABASENULL

Constructor Summary

MeasureFolder()
Creates a MeasureFolder.

MeasureFolder(BaseObject input)
Creates a MeasureFolder for the specified parent MeasureFolder.

Method Summary

void	addMeasure(Measure input) Adds the specified Measure to the MeasureFolder.
void	addMeasureFolder(MeasureFolder input) Adds the specified MeasureFolder to the MeasureFolder.
java.lang.String	Create(AWConnection connection) Creates the MeasureFolder in the current analytic workspace of the specified database connection.
MeasureFolder	createMeasureFolder() Creates a measure folder in the MeasureFolder.
java.lang.String	Delete(AWConnection connection) Deletes the MeasureFolder in the current analytic workspace of the specified database connection.
java.lang.String	getId() Returns the full name of the MeasureFolder.
java.util.Vector	getMeasureFolders() Returns the nested measure folders in the MeasureFolder.
java.util.Vector	getMeasures() Returns the measures in the MeasureFolder.
void	readAWMetaData(AWConnection connection) Reads the measures and nested folders in the MeasureFolder into memory, making them available for processing within the current analytic workspace of the specified database connection.
void	removeMeasure(Measure input) Removes the specified Measure from the MeasureFolder.
void	removeMeasureFolder(MeasureFolder input) Removes the specified MeasureFolder from the MeasureFolder.
java.lang.String	WriteToXML() Returns the MeasureFolder as an XML string.

Methods inherited from class oracle.AWXML.BaseObject

Alter, CreateAfter, CreateBefore, CreateFirst, DataRead, getColumnName, 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

MeasureFolder

public MeasureFolder()

Creates a MeasureFolder.

MeasureFolder

public MeasureFolder(BaseObject input)

Creates a MeasureFolder for the specified parent MeasureFolder.

Parameters:

input - The MeasureFolder that is the parent of the new MeasureFolder.

Method Detail

getId

public java.lang.String getId()

Returns the full name of the MeasureFolder.

The full name includes the simple logical name, the name space to which the object belongs, and the object type. For example, the full name of a nested measure folder called ACCOUNT1 whose parent folder is called SALES is:

SALES.ACCOUNT1.MEASUREFOLDER

Overrides:

getId in class BaseObject

Returns:

The full name of the MeasureFolder.

createMeasureFolder

public MeasureFolder createMeasureFolder()

Creates a measure folder in the MeasureFolder.

Returns:

The nested MeasureFolder.

addMeasureFolder

public void addMeasureFolder(MeasureFolder input)

Adds the specified MeasureFolder to the MeasureFolder.

Parameters:

input - The MeasureFolder to add.

removeMeasureFolder

public void removeMeasureFolder(MeasureFolder input)

Removes the specified MeasureFolder from the MeasureFolder.

Parameters:

input - The MeasureFolder to remove.

getMeasureFolders

public java.util.Vector getMeasureFolders()

Returns the nested measure folders in the MeasureFolder.

Returns:

A Vector of MeasureFolder objects.

addMeasure

public void addMeasure(Measure input)

Adds the specified Measure to the MeasureFolder.

Parameters:

input - The Measure to add.

removeMeasure

public void removeMeasure(Measure input)

Removes the specified Measure from the MeasureFolder.

Parameters:

input - The Measure to remove.

getMeasures

public java.util.Vector getMeasures()

Returns the measures in the MeasureFolder.

Returns:

A Vector of Measure objects.

WriteToXML

public java.lang.String WriteToXML()

Returns the MeasureFolder as an XML string.

Overrides:

WriteToXML in class BaseObject

Returns:

A String containing the XML that represents the MeasureFolder.

Create

public java.lang.String Create(AWConnection connection)

Creates the MeasureFolder in the current analytic workspace of the specified database connection.

Overrides:

Create in class BaseObject

Parameters:

connection - The AWConnection that represents the database connection.

Returns:

"success" if successful.

Delete

public java.lang.String Delete(AWConnection connection)

Deletes the MeasureFolder in the current analytic workspace of the specified database connection.

Overrides:

Delete in class BaseObject

Parameters:

connection - The AWConnection that represents the database connection.

Returns:

"success" if successful.

readAWMetaData

public void readAWMetaData(AWConnection connection)

Reads the measures and nested folders in the MeasureFolder into memory, making them available for processing within the current analytic workspace of the specified database connection.

Parameters:

connection - The AWConnection that specifies the database connection.