|
Oracle Warehouse Builder Java API Reference 10g Release 1 (10.1) B12155-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
public static final int NO_MAX_LIMIT
getMaxGroupCount
method.
Method Detail |
public Map getMap()
public void reconcileInbound(ReconcileSource source, java.lang.String matchingStrategy) throws OWBException, IncompatibleTypesException, InvalidSourceException, InvalidTargetException
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.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.public void reconcileOutbound(ReconcileTarget target, java.lang.String matchingStrategy) throws OWBException, IncompatibleTypesException, InvalidSourceException, InvalidTargetException
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.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.public void reconcileOutbound(Module module) throws OWBException, IncompatibleTypesException, InvalidSourceException, InvalidTargetException
module
- The module to be reconciled with.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.public OWBNamedObject getBoundObject() throws OWBException
OWBException
- if any internal error is encountered.public MapAttributeGroup[] getAttributeGroups(int direction) throws OWBException
direction
- The direction of the attribute groups to be returned. The choices are:
OWBException
- if any internal error is encountered.public MapAttributeGroup[] getAttributeGroups(int direction, boolean exactDirection) throws OWBException
direction
- The direction of the attribute groups to be returned. The choices are:
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.OWBException
- if any internal error is encountered.public MapAttributeGroup findAttributeGroup(java.lang.String name) throws OWBException
name
- the name of the attribute group to be found.OWBException
- if any internal error is encountered.public MapAttributeGroup createAttributeGroup(int direction) throws OWBException, NameSpaceException, InvalidFormatException
direction
- The direction of the attribute groups to be created. The choices are:
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.public MapAttributeGroup createAttributeGroup(java.lang.String name, int direction) throws OWBException, NameSpaceException, InvalidFormatException
direction
- The direction of the attribute groups to be created. The choices are:
name
- the name for the new attribute group.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.public int getMaxGroupCount(int direction) throws OWBException
direction
- The attribute group direction. The choices are:
NO_MAX_LIMIT
if there is no maximum.OWBException
- if any internal error is encountered.public int getMinGroupCount(int direction) throws OWBException
direction
- The attribute group direction. The choices are:
OWBException
- if any internal error is encountered.public boolean canAddAttributeGroup(int direction)
direction
- The attribute group direction. The choices are:
public boolean canDeleteAttributeGroup(MapAttributeGroup group)
group
- The attribute group to be deleted.public MapAttribute[] getAllAttributes() throws OWBException
OWBException
- if any internal error is encountered.public boolean isType(java.lang.String operatorType)
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.public java.lang.String getOperatorType() throws OWBException
OWBException
- if any internal error is encountered.public boolean isBindableOperator()
|
Oracle Warehouse Builder Java API Reference 10g Release 1 (10.1) B12155-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |