oracle.AWXML
Class AWObject

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

Direct Known Subclasses:

Cube, Dimension, Hierarchy, HierarchyLevelAssociation

public abstract class AWObject

extends BaseObject

An abstract class that defines the basic characteristics of a model object that supports attributes and can be mapped to a relational source. In the model, Cube, Dimension, Level, Hierarchy and HierarchyLevelAssociation objects can be mapped to a relational source.

The original mapping to the relational data source should populate the SourceMapGroup. To override the original mapping during a refresh, populate the RefreshMapGroup structures for the objects whose mapping specifications have changed. If the RefreshMapGroup structures are populated, they are used during a refresh. Otherwise the original mappings in the SourceMapGroup are used.

Use the following link to view a graphical representation of oracle.AWXML.AWObject.

OLAP Analytic Workspace AWObject Model

m_attributes

protected java.util.Vector m_attributes

m_sourceMapGroup

protected java.util.Vector m_sourceMapGroup

m_refreshMapGroup

protected java.util.Vector m_refreshMapGroup

AWObject

public AWObject(BaseObject input)

This constructor is used by the object factories when an object in the model is owned.

Parameters:

input - A BaseObject

WriteToXML

public java.lang.String WriteToXML()

Returns the object as an XML string.

Overrides:

WriteToXML in class BaseObject

Returns:

A String containing the XML that represents the object.

addAttribute

public void addAttribute(Attribute input)

Adds an Attribute to this object's collection of attributes. This method can be used to move an Attribute from one Object to another. This method will set the current Owner of the input Attribute to the Object. Therefore if the Attribute is left in its original container, it will generate a runtime error in the originating container.

Parameters:

input - An Attribute

Returns:

 

removeAttribute

public void removeAttribute(Attribute input)

Remove the specified Attributerom the set of owned Attributes.

Parameters:

input - An Attribute

addAttributeProjection

public void addAttributeProjection(AttributeProjection input)

Adds an AttributeProjection to this object's collection of attributes. This method can be used to move an AttributeProjection from one Object to another. This method will set the current Owner of the input AttributeProjection to the Object. Therefore if the AttributeProjection is left in its original container, it will generate a runtime error in the originating container.

Parameters:

input - An AttributeProjection

removeAttributeProjection

public void removeAttributeProjection(AttributeProjection input)

Remove the specified AttributeProjection from the set of owned Attributes.

Parameters:

input - An AttributeProjection

getAttributes

public java.util.Vector getAttributes()

Returns the list of Attributes owned by this object. Note: The list will return either a set of Attributes or AttributeProjections depending on the specific sub-type instance.

Returns:

A Vector containing the set of Attributes.

addSourceMappingGroup

public void addSourceMappingGroup(MappingGroup input)

Add a source mapping to the collection of source mappings. This method can be used to add a source mapping group to the collection. This method will set the owner of the MappingGroup to this instance.

Parameters:

input - A MappingGroup to add the Source Mappings

removeSourceMappingGroup

public void removeSourceMappingGroup(MappingGroup input)

Remove the MappingGroup from the list of source mappings.

Parameters:

input - A MappingGroup to remove the Source Mappings

addSourceDimensionMapGroup

public void addSourceDimensionMapGroup(DimensionMapGroup input)

Add a dimension source mapping to the collection of source mappings. This method can be used to add a dimension source mapping group to the collection. This method will set the owner of the DimensionMapGroup to this instance. The use of this method is for sub-type instances that are in the dimension portion of the object model

Parameters:

input - A DimensionMapGroup to add the Source Mappings

addSourceCubeMapGroup

public void addSourceCubeMapGroup(CubeMapGroup input)

Add a cube source mapping to the collection of source mappings. This method can be used to add a cube source mapping group to the collection. This method will set the owner of the CubeMapGroup to this instance. The use of this method is for sub-type instances that are in the cube portion of the object model

Parameters:

input - A CubeMapGroup to add the Source Mappings

getSourceMapGroup

public java.util.Vector getSourceMapGroup()

Return the collection of source mappings

Returns:

A Vector containing a set of source maps.

addRefreshMapGroup

public void addRefreshMapGroup(MappingGroup input)

Add a refresh mapping to the collection of refresh mappings. This method can be used to add a mapping group to the collection. This method will set the owner of the MappingGroup to this instance.

Parameters:

input - A MappingGroup to add the Refresh Mappings

getRefreshMapGroup

public java.util.Vector getRefreshMapGroup()

Return the set of refresh map groups.

Returns:

A Vector containing a set of refresh map groups.

createAttribute

public Attribute createAttribute()

A Factory for an Attribute and add it to the list of Attributes for this instance. This method can only be used on a Dimension object. For Attributes of Level, Hierarchy, or HierarchyLevelAssociation objects, use createAttributeProjection.

Returns:

A new Attribute

createAttributeProjection

public AttributeProjection createAttributeProjection()

A Factory for an AttributeProjection and add it to the list of Attributes for this instance. This method can only be used on a either a Level, Hierarchy or HierarchyLevelAssociation object.

Returns:

A new AttributeProjection

createSourceDimensionMapGroup

public DimensionMapGroup createSourceDimensionMapGroup()

A Factory for a DimensionMapGroup and add it to the list of SourceMappings for this instance.

Returns:

A new DimensionMapGroup

createSourceCubeMapGroup

public CubeMapGroup createSourceCubeMapGroup()

A Factory for a CubeMapGroup and add it to the list of SourceMappings for this instance.

Returns:

A new CubeMapGroup