oracle.owb.mapping
Interface Map

All Superinterfaces:

CompilableObject, Component, Extensible, Folder, MapHelper, OWBNamedObject, PropertyOwner, Snapshotable, ValidatableObject

public interface Map

extends MapHelper, Folder, Extensible, PropertyOwner, ValidatableObject, CompilableObject

Map is the interface that provides housekeeping for the map operators within a map. It can also retrieve special sets of operators within the map, and create new bound or unbound operators. The Map interface extends Folder, because internally a map is a folder. Currently however, no contained objects are supported for a map.

Fields inherited from interface oracle.owb.mapping.MapHelper

OPERATOR_TYPES, OPTYPE_ADVANCEDQUEUE, OPTYPE_AGGREGATOR, OPTYPE_CONSTANT, OPTYPE_CUBE, OPTYPE_DATA_GENERATOR, OPTYPE_DEDUPLICATOR, OPTYPE_DIMENSION, OPTYPE_EXPRESSION, OPTYPE_EXTERNAL_TABLE, OPTYPE_FILTER, OPTYPE_FLAT_FILE, OPTYPE_GENERICDATASOURCETARGET, OPTYPE_INPUT_PARAMETER, OPTYPE_JOINER, OPTYPE_KEY_LOOKUP, OPTYPE_MATCHMERGE, OPTYPE_MATERIALIZED_VIEW, OPTYPE_NAME_AND_ADDRESS, OPTYPE_OUTPUT_PARAMETER, OPTYPE_PIVOT, OPTYPE_POSTMAPPING_PROCESS, OPTYPE_PREMAPPING_PROCESS, OPTYPE_SEQUENCE, OPTYPE_SET_OPERATION, OPTYPE_SORTER, OPTYPE_SPLITTER, OPTYPE_TABLE, OPTYPE_TABLE_FUNCTION, OPTYPE_TRANSFORMATION, OPTYPE_UNPIVOT, OPTYPE_VIEW

Fields inherited from interface oracle.owb.metadatamgmt.changemgmt.Snapshotable

MAX_DEPENDENCY_DEPTH, MIN_DEPENDENCY_DEPTH

Method Summary

void	compressMap() Compress the map.
MapOperator	createMapOperator(java.lang.String operatorType, ReconcileSource sourceObject) Create a bound map operator and add it to this map.
MapOperator	createMapOperator(java.lang.String name, java.lang.String operatorType) Create a map operator of the specified type and name, and add it to this map.
MapOperator	createMapOperator(java.lang.String name, java.lang.String operatorType, ReconcileSource sourceObject) Create a bound map operator with the specified name and add it to this map.
MapOperator	findMapOperator(java.lang.String name) Find an operator in the map with the specified name.
MapOperator[]	getMapOperators() Gets all the map operators in this map.
MapOperator[]	getMapOperators(java.lang.String operatorType) Gets all the map operators of a specified type in this map.
Module	getModule() Returns the Module that owns this map.
java.lang.String[]	getOperatorTypes() Returns an array of all the defined operator type constants.
MapOperator[]	getSources() Gets all the map operators that are functioning as sources in the map.
MapOperator[]	getTargets() Gets all the map operators that are functioning as targets in the map.
java.lang.String[]	getValidStepTypeValues() Returns an array of all the valid step types.

Methods inherited from interface oracle.owb.foundation.Folder

findChild, getContentTypes, getFolderContents, getFolderContentsOfType, isCascadeForSnapshot, lockShared, lockWithContents, reloadWithContents, setCascadeForSnapshot

Methods inherited from interface oracle.owb.foundation.Component

getOwningFolder, isReloadNeeded, lock, reload, unlock

Methods inherited from interface oracle.owb.foundation.OWBNamedObject

delete, getBusinessName, getClassDefinition, getComponent, getDescription, getName, getUOID, isDeletable, isEditable, isRenamable, setBusinessName, setDescription, setName

Methods inherited from interface oracle.owb.metadatamgmt.changemgmt.Snapshotable

compare, compare, compare, compare, createSnapshot, createSnapshot, createSnapshotWithDependeeComponents, createSnapshotWithDependeeComponents, getSnapshots

Methods inherited from interface oracle.owb.foundation.property.PropertyOwner

getDefaultPropertyValue, getLogicalPropertyKeys, getPhysicalPropertyKeys, getPropertyDomain, getPropertyKeys, getPropertyValue, getPropertyValueString, isLogicalProperty, isPhysicalProperty, isReadOnlyProperty, setPropertyValue, setPropertyValueByString

Methods inherited from interface oracle.owb.compile.ValidatableObject

validate

Methods inherited from interface oracle.owb.compile.CompilableObject

compile

Method Detail

getModule

public Module getModule()

Returns the Module that owns this map.

Returns:

The module that owns this map.

getMapOperators

public MapOperator[] getMapOperators()
                              throws OWBException

Gets all the map operators in this map.

Returns:

A list of all the map operators in this map with no particular ordering. Returns null if there are no operators in the map.

Throws:

OWBException - if any internal error is encountered.

getMapOperators

public MapOperator[] getMapOperators(java.lang.String operatorType)
                              throws OWBException

Gets all the map operators of a specified type in this map.

Parameters:

operatorType - The type of the operators to be returned. Valid types are defined as constants (prefix OPTYPE_), which can be found in the MapHelper interface.

Returns:

A list of all the map operators of the specified type in this map with no particular ordering. Returns null if there are no operators of the specified type in the map.

Throws:

OWBException - if any internal error is encountered.

getSources

public MapOperator[] getSources()
                         throws OWBException

Gets all the map operators that are functioning as sources in the map.

Returns:

A list of all the sources in the map with no particular ordering.

Throws:

OWBException - if any internal error is encountered.

getTargets

public MapOperator[] getTargets()
                         throws OWBException

Gets all the map operators that are functioning as targets in the map.

Returns:

A list of all the targets in the map with no particular ordering.

Throws:

OWBException - if any internal error is encountered.

findMapOperator

public MapOperator findMapOperator(java.lang.String name)
                            throws OWBException

Find an operator in the map with the specified name. The names of the operators must be unique, so only one operator will be returned.

Parameters:

name - The name of the operator.

Returns:

An operator with the specified name, null if not found.

Throws:

OWBException - if any internal error is encountered.

createMapOperator

public MapOperator createMapOperator(java.lang.String name,
                                     java.lang.String operatorType)
                              throws OWBException,
                                     NameSpaceException,
                                     InvalidFormatException

Create a map operator of the specified type and name, and add it to this map. The name may be modified to ensure that the new operator is uniquely named within the map.

Parameters:

name - The name for the new map operator.

operatorType - The type of the map operator to be created. Valid types are defined as constants, which can be found in the MapHelper interface.

Returns:

The newly created map operator.

Throws:

OWBException - if any internal error is encountered.

NameSpaceException - if operator with the same name already exists.

InvalidFormatException - if operator name contains invalid character.

createMapOperator

public MapOperator createMapOperator(java.lang.String name,
                                     java.lang.String operatorType,
                                     ReconcileSource sourceObject)
                              throws OWBException,
                                     NameSpaceException,
                                     InvalidFormatException,
                                     InvalidSourceException,
                                     InvalidTargetException,
                                     IncompatibleTypesException

Create a bound map operator with the specified name and add it to this map. The name may be modified to ensure that the new operator is uniquely named within the map.

Parameters:

name - The name for the new map operator.

operatorType - The type of the map operator to be created. Valid types are defined as constants (prefix OPTYPE_), which can be found in the MapHelper interface.

sourceObject - The OWB repository object which will be bound (reconciled) to the new mapping operator.

Returns:

The newly created map operator.

Throws:

OWBException - if any internal error is encountered.

NameSpaceException - if operator with the same name already exists.

InvalidFormatException - if operator name contains invalid character.

InvalidSourceException - if the reconcile mechanism is unable to use the reconcile source.

InvalidTargetException - if the reconcile mechanism finds error in the operator to be created.

IncompatibleTypesException - if the reconcile mechanism is unable to resolve datatypes between the reconcile source and the operator to be created.

createMapOperator

public MapOperator createMapOperator(java.lang.String operatorType,
                                     ReconcileSource sourceObject)
                              throws OWBException,
                                     InvalidSourceException,
                                     InvalidTargetException,
                                     IncompatibleTypesException

Create a bound map operator and add it to this map. Both the name and the business name will be set to the name of the bound object. The name may be modified to ensure that the new operator is uniquely named within the map.

Parameters:

operatorType - The type of the map operator to be created. Valid types are defined as constants (prefix OPTYPE_), which can be found in the MapHelper interface.

sourceObject - The OWB repository object which will be bound to the new mapping operator.

Returns:

The newly created map operator.

Throws:

InvalidSourceException - if the reconcile mechanism is unable to use the reconcile source.

InvalidTargetException - if the reconcile mechanism finds error in the operator to be created.

IncompatibleTypesException - if the reconcile mechanism is unable to resolve datatypes between the reconcile source and the operator to be created.

getOperatorTypes

public java.lang.String[] getOperatorTypes()

Returns an array of all the defined operator type constants.

Returns:

array of string constants which can be used in operator creation.

compressMap

public void compressMap()
                 throws OWBException

Compress the map. This entails deleting any unconnected attributes from source and target operators. throws OWBException if any internal error is encountered.

getValidStepTypeValues

public java.lang.String[] getValidStepTypeValues()

Returns an array of all the valid step types.

Returns:

array of valid step type constants.