oracle.owb.mapping
Interface MapOperator

All Superinterfaces:

Extensible, MapOperatorHelper, Mappable, OWBNamedObject, PropertyOwner, ReconcileSource, ReconcileTarget

public interface MapOperator

extends MapOperatorHelper, Mappable, OWBNamedObject, Extensible, PropertyOwner, ReconcileSource, ReconcileTarget

MapOperator is the interface that describes an operator within a map. It also provides the functionality to get the operators that are connected to this one, thereby providing the capability to traverse the graph of map operators to obtain a topological order of the map operators in the map. This is a weak-typed interface, but the specific operator type can be retrieved or checked using the isType or getOperatorType methods.

Field Summary

static int

NO_MAX_LIMIT The value indicating that this is no maximum limit for the number of attribute groups in the specified direction.

Fields inherited from interface oracle.owb.mapping.Mappable

DIRECTION_ALL, DIRECTION_INPUT, DIRECTION_INPUT_OUTPUT, DIRECTION_OUTPUT, MAPPABLE_TYPE_ATTRIBUTE, MAPPABLE_TYPE_ATTRIBUTE_GROUP, MAPPABLE_TYPE_OPERATOR, MAPPABLE_TYPE_UNKNOWN

Method Summary

boolean	canAddAttributeGroup(int direction) Determine if the an attribute group of the specified direction can be added to this operator.
boolean	canDeleteAttributeGroup(MapAttributeGroup group) Determine if the specified attribute group can be deleted.
MapAttributeGroup	createAttributeGroup(int direction) Create an attribute group with the specified direction.
MapAttributeGroup	createAttributeGroup(java.lang.String name, int direction) Create an attribute group with the specified direction and name.
MapAttributeGroup	findAttributeGroup(java.lang.String name) Find the attribute group with the specified name.
MapAttribute[]	getAllAttributes() A convenience method to retrieve all attributes in all attribute groups for the operator.
MapAttributeGroup[]	getAttributeGroups(int direction) Get all attribute groups of the specified direction, in the order they were created.
MapAttributeGroup[]	getAttributeGroups(int direction, boolean exactDirection) Get all attribute groups of the specified direction, in the order they were created.
OWBNamedObject	getBoundObject() Get the repository object to which this operator is bound.
Map	getMap() Return the map that owns this operator.
int	getMaxGroupCount(int direction) Return the maximum number of groups for this operator, for the specified direction.
int	getMinGroupCount(int direction) Return the minimum number of groups for this operator, for the specified direction.
java.lang.String	getOperatorType() Get the type of the operator.
boolean	isBindableOperator() Determine if this operator is a bindable or unbindable operator.
boolean	isType(java.lang.String operatorType) Determine if the operator is of a specified type.
void	reconcileInbound(ReconcileSource source, java.lang.String matchingStrategy) Do inbound reconciliation of this operator, specified a repository object with which to reconcile.
void	reconcileOutbound(Module module) Do outbound reconciliation of this operator with object in the given module.
void	reconcileOutbound(ReconcileTarget target, java.lang.String matchingStrategy) Do outbound reconciliation of this object to a specified repository object.

Methods inherited from interface oracle.owb.mapping.Mappable

canConnectTo, connectTo, disconnectFrom, getConnectedMappables, getMappableType, getParentMap, getParentMappable, removeConnections

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.foundation.property.PropertyOwner

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

Methods inherited from interface oracle.owb.reconcile.ReconcileSource

getReconcileTargetTypes, getType

Methods inherited from interface oracle.owb.reconcile.ReconcileTarget

canMatchByPosition, getReconcileSourceTypes, getType

Field Detail

NO_MAX_LIMIT

public static final int NO_MAX_LIMIT

The value indicating that this is no maximum limit for the number of attribute groups in the specified direction. See the getMaxGroupCount method.

See Also:

Constant Field Values

Method Detail

getMap

public Map getMap()

Return the map that owns this operator.

Returns:

The map that owns this operator.

reconcileInbound

public void reconcileInbound(ReconcileSource source,
                             java.lang.String matchingStrategy)
                      throws OWBException,
IncompatibleTypesException,
InvalidSourceException,
InvalidTargetException

Do inbound reconciliation of this operator, specified a repository object with which to reconcile.

Parameters:

source - The source repository object with which to reconcile this operator.

matchingStrategy - A String which indicates the matching strategy. Must be one of the constant values found in the MapOperatorMatchingStrategy interface.

Throws:

OWBException - if any internal error is encountered.

IncompatibleTypesException - if the reconcile source has incompatible data type with this operator.

InvalidSourceException - if the reconcile mechanism finds an error in the reconcile source.

InvalidTargetException - if the reconcile mechanism finds an error in this operator.

reconcileOutbound

public void reconcileOutbound(ReconcileTarget target,
                              java.lang.String matchingStrategy)
                       throws OWBException,
IncompatibleTypesException,
InvalidSourceException,
InvalidTargetException

Do outbound reconciliation of this object to a specified repository object.

Parameters:

target - The target repository object to be reconciled with this operator.

matchingStrategy - A String which indicates the matching strategy. Must be one of the constant values found in the MapOperatorMatchingStrategy interface.

Throws:

OWBException - if any internal error is encountered.

IncompatibleTypesException - if this operator has incompatible data type with the reconcile target.

InvalidSourceException - if the reconcile mechanism finds an error in this operator.

InvalidTargetException - if the reconcile mechanism finds an error in the reconcile target.

reconcileOutbound

public void reconcileOutbound(Module module)
                       throws OWBException,
IncompatibleTypesException,
InvalidSourceException,
InvalidTargetException

Do outbound reconciliation of this operator with object in the given module. Create new if it doesn't exist.

Parameters:

module - The module to be reconciled with.

Throws:

OWBException - if any internal error is encountered.

IncompatibleTypesException - if this operator has incompatible data type with the reconcile target in the given module.

InvalidSourceException - if the reconcile mechanism finds an error in this operator.

InvalidTargetException - if the reconcile mechanism finds an error in the reconcile target in the given module.

getBoundObject

public OWBNamedObject getBoundObject()
                              throws OWBException

Get the repository object to which this operator is bound.

Returns:

The bound repository object, or null if this operator is not bound.

Throws:

OWBException - if any internal error is encountered.

getAttributeGroups

public MapAttributeGroup[] getAttributeGroups(int direction)
                                       throws OWBException

Get all attribute groups of the specified direction, in the order they were created.

Parameters:

direction - The direction of the attribute groups to be returned. The choices are:

• Mappable.DIRECTION_INPUT
• Mappable.DIRECTION_OUTPUT
• Mappable.DIRECTION_INPUT_OUTPUT
• Mappable.DIRECTION_ALL

Returns:

The array of attribute groups.

Throws:

OWBException - if any internal error is encountered.

getAttributeGroups

public MapAttributeGroup[] getAttributeGroups(int direction,
                                              boolean exactDirection)
                                       throws OWBException

Get all attribute groups of the specified direction, in the order they were created.

Parameters:

direction - The direction of the attribute groups to be returned. The choices are:

• Mappable.DIRECTION_INPUT
• Mappable.DIRECTION_OUTPUT
• Mappable.DIRECTION_INPUT_OUTPUT
• Mappable.DIRECTION_ALL

exactDirection - If true, indicates that the specified direction must match the group direction exactly. if false, specifies that groups that support the given direction will be returned, even if the direction is not an exact match. For example, an INPUT_OUTPUT group will be returned if "INPUT" or "OUTPUT" is specified as a direction.

Returns:

The array of attribute groups.

Throws:

OWBException - if any internal error is encountered.

findAttributeGroup

public MapAttributeGroup findAttributeGroup(java.lang.String name)
                                     throws OWBException

Find the attribute group with the specified name.

Parameters:

name - the name of the attribute group to be found.

Returns:

The attribute group, null if not found.

Throws:

OWBException - if any internal error is encountered.

createAttributeGroup

public MapAttributeGroup createAttributeGroup(int direction)
                                       throws OWBException,
NameSpaceException,
InvalidFormatException

Create an attribute group with the specified direction. The group name is automatically set to a default name.

Parameters:

direction - The direction of the attribute groups to be created. The choices are:

• Mappable.DIRECTION_INPUT
• Mappable.DIRECTION_OUTPUT
• Mappable.DIRECTION_INPUT_OUTPUT

Returns:

The new attribute group.

Throws:

OWBException - if any internal error is encountered.

NameSpaceException - if the automatically generated group name has already been assigned to another group.

InvalidFormatException - if the automatically generated group name contains invalid character.

createAttributeGroup

public MapAttributeGroup createAttributeGroup(java.lang.String name,
                                              int direction)
                                       throws OWBException,
NameSpaceException,
InvalidFormatException

Create an attribute group with the specified direction and name.

Parameters:

direction - The direction of the attribute groups to be created. The choices are:

• Mappable.DIRECTION_INPUT
• Mappable.DIRECTION_OUTPUT
• Mappable.DIRECTION_INPUT_OUTPUT

name - the name for the new attribute group.

Returns:

The new attribute group.

Throws:

OWBException - if any internal error is encountered.

NameSpaceException - if the group name has already been assigned to another group.

InvalidFormatException - if the group name contains invalid character.

getMaxGroupCount

public int getMaxGroupCount(int direction)
                     throws OWBException

Return the maximum number of groups for this operator, for the specified direction.

Parameters:

direction - The attribute group direction. The choices are:

• Mappable.DIRECTION_INPUT
• Mappable.DIRECTION_OUTPUT
• Mappable.DIRECTION_INPUT_OUTPUT

Returns:

The maximum group count, or NO_MAX_LIMIT if there is no maximum.

Throws:

OWBException - if any internal error is encountered.

getMinGroupCount

public int getMinGroupCount(int direction)
                     throws OWBException

Return the minimum number of groups for this operator, for the specified direction.

Parameters:

direction - The attribute group direction. The choices are:

• Mappable.DIRECTION_INPUT
• Mappable.DIRECTION_OUTPUT
• Mappable.DIRECTION_INPUT_OUTPUT

Returns:

The minimum group count.

Throws:

OWBException - if any internal error is encountered.

canAddAttributeGroup

public boolean canAddAttributeGroup(int direction)

Determine if the an attribute group of the specified direction can be added to this operator.

Parameters:

direction - The attribute group direction. The choices are:

• Mappable.DIRECTION_INPUT
• Mappable.DIRECTION_OUTPUT
• Mappable.DIRECTION_INPUT_OUTPUT

Returns:

true if a group can be added in the specified direction, else false.

canDeleteAttributeGroup

public boolean canDeleteAttributeGroup(MapAttributeGroup group)

Determine if the specified attribute group can be deleted.

Parameters:

group - The attribute group to be deleted.

Returns:

true if the group can be deleted, else false.

getAllAttributes

public MapAttribute[] getAllAttributes()
                                throws OWBException

A convenience method to retrieve all attributes in all attribute groups for the operator.

Returns:

The array of input attributes.

Throws:

OWBException - if any internal error is encountered.

isType

public boolean isType(java.lang.String operatorType)

Determine if the operator is of a specified type.

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.

Returns:

true if the operator is of the specified type, else false.

getOperatorType

public java.lang.String getOperatorType()
                                 throws OWBException

Get the type of the operator.

Returns:

A string constant indicating the type of this operator.

Throws:

OWBException - if any internal error is encountered.

isBindableOperator

public boolean isBindableOperator()

Determine if this operator is a bindable or unbindable operator.

Returns:

true if the operator is bindable to a repository object, else false.