Oracle® OLAP Analytic Workspace Java API Reference
10g Release 2 (10.2)

B14351-01

oracle.AWXML
Class AWObject

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.AWObject
Direct Known Subclasses:
Cube, Dimension, Hierarchy, HierarchyLevelAssociation, MemberSelection

public abstract class AWObject
extends BaseObject

A BaseObject that supports attributes and that can be mapped to a relational source. The mapping to the relational data source should populate the MappingGroup objects of the AWObject.


Fields inherited from class oracle.AWXML.BaseObject
DATABASENULL

Constructor Summary
AWObject(BaseObject input)
Creates an AWObject that is owned by the specified BaseObject.

Method Summary
void addAttribute(Attribute input)
Adds an Attribute to the collection of Attribute objects owned by this AWObject.
void addAttributeProjection(AttributeProjection input)
Adds the specified AttributeProjection to the collection of Attribute objects owned by this AWObject.
void addSourceCubeMapGroup(CubeMapGroup input)
Adds a DimensionMapGroup to the collection of MappingGroup objects that are owned by this AWObject.
void addSourceDimensionMapGroup(DimensionMapGroup input)
Adds a DimensionMapGroup to the collection of MappingGroup objects that are owned by this AWObject.
void addSourceMappingGroup(MappingGroup input)
Adds a MappingGroup to the collection of MappingGroup objects owned by this AWObject.
Attribute createAttribute()
Creates a new Attribute and adds it to the collection of Attribute objects for this instance.
AttributeProjection createAttributeProjection()
Creates a new AttributeProjection and adds it to the collection of Attribute objects for this instance.
CubeMapGroup createSourceCubeMapGroup()
Creates a new CubeMapGroup and adds it to the collection of MappingGroup objects for this AWObject.
DimensionMapGroup createSourceDimensionMapGroup()
Creates a new DimensionMapGroup and adds it to the collection of MappingGroup objects for this AWObject.
java.util.Vector getAttributes()
Gets the collection of Attribute or AttributeProjection objects that are owned by this AWObject.
java.util.Vector getSourceMapGroup()
Gets the collection of MappingGroup objects that are owned by this AWObject.
void removeAttribute(Attribute input)
Removes the specified Attribute from the collection of Attribute objects that are owned by this AWObject.
void removeAttributeProjection(Attribute input)
Removes the specified Attribute from the collection of Attribute objects that are owned by this AWObject.
void removeAttributeProjection(AttributeProjection input)
Removes the specified AttributeProjection from the collection of Attribute objects that are owned by this AWObject.
void removeSourceMappingGroup(MappingGroup input)
Removes the MappingGroup from the collection of MappingGroup objects that are owned by this AWObject.
java.lang.String WriteToXML()
Represents the AWObject as an XML string.

Methods inherited from class oracle.AWXML.BaseObject
Alter, Create, 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

AWObject

public AWObject(BaseObject input)
Creates an AWObject that is owned by the specified BaseObject. Factory methods such as AW.createCube() use this constructor when the object thqt they create is owned by another object.
Parameters:
input - The BaseObject that owns the new AWObject.

Method Detail

WriteToXML

public java.lang.String WriteToXML()
Represents the AWObject as an XML string.
Overrides:
WriteToXML in class BaseObject
Returns:
A String that contains an XML representation of the object.

addAttribute

public void addAttribute(Attribute input)
Adds an Attribute to the collection of Attribute objects owned by this AWObject. You can use this method to move an Attribute from one AWObject to another.

This method makes this AWObject the current owner of the specified Attribute. Therefore if you leave the Attribute in its original container, then a runtime error is generated in the originating container.

Parameters:
input - The Attribute that you want to add to this AWObject.

removeAttribute

public void removeAttribute(Attribute input)
Removes the specified Attribute from the collection of Attribute objects that are owned by this AWObject.
Parameters:
input - The Attribute that you want to remove from this AWObject.

addAttributeProjection

public void addAttributeProjection(AttributeProjection input)
Adds the specified AttributeProjection to the collection of Attribute objects owned by this AWObject. You can use this method to move an AttributeProjection from one AWObject to another.

This method makes this AWObject the current owner of the specified AttributeProjection. Therefore if you leave the AttributeProjection in its original container, then a runtime error is generated in the originating container.

Parameters:
input - The AttributeProjection that you want to add to this AWObject.

removeAttributeProjection

public void removeAttributeProjection(AttributeProjection input)
Removes the specified AttributeProjection from the collection of Attribute objects that are owned by this AWObject.
Parameters:
input - The AttributeProjection that you want to remove from this AWObject.

removeAttributeProjection

public void removeAttributeProjection(Attribute input)
Removes the specified Attribute from the collection of Attribute objects that are owned by this AWObject.
Parameters:
input - The Attribute that you want to remove from this AWObject.

getAttributes

public java.util.Vector getAttributes()
Gets the collection of Attribute or AttributeProjection objects that are owned by this AWObject.
Returns:
A Vector containing the Attribute or AttributeProjection objects that are owned by this AWObject.

addSourceMappingGroup

public void addSourceMappingGroup(MappingGroup input)
Adds a MappingGroup to the collection of MappingGroup objects owned by this AWObject.
Parameters:
input - The MappingGroup that you want to add to the source mappings for this AWObject.

removeSourceMappingGroup

public void removeSourceMappingGroup(MappingGroup input)
Removes the MappingGroup from the collection of MappingGroup objects that are owned by this AWObject.
Parameters:
input - The MappingGroup that you want to remove from the source mappings for this AWObject.

addSourceDimensionMapGroup

public void addSourceDimensionMapGroup(DimensionMapGroup input)
Adds a DimensionMapGroup to the collection of MappingGroup objects that are owned by this AWObject. Use this method for instances of the Dimension, Hierarchy, Level, or a HierarchyLevelAssociation classes.
Parameters:
input - The DimensionMapGroup that you want to add to the collection of MappingGroup objects that are owned by this AWObject.

addSourceCubeMapGroup

public void addSourceCubeMapGroup(CubeMapGroup input)
Adds a DimensionMapGroup to the collection of MappingGroup objects that are owned by this AWObject. Use this method for an instance of the Cube class.
Parameters:
input - The CubeMapGroup that you want to add to the collection of MappingGroup objects that are owned by this AWObject.

getSourceMapGroup

public java.util.Vector getSourceMapGroup()
Gets the collection of MappingGroup objects that are owned by this AWObject.
Returns:
A Vector that contains the MappingGroup objects of this AWObject.

createAttribute

public Attribute createAttribute()
Creates a new Attribute and adds it to the collection of Attribute objects for this instance. Use this method only with a Dimension object. For an Attribute of a Hierarchy, HierarchyLevelAssociation, or Level object, use the createAttributeProjection method.
Returns:
A new Attribute that is added to the collection of Attribute objects for this AWObject.

createAttributeProjection

public AttributeProjection createAttributeProjection()
Creates a new AttributeProjection and adds it to the collection of Attribute objects for this instance. Use this method only with a Hierarchy, HierarchyLevelAssociation, or Level object.
Returns:
A new AttributeProjection that is added to the collection of Attribute objects for this AWObject.

createSourceDimensionMapGroup

public DimensionMapGroup createSourceDimensionMapGroup()
Creates a new DimensionMapGroup and adds it to the collection of MappingGroup objects for this AWObject.
Returns:
A new DimensionMapGroup that is added to the collection of MappingGroup objects for this AWObject.

createSourceCubeMapGroup

public CubeMapGroup createSourceCubeMapGroup()
Creates a new CubeMapGroup and adds it to the collection of MappingGroup objects for this AWObject.
Returns:
A new CubeMapGroup that is added to the collection of MappingGroup objects for this AWObject.

Oracle® OLAP Analytic Workspace Java API Reference
10g Release 2 (10.2)

B14351-01

Copyright © 2003, 2005 Oracle. All rights reserved.