Oracle OLAP Analytic Workspace Java API Reference: Class DimensionMapGroup

Overview

Package

Class

Tree

Deprecated

Index

Help

Oracle OLAP Analytic Workspace Java API Reference
10g Release 1 (10.1)
B12180-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.AWXML
Class DimensionMapGroup

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

public class DimensionMapGroup
extends MappingGroup

Defines a set of mappings for a dimension. The mappings specify the relational columns that contain the source data for the dimension's members and attributes.

You can specify a mapping for a dimension as a whole, or you can map individual levels or hierarchies. Levels can be mapped within a hierarchical context (a HierarchyLevelAssociation) or they can be mapped individually.

Use the oracle.AWAction.BuildDatabase class to execute the mappings and load data into the dimension.

See Also:: oracle.AWXML.CubeMapGroup

Field Summary
`protected java.util.Vector`	`m_attributeMaps`
`protected DimensionKeySourceExpression`	`m_keyMap`
`protected HierarchicalParentSourceExpression`	`m_parentMap`

Fields inherited from class oracle.AWXML.BaseObject

AWNULL, DATABASENULL, m_commandResults, m_commandResultText, m_id, m_listResults, m_longName, m_name, m_owner, m_pluralName, m_schema, m_shortName, s_EndElementTag, s_EndEndTag, s_EndStartTag, s_EndTag, s_Indent, s_JAVA_LINEEND, s_NEWLINE, s_objectCounter, s_StartEndTag, s_StartStartTag

Constructor Summary
`DimensionMapGroup(BaseObject input)` Constructor for a `DimensionMapGroup`.

Method Summary
`void`	`addAttributeMap(AttributeSourceExpression input)` Adds an attribute mapping to the `DimensionMapGroup`
`void`	`addAttributeSourceExpression(AttributeSourceExpression input)` Adds a workspace attribute to the mapping.
`java.lang.String`	`Create(AWConnection connection)` Creates a `DimensionMapGroup` in the analytic workspace.
`AttributeSourceExpression`	`CreateAttributeMap()` Creates the mapping for a workspace attribute.
`DimensionKeySourceExpression`	`CreateKeyMap()` Creates the key mapping for the workspace object
`HierarchicalParentSourceExpression`	`CreateParentMap()` Creates the key mapping for the workspace hierarchy.
`java.util.Vector`	`getAttributeMaps()` Returns the attribute mappings for the dimension
`DimensionKeySourceExpression`	`getKeyMap()` Returns the key column for workspace object.
`HierarchicalParentSourceExpression`	`getParentMap()` Returns the key column for the workspace hierarchy.
`void`	`removeAttributeMap(AttributeSourceExpression input)` Removes an attribute mapping from the `DimensionMapGroup`
`void`	`setDimensionKeySourceExpression(DimensionKeySourceExpression input)` Specifies the workspace object for the mapping.
`void`	`setHierarchicalParentSourceExpression(HierarchicalParentSourceExpression input)` Specifies the workspace hierarchy for the mapping.
`void`	`setKeyMap(DimensionKeySourceExpression input)` Specifies the key column for the workspace object.
`void`	`setParentMap(HierarchicalParentSourceExpression input)` Specifies the key column for the workspace hierarchy.
`java.lang.String`	`WriteToXML()` Returns the object as an XML string.

Methods inherited from class oracle.AWXML.MappingGroup

Delete

Methods inherited from class oracle.AWXML.BaseObject

Alter, CreateAfter, CreateBefore, CreateFirst, getId, getLongName, getName, getOwner, getParentId, getPluralName, getSchema, getShortName, setLongName, setName, setPluralName, setSchema, setShortName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_keyMap

protected DimensionKeySourceExpression m_keyMap

m_parentMap

protected HierarchicalParentSourceExpression m_parentMap

m_attributeMaps

protected java.util.Vector m_attributeMaps

Constructor Detail

DimensionMapGroup

public DimensionMapGroup(BaseObject input)

Constructor for a DimensionMapGroup. Input can specify the mappings for dimension, a hierarchy, a level, or a hierarchical level.

Parameters:: input - A BaseObject that is a Dimension, a Hierarchy, a Level, or a HierarchyLevelAssociation

Method Detail

WriteToXML

public java.lang.String WriteToXML()

Returns the object as an XML string.

Overrides:: WriteToXML in class MappingGroup

Returns:: A String containing the XML that represents the object.

getKeyMap

public DimensionKeySourceExpression getKeyMap()

Returns the key column for workspace object.

Returns:: A DimensionKeySourceExpression

setKeyMap

public void setKeyMap(DimensionKeySourceExpression input)

Specifies the key column for the workspace object.

Parameters:: input - A DimensionKeySourceExpression

setDimensionKeySourceExpression

public void setDimensionKeySourceExpression(DimensionKeySourceExpression input)

Specifies the workspace object for the mapping.

Parameters:: input - A 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)

Specifies the key column for the workspace hierarchy.

Parameters:: input - HierarchialParentSourceExpression

setHierarchicalParentSourceExpression

public void setHierarchicalParentSourceExpression(HierarchicalParentSourceExpression input)

Specifies the workspace hierarchy for the mapping.

Parameters:: input - A HierarchialParentSourceExpression

addAttributeMap

public void addAttributeMap(AttributeSourceExpression input)

Adds an attribute mapping to the DimensionMapGroup

Parameters:: input - An AttributeSourceExpression

removeAttributeMap

public void removeAttributeMap(AttributeSourceExpression input)

Removes an attribute mapping from the DimensionMapGroup

Parameters:: input - An AttributeSourceExpression

addAttributeSourceExpression

public void addAttributeSourceExpression(AttributeSourceExpression input)

Adds a workspace attribute to the mapping.

Parameters:: input - An AttributeSourceExpression

getAttributeMaps

public java.util.Vector getAttributeMaps()

Returns the attribute mappings for the dimension

Returns:: A Vector containing the attribute mappings

CreateKeyMap

public DimensionKeySourceExpression CreateKeyMap()

Creates the key mapping for the workspace object

Returns:: A DimensionKeySourceExpression

CreateParentMap

public HierarchicalParentSourceExpression CreateParentMap()

Creates the key mapping for the workspace hierarchy.

Returns:: A HierarchicalParentSourceExpression

CreateAttributeMap

public AttributeSourceExpression CreateAttributeMap()

Creates the mapping for a workspace attribute.

Returns:: An AttributeSourceExpression

Create

public java.lang.String Create(AWConnection connection)

Creates a DimensionMapGroup in the analytic workspace.

Overrides:: Create in class BaseObject

Parameters:: connection - An AWConnection through which the command will be processed
Returns:: A String indicating if the call was successful. A successful invocation returns the value 'success'.