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

B14351-01

oracle.AWXML
Class DimensionMapGroup

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.MappingGroup
              |
              +--oracle.AWXML.DimensionMapGroup

public class DimensionMapGroup
extends MappingGroup

A MappingGroup that specifies data source mapping expressions for a Dimension. The mappings specify the relational columns that contain dimension members and attributes.

A DimensionMapGroup can be owned by a Dimension, a Hierarchy, a Level, or a HierarchyLevelAssociation. Within the DimensionMapGroup some or all of the dimension members or attributes can be mapped.

Use the oracle.AWAction.BuildDatabase class to load data into analytic workspace dimensions and attributes from the mapped data source.

See Also:
CubeMapGroup, BuildDatabase

Fields inherited from class oracle.AWXML.BaseObject
DATABASENULL

Constructor Summary
DimensionMapGroup(BaseObject input)
Creates a DimensionMapGroup for the specified Dimension, Hierarchy, Level, or HierarchyLevelAssociation.

Method Summary
void addAttributeMap(AttributeSourceExpression input)
Adds the specified AttributeSourceExpression to the DimensionMapGroup.
void addAttributeSourceExpression(AttributeSourceExpression input)
Adds the specified AttributeSourceExpression to the DimensionMapGroup.
java.lang.String Create(AWConnection connection)
Creates the DimensionMapGroup in the current analytic workspace of the specified database connection.
AttributeSourceExpression CreateAttributeMap()
Creates an AttributeSourceExpression in the DimensionMapGroup.
AttributeSourceExpression CreateAttributeMap(java.lang.String lang)
Creates an AttributeSourceExpression with the specified langugage in the DimensionMapGroup.
DimensionKeySourceExpression CreateKeyMap()
Creates a DimensionKeySourceExpression in the DimensionMapGroup.
HierarchicalParentSourceExpression CreateParentMap()
Creates a HierarchicalParentSourceExpression in the DimensionMapGroup.
java.util.Vector getAttributeMaps()
Returns the attribute maps in the DimensionMapGroup.
DimensionKeySourceExpression getKeyMap()
Returns the DimensionKeySourceExpression in the DimensionMapGroup.
HierarchicalParentSourceExpression getParentMap()
Returns the key column for the workspace hierarchy.
void removeAttributeMap(AttributeSourceExpression input)
Removes the specified AttributeSourceExpression from the DimensionMapGroup.
void setDimensionKeySourceExpression(DimensionKeySourceExpression input)
Sets the dimension member map to the specified DimensionKeySourceExpression.
void setHierarchicalParentSourceExpression(HierarchicalParentSourceExpression input)
Sets the parent level map to the specified HierarchialParentSourceExpression.
void setKeyMap(DimensionKeySourceExpression input)
Sets the dimension member map to the specified DimensionKeySourceExpression.
void setParentMap(HierarchicalParentSourceExpression input)
Sets the parent level map to the specified HierarchialParentSourceExpression.
java.lang.String WriteToXML()
Gets an XML representation of the DimensionMapGroup.

Methods inherited from class oracle.AWXML.MappingGroup
Delete

Methods inherited from class oracle.AWXML.BaseObject
Alter, CreateAfter, CreateBefore, CreateFirst, DataRead, 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

DimensionMapGroup

public DimensionMapGroup(BaseObject input)
Creates a DimensionMapGroup for the specified Dimension, Hierarchy, Level, or HierarchyLevelAssociation.
Parameters:
input - The Dimension, Hierarchy, Level, or HierarchyLevelAssociation that owns the new DimensionMapGroup.

Method Detail

WriteToXML

public java.lang.String WriteToXML()
Gets an XML representation of the DimensionMapGroup.
Overrides:
WriteToXML in class MappingGroup
Returns:
A String that is an XML representation of the DimensionMapGroup.

getKeyMap

public DimensionKeySourceExpression getKeyMap()
Returns the DimensionKeySourceExpression in the DimensionMapGroup.
Returns:
The DimensionKeySourceExpression.

setKeyMap

public void setKeyMap(DimensionKeySourceExpression input)
Sets the dimension member map to the specified DimensionKeySourceExpression.
Parameters:
input - The DimensionKeySourceExpression.

setDimensionKeySourceExpression

public void setDimensionKeySourceExpression(DimensionKeySourceExpression input)
Sets the dimension member map to the specified DimensionKeySourceExpression.

This method is the functional equivalent of setKeyMap. It exists to satisfy internal requirements of the API.

Parameters:
input - The DimensionKeySourceExpression.

getParentMap

public HierarchicalParentSourceExpression getParentMap()
Returns the key column for the workspace hierarchy.
Returns:
A HierarchialParentSourceExpression for a Hierarchy or HierarchyLevelAssociation

setParentMap

public void setParentMap(HierarchicalParentSourceExpression input)
Sets the parent level map to the specified HierarchialParentSourceExpression.

This method is only used when the DimensionMapGroup is owned by a HierarchyLevelAssociation.

Parameters:
input - The HierarchialParentSourceExpression.

setHierarchicalParentSourceExpression

public void setHierarchicalParentSourceExpression(HierarchicalParentSourceExpression input)
Sets the parent level map to the specified HierarchialParentSourceExpression.

This method is only used when the DimensionMapGroup is owned by a HierarchyLevelAssociation.

This method is the functional equivalent of setParentMap. It exists to satisfy internal requirements of the API.

Parameters:
input - The HierarchialParentSourceExpression.

addAttributeMap

public void addAttributeMap(AttributeSourceExpression input)
Adds the specified AttributeSourceExpression to the DimensionMapGroup.
Parameters:
input - The AttributeSourceExpression to add.

removeAttributeMap

public void removeAttributeMap(AttributeSourceExpression input)
Removes the specified AttributeSourceExpression from the DimensionMapGroup.
Parameters:
input - The AttributeSourceExpression to remove.

addAttributeSourceExpression

public void addAttributeSourceExpression(AttributeSourceExpression input)
Adds the specified AttributeSourceExpression to the DimensionMapGroup.

This method is the functional equivalent of addAttributeMap. It exists to satisfy internal requirements of the API.

Parameters:
input - The AttributeSourceExpression to add.

getAttributeMaps

public java.util.Vector getAttributeMaps()
Returns the attribute maps in the DimensionMapGroup.
Returns:
A Vector of AttributeSourceExpression objects.

CreateKeyMap

public DimensionKeySourceExpression CreateKeyMap()
Creates a DimensionKeySourceExpression in the DimensionMapGroup.
Returns:
The new DimensionKeySourceExpression.

CreateParentMap

public HierarchicalParentSourceExpression CreateParentMap()
Creates a HierarchicalParentSourceExpression in the DimensionMapGroup.

This method is only used when the DimensionMapGroup is owned by a HierarchyLevelAssociation.

Returns:
The new HierarchicalParentSourceExpression.

CreateAttributeMap

public AttributeSourceExpression CreateAttributeMap()
Creates an AttributeSourceExpression in the DimensionMapGroup.
Returns:
The new AttributeSourceExpression.

CreateAttributeMap

public AttributeSourceExpression CreateAttributeMap(java.lang.String lang)
Creates an AttributeSourceExpression with the specified langugage in the DimensionMapGroup.
Parameters:
lang - A String that specifies the language for the AttributeSourceExpression.
Returns:
The new AttributeSourceExpression.

Create

public java.lang.String Create(AWConnection connection)
Creates the DimensionMapGroup in the current analytic workspace of the specified database connection.
Overrides:
Create in class BaseObject
Parameters:
connection - The AWConnection that specifies the database connection.
Returns:
"success" if successful.

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

B14351-01

Copyright © 2003, 2005 Oracle. All rights reserved.