oracle.odi.domain.mapping

Interface IMapComponent

All Superinterfaces:

IMapComponent, IMapComponentOwner, IMappingObject, IModelObject, IModelObjectBase, INamedObject, IPropertyOwner, IRepositoryEntity, IRoot

public interface IMapComponent
extends IMapComponentOwner, IPropertyOwner, IMapComponent

An interface to represent a map component within a component owner. The component owner will be either a Mapping or ReusableMapping object. The component itself can also function as a component owner, for the case of a composite component.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IMapComponent.ComponentCategory An enumeration to describe the fundamental operational category of the component.

Method Summary

Modifier and Type	Method and Description
void	bindTo(IModelObject boundObject, boolean autoJoinEnabled) Bind the specified object to this component.
void	bindTo(IModelObject boundObject, IModelObject fcoObject, boolean autoJoinEnabled) Bind the specified object to this component.
MapConnector	connectTo(IMapComponent comp) Find or create a connection from this component to another component.
MapConnector	connectTo(IMapComponent comp, MapPathSpecifier path, java.lang.String name) Connect from this component to the specified component, along the specified path.
MapConnector	connectTo(IMapComponent comp, java.lang.String name) Find or create a connection from this component to another component.
MapConnector	connectTo(MapConnectorPoint point) Create a connection from this component to a specific input connector point of another component.
MapConnectorPoint	createInputConnectorPoint(java.lang.String name) Add an input connector point to this component.
MapConnectorPoint	createOutputConnectorPoint() Adds an output connector point to this component.
MapConnectorPoint	createOutputConnectorPoint(java.lang.String name) Adds an output connector point to this component.
MapConnectorPoint	findConnectorPoint(java.lang.String name, MapConnectorPoint.Direction direction) Find the connector point with the specified name and direction.
MapAttribute	findInputAttribute(java.lang.String name) Convenience method to find an input attribute with the specified name.
MapAttribute	findOutputAttribute(java.lang.String name) Convenience method to get an output attribute with the specified name.
AdapterBase	getAdapter() Get the repository adapter used to resolve model object references for this object.
java.lang.String	getAlias() Return the alias that can be used when referencing this component, for downstream expressions.
java.util.List	getAllExpressions() Get a list of all expressions owned by the component and it's sub-objects.
java.util.List	getAttributeExpressions() Get a list of all attribute expressions owned by all connector points for this component.
java.util.List	getAttributes() Gets a list of all attributes owned by all connector points for this component.
IModelObject	getBoundObject() Get the bound object for this component.
java.lang.String	getBoundObjectName() Return the bound object name, if available, else null.
IModelObject	getBoundShortcut() Get the bound shortcut object for this component, if any, else null.
ITechnology	getBoundTechnology() If this component is bound to an object with a specific technology, return it, otherwise return null.
IMapComponent.ComponentCategory	getComponentCategory() Return the component category (e.g.
ILocation	getComponentLocation(IContext contextAdapter) Get the location adapter for the location of the bound object for this component, if any.
ILocation	getComponentLocation(IContext contextAdapter, boolean logicalOnly) Get the location adapter for the location of the bound object for this component, if any.
IMapComponentOwner	getComponentOwner() Gets the component owner that contains this component.
MapComponentType	getComponentType() Get a reference to a static component type class instance that contains basic information about the component type, such as the type name, and property definitions needed by the specific component type.
java.lang.String	getComponentTypeName() Return the component type name for this component.
java.util.List	getConnectedAttributes() Gets a list of attributes connected by downstream expressions owned by all connector points for this component
int	getConnectorPointCount() Return the total number of connector points owned by this component.
int	getConnectorPointCount(MapConnectorPointRole role) Return the total number of connector points owned by this component, of the specified connector point role.
java.util.List	getConnectorPoints() Get all connector points owned by this component.
java.util.List	getConnectorPoints(MapConnectorPointRole role) Get a list of connector points owned by this component, with the specified connector point role.
MapConnectorPoint	getConnectorPointToLeaf(IMapComponent toComponent) Get a connector point owned by this component that is connected to the specified component, if any.
MapConnector	getConnectorTo(IMapComponent comp) Return the connector that connects this component to the specified component if they are connected, else return null.
MapComponentDelegate	getDelegate() Get the delegate for this component, for access to special delegate-only functions.
java.util.List	getDownstreamConnectedLeafComponents() Get a list of all downstream connector point connected to this component, through all output connector points owned by this component.
java.util.List	getDownstreamConnectedPoints() Get a list of all downstream connector points connected to this component, through all output connector points owned by this component.
MapExpression.ExecuteOnLocation	getExecuteOnHint() Return an execute location hint if the component supports it, otherwise "NO_HINT".
java.util.List	getExpressionReferences() Gets all expression references for expressions owned by this component and it's sub-objects.
DatastoreConstraint[]	getFlowConstraints()
java.lang.String	getFullName() Returns the fully qualified name of this component.
MapConnectorPoint	getInputConnectorPoint(int index) Get the input connector point with the specified index order.
MapConnectorPoint	getInputConnectorPoint(java.lang.String name) Get the first input connector with the specified name
int	getInputConnectorPointCount() Return the total number of input connector points owned by this component.
java.util.List	getInputConnectorPoints() Get a list of input connector points owned by this component.
MapConnectorPoint	getInputPoint() Convenience method to return the first input connector point, if there is only one.
java.util.List	getInScopeAttributes() Get all attributes that are in-scope for expressions owned by this component or it's child objects.
java.lang.String	getIntegrationType() If this is a target component, get it's integration type.
MapConnectorPoint	getNextAvailableInput(java.lang.String name) Retrieve the next available unconnected input connector point for the component.
MapConnectorPoint	getNextAvailableOutput(java.lang.String name) Retrieve the next available unconnected output connector point for the component.
java.util.List	getOutputAttributeExpressions() Get all expressions of all output attributes for this component.
java.util.List	getOutputAttributes() Get all output attributes owned by this component.
MapConnectorPoint	getOutputConnectorPoint(int index) Get the output connector point with the specified index order.
MapConnectorPoint	getOutputConnectorPoint(java.lang.String name) Get the first output connector with the specified name
int	getOutputConnectorPointCount() Return the total number of output connector points owned by this component.
java.util.List	getOutputConnectorPoints() Get a list of output connector points owned by this component.
MapConnectorPoint	getOutputPoint() Convenience method to return the first output connector point, if there is only one.
IMapComponent	getOwningComponent() Get the component that acts as a component owner for this one, if any.
java.lang.String	getPrefix() Gets a short prefix used when auto-generating names for components.
java.util.List	getProjectedAttributes() Get a list of attributes that are projected by the output of this component.
java.util.List	getProposedConnectionIssues(IMapComponent to, boolean existingConnectionOK) Validates the proposed connection to the specified "to" component.
MapRootContainer	getRootComponentOwner() Get the root component owner for this component, which is the top-level owner.
java.lang.String	getTechnicalDescription() If this is a Join/Filter/LookUp/Datastore Component return technical description of corresponding expression
IMapComponent	getTopmostComponent() Get the top level of the component owner hierarchy that is still a component itself.
java.lang.String	getTypeName() Return the component type name for this component.
java.util.List	getUpstreamConnectedLeafComponents() Get a list of all upstream components connected to this one, through all input connector points owned by this component.
java.util.List	getUpstreamConnectedLeafPoints() Get a list of all upstream leaf connector points connected to this component, through all input connector points owned by this component.
java.util.List	getUpstreamConnectedPoints() Get a list of all upstream connector points connected to this component, through all input connector points owned by this component.
java.util.List	getUpstreamInScopeLeafAttributes() Get the upstream in-scope leaf attributes for this component.
java.util.List	getUpstreamInScopeLeafPoints() Get the upstream in-scope leaf connector points for this component.
java.util.List	getUpstreamSources() Get the upstream sources for this component.
boolean	isAddInputConnectorPointAllowed() Return true if it is allowed to add an input connector point to this component.
boolean	isAddOutputConnectorPointAllowed() Return true if it is allowed to add an output connector point to this component.
boolean	isBound() Return true if the component is bound to a model object.
boolean	isCompositeComponent() Return true if this component owns it's own set of components.
boolean	isDecorator() Return true if this component is a decorator component.
boolean	isEndpoint() Return true if this component is an end point in the component graph, else false.
boolean	isHidden() Return true if this component is marked as hidden.
boolean	isInScope(IMapComponent sourceComponent) Return true if the specified source component would be in scope for expressions owned by this component.
boolean	isInScope(MapAttribute sourceAttribute) Return true if the specified attribute would be in scope for expressions owned by this component.
boolean	isMultiInputSelector() Return true if this component is a selector with multiple input points (e.g.
boolean	isOfType(java.lang.String componentTypeName) Return true if the component type matches the specified type name.
boolean	isPassive() Return true if this is a passive component type, meaning that it's output can be connected to an input connector point along with other non-passive or passive outputs.
boolean	isProjector() Return true if this component is a projector.
boolean	isProposedConnectionValid(IMapComponent to, boolean existingConnectionOK) Return true if the proposed connection is valid.
boolean	isSelector() Return true if this component is a selector.
boolean	isSignatureOwnerHolder() Return true if this component is a map signature owner holder, and thus contains a map signature owner object (reusable mapping or expandable mapping).
boolean	isSource() Return true if this component is a source, else false.
boolean	isSubComponent() Return true if this component is owned by a component owner which is itself a component.
boolean	isTarget() Return true if this component is a target, else false.
boolean	isValidForTechnology(ITechnology techno, java.util.List issues) Check whether component is valid for a technology.
boolean	referencesObject(IExpressionReferencedObject object) Return true if the specified object is referenced by an expression owned by this component or it's sub-objects.
void	removeAllConnections() Removes all connections from all input and output connector points of this component.
void	removeAllConnections(boolean removeReferencingExpressions) Removes all connections from all input and output connector points of this component.
void	removeAllInputConnections() Removes all input connections from all input connector points of this component.
void	removeInputConnectorPoint(MapConnectorPoint point) Removes an existing input connector point.
void	removeInputConnectorPoint(MapConnectorPoint point, boolean removeReferencingExpressions) Removes an existing input connector point.
void	removeInputConnectorPoint(java.lang.String pName) Removes an existing input connector point.
void	removeOutputConnectorPoint(MapConnectorPoint point) Removes an existing output connector point.
void	removeOutputConnectorPoint(MapConnectorPoint point, boolean removeReferencingExpressions) Removes an existing output connector point.
void	reorderInputConnectorPoint(MapConnectorPoint point, int newIndex) Reorder the input connector points.
void	reorderOutputConnectorPoint(MapConnectorPoint point, int newIndex) Reorder the output connector points.
void	setAlias(java.lang.String alias) Set an alias for this component, which can be used to reference the component in downstream expressions.
MapExpression	setAttributeExpressionText(java.lang.String name, java.lang.String exprText) Convenience method to set the expression text for an expression associated with the attribute of the specified name.
void	setAttributeExpressionText(java.lang.String name, java.lang.String exprText, MapConnectorPoint scopingInputPoint) Convenience method to set the expression text for an expression associated with the attribute of the specified name.
void	setExecuteOnHint(MapExpression.ExecuteOnLocation loc) Set the execute-on hint for this component, if applicable, otherwise throw exception.
void	setIsHidden(boolean value) Set a flag that marks this component as hidden for a graphical UI.
java.util.List	syncComponent(boolean resetCachedSyncState, boolean includeDeletions) Synchronize the component with its bound object, if any.

Methods inherited from interface oracle.odi.domain.mapping.IMapComponentOwner

addComponent, containsComponent, createComponent, createComponent, createComponent, findAllComponents, findComponent, findComponentBoundTo, findComponentOfType, findComponentsBoundTo, findConnector, findSubComponentOwner, getAllComponents, getAllComponentsOfType, getAllSignatureOwnerHolders, getAllSubComponentOwners, getComponentCount, getComponents, getLeafLevelComponents, getLeafLevelEndpoints, getLeafLevelTargets, getMapRootContainer, getSources, getTargets, getTopLevelComponentsOfType, getTopLevelSources, getTopLevelTargets, getUpstreamLeafAttributes, getUpstreamLeafAttributes, getUpstreamLeafConnectorPoints, getUpstreamLeafSources, isComponent, isExpandableComponent, isSignatureOwner, removeComponent, removeComponent

Methods inherited from interface oracle.odi.domain.root.IPropertyOwner

addProperty, createProperty, getAllProperties, getBooleanPropertyValue, getDisplayableProperties, getDisplayableTypeName, getExpressionPropertyValue, getIntPropertyValue, getProperties, getProperty, getPropertyValue, getStringPropertyValue, isPropertyDefined, setBooleanPropertyValue, setIntPropertyValue, setPropertyValue

Methods inherited from interface oracle.odi.domain.root.INamedObject

getBusinessName, getDescription, getName, setBusinessName, setDescription, setName

Methods inherited from interface oracle.odi.domain.root.IRoot

dump, dump, getDisplayableObjectName, getGUID, getOwner, getStrongTypeClassName, validate, validate, validate

Methods inherited from interface oracle.odi.domain.root.IMappingObject

getRootContainer

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getInternalId, getParent

Methods inherited from interface oracle.odi.domain.adapter.project.IMapComponent

getPersistentClassName

Methods inherited from interface oracle.odi.domain.adapter.IModelObject

getName

Methods inherited from interface oracle.odi.domain.adapter.IModelObjectBase

getBigNumericId, getGlobalId, getNumericId

Method Detail

getComponentOwner

IMapComponentOwner getComponentOwner()
                              throws MapComponentException

Gets the component owner that contains this component. A component owner could be an interface, or a composite-type component.

Returns:

The component owner.

Throws:

MapComponentException

getRootComponentOwner

MapRootContainer getRootComponentOwner()

Get the root component owner for this component, which is the top-level owner. It will be either a Mapping or ReusableMapping object.

getAlias

java.lang.String getAlias()

Return the alias that can be used when referencing this component, for downstream expressions. If no alias is defined, returns null. If a component has an alias, downstream expressions can use the alias or the component name in expression references.

Returns:

The alias.

setAlias

void setAlias(java.lang.String alias)
       throws MapComponentException

Set an alias for this component, which can be used to reference the component in downstream expressions.

Parameters:

alias - The alias to set.

Throws:

MapComponentException

getInputConnectorPoints

java.util.List getInputConnectorPoints()

Get a list of input connector points owned by this component. The input connector points provide a connection point to the component to which other components can be connected.

getOutputConnectorPoints

java.util.List getOutputConnectorPoints()

Get a list of output connector points owned by this component. The input connector points provide a connection point to the component to which other components can be connected.

getInputConnectorPointCount

int getInputConnectorPointCount()

Return the total number of input connector points owned by this component.

getOutputConnectorPointCount

int getOutputConnectorPointCount()

Return the total number of output connector points owned by this component.

getConnectorPointCount

int getConnectorPointCount()

Return the total number of connector points owned by this component.

getConnectorPointCount

int getConnectorPointCount(MapConnectorPointRole role)

Return the total number of connector points owned by this component, of the specified connector point role.

getConnectorPoints

java.util.List getConnectorPoints(MapConnectorPointRole role)

Get a list of connector points owned by this component, with the specified connector point role.

getConnectorPoints

java.util.List getConnectorPoints()

Get all connector points owned by this component.

connectTo

MapConnector connectTo(IMapComponent comp,
                       java.lang.String name)
                throws MappingException

Find or create a connection from this component to another component. The "to" component is considered to be downstream of this component in the data flow graph. This method can only be used if the calling component has only one output connector point. For multi-input target components, if all existing inputs are already connected, a new input will be created.

Parameters:

comp - The downstream component to be connected.

name - The name for the new connection, if a new connection is made. Can be null.

Returns:

The connector between the components, or null if no connection was made.

Throws:

MapComponentException

PropertyException

MappingException

connectTo

MapConnector connectTo(IMapComponent comp)
                throws MappingException

Find or create a connection from this component to another component. The "to" component is considered to be downstream of this component in the data flow graph. This method can only be used if the calling component has only one output connector point. For multi-input target components, if all existing inputs are already connected, a new input will be created.

Parameters:

comp - The downstream component to be connected.

Returns:

The connector between the components, or null if no connection was made.

Throws:

MapComponentException

PropertyException

MappingException

findConnectorPoint

MapConnectorPoint findConnectorPoint(java.lang.String name,
                                     MapConnectorPoint.Direction direction)

Find the connector point with the specified name and direction. If not found, return null.

Parameters:

name - The CP name.

direction - The CP direction.

findInputAttribute

MapAttribute findInputAttribute(java.lang.String name)
                         throws MappingException,
                                AdapterException

Convenience method to find an input attribute with the specified name. For use only if this component only has a single input connector point. If there are multiple input connector points, an exception is thrown.

Parameters:

name - The name of the attribute to be retrieved.

Throws:

PropertyException

AdapterException

MappingException

findOutputAttribute

MapAttribute findOutputAttribute(java.lang.String name)
                          throws MappingException,
                                 AdapterException

Convenience method to get an output attribute with the specified name. For use only if this component only has a single output connector point. If there are multiple output connector points, an exception is thrown.

Parameters:

name - The name of the attribute to be retrieved.

Throws:

PropertyException

AdapterException

MappingException

setAttributeExpressionText

MapExpression setAttributeExpressionText(java.lang.String name,
                                         java.lang.String exprText)
                                  throws MappingException,
                                         AdapterException

Convenience method to set the expression text for an expression associated with the attribute of the specified name. For use only if this component only has a single output or input connector point. If there are multiple output or input connector points, an exception is thrown. If there is an input attribute and an output attribute that match the name, the input attribute is returned.

Parameters:

name - The name of the attribute for which to set the expression text.

exprText - The expression text.

Returns:

The expression whose value was set.

Throws:

MapComponentException

PropertyException

AdapterException

MappingException

setAttributeExpressionText

void setAttributeExpressionText(java.lang.String name,
                                java.lang.String exprText,
                                MapConnectorPoint scopingInputPoint)
                         throws MappingException,
                                AdapterException

Convenience method to set the expression text for an expression associated with the attribute of the specified name. For use only if this component only has a single output and a single input connector point. If there are multiple output or input connector points, an exception is thrown.

Parameters:

name - The name of the input attribute for which to set the expression text.

exprText - The expression text.

scopingInputPoint - The scoping input point that will be associated with the expression.

Throws:

MapComponentException

PropertyException

AdapterException

MappingException

connectTo

MapConnector connectTo(MapConnectorPoint point)
                throws MappingException

Create a connection from this component to a specific input connector point of another component. The "to" component is considered to be downstream of this component in the data flow graph. This method can only be used if the calling component has only one output connector point. The "to" connector point must be an input connector point.

Parameters:

point - The downstream connector point to be connected.

Returns:

The MapConnector that was connects this component to the point if any, else null.

Throws:

MapComponentException

PropertyException

MappingException

getUpstreamConnectedLeafComponents

java.util.List getUpstreamConnectedLeafComponents()
                                           throws MapConnectionException

Get a list of all upstream components connected to this one, through all input connector points owned by this component. The result represents connections made through the flattened map.

Returns:

The list of upstream connected components.

Throws:

MapConnectionException

getUpstreamConnectedLeafPoints

java.util.List getUpstreamConnectedLeafPoints()
                                       throws MapConnectionException

Get a list of all upstream leaf connector points connected to this component, through all input connector points owned by this component. The result represents connections made through the flattened map, with respect to composite components. This does not flatten the map with respect to reusable mapping components.

Returns:

The list of upstream connected leaf connector points.

Throws:

MapConnectionException

getUpstreamConnectedPoints

java.util.List getUpstreamConnectedPoints()
                                   throws MapConnectionException

Get a list of all upstream connector points connected to this component, through all input connector points owned by this component.

Returns:

The list of upstream connected connector points.

Throws:

MapConnectionException

getDownstreamConnectedPoints

java.util.List getDownstreamConnectedPoints()
                                     throws MapConnectionException

Get a list of all downstream connector points connected to this component, through all output connector points owned by this component.

Returns:

The list of downstream connected connector points.

Throws:

MapConnectionException

getDownstreamConnectedLeafComponents

java.util.List getDownstreamConnectedLeafComponents()
                                             throws MapConnectionException

Get a list of all downstream connector point connected to this component, through all output connector points owned by this component. The result represents the connections of the flattened map, with respect to composite components. This does not flatten the map with respect to reusable mapping components.

Returns:

The list of downstream connected connector points.

Throws:

MapConnectionException

isHidden

boolean isHidden()

Return true if this component is marked as hidden. A hidden component would not be visible in for a graphical UI. The setting has no effect for the SDK.

setIsHidden

void setIsHidden(boolean value)

Set a flag that marks this component as hidden for a graphical UI.

Parameters:

value -

getBoundObject

IModelObject getBoundObject()
                     throws MapComponentException,
                            AdapterException

Get the bound object for this component. The bound object is some ODI model object that is represented by this component in the interface graph. If null, the component is not bound.

Returns:

The bound object.

Throws:

MapComponentException

AdapterException

getBoundShortcut

IModelObject getBoundShortcut()
                       throws AdapterException

Get the bound shortcut object for this component, if any, else null.

Returns:

The shortcut object that is bound to this component.

Throws:

AdapterException

isBound

boolean isBound()

Return true if the component is bound to a model object.

getBoundObjectName

java.lang.String getBoundObjectName()
                             throws MapComponentException,
                                    AdapterException

Return the bound object name, if available, else null.

Throws:

AdapterException

MapComponentException

getBoundTechnology

ITechnology getBoundTechnology()
                        throws MapComponentException,
                               AdapterException

If this component is bound to an object with a specific technology, return it, otherwise return null.

Throws:

AdapterException

MapComponentException

bindTo

void bindTo(IModelObject boundObject,
            boolean autoJoinEnabled)
     throws AdapterException,
            MappingException

Bind the specified object to this component. The bound object is some ODI model object that is represented by this component in the interface graph.

Parameters:

boundObject - The object to be bound to this object.

autoJoinEnabled - If true, the framework may automatically create a join between this component and other existing bound components, based on relationships between the bound objects.

Throws:

MapComponentException

PropertyException

ExpressionParseException

AdapterException

MapPhysicalException

MappingException

bindTo

void bindTo(IModelObject boundObject,
            IModelObject fcoObject,
            boolean autoJoinEnabled)
     throws AdapterException,
            MappingException

Bind the specified object to this component. The bound object is some ODI model object that is represented by this component in the interface graph.

Parameters:

boundObject - The object to be bound to this object.

fcoObject - The FCO owner of the bound object, if any. Can be null.

autoJoinEnabled - If true, the framework may automatically create a join between this component and other existing bound components, based on relationships between the bound objects.

Throws:

AdapterException

MappingException

syncComponent

java.util.List syncComponent(boolean resetCachedSyncState,
                             boolean includeDeletions)
                      throws AdapterException,
                             MappingException

Synchronize the component with its bound object, if any.

Parameters:

resetCachedSyncState - If true, then previous sync state information is reset to IN_SYNC.

includeDeletions - If true, then mapping objects whose corresponding model objects have been deleted will be deleted.

Throws:

AdapterException

MappingException

getTypeName

java.lang.String getTypeName()

Return the component type name for this component. Indicates the basic type and functionality of the component in the data flow graph, for example "datastore", "filter" "join", etc. The currently supported type names are found as static members in class InterfaceComponentRegistry.

See Also:

MapComponentRegistry

getComponentType

MapComponentType getComponentType()
                           throws MappingException

Get a reference to a static component type class instance that contains basic information about the component type, such as the type name, and property definitions needed by the specific component type.

Throws:

MapComponentException

MappingException

See Also:

MapComponentType

getComponentTypeName

java.lang.String getComponentTypeName()
                               throws MappingException

Return the component type name for this component.

Throws:

MappingException

createInputConnectorPoint

MapConnectorPoint createInputConnectorPoint(java.lang.String name)
                                     throws MappingException

Add an input connector point to this component. An input connector point represents a point through which an upstream component can be connected to this one. The connection represents data flow from one component to another. A set of projector attributes defines the shape of the data that flows from one component to another through connector points. If a single component has multiple input connector points, it means that the component supports processing of multiple upstream source data streams. Many components have input connector points added automatically by the delegate when the component is created, so it may not be necessary to explicitly add them later. That is, even though this is a "create" method, it may actually "reuse" an existing connector point that is unconnected. To force creation of a new connector point, even if existing CP's are unused, this can be done by passing the empty string "" as the name. If no input connector point can be created or found, returns null.

Parameters:

name - The name given to the newly created connector point, or to an unconnected existing connector point. If null, a name will be autogenerated (e.g. "INPUT1"), and reuse of an unused existing connector point will be tried first. If "", a name will be autogenerated, and only creation of a new connector point will be tried.

Returns:

The newly created input connector point, or an unused existing one, or null.

Throws:

MapComponentException

PropertyException

MappingException

createOutputConnectorPoint

MapConnectorPoint createOutputConnectorPoint()
                                      throws MappingException

Adds an output connector point to this component. An output connector point represents a point through which a downstream component can be connected to this one. The connection represents data flow from one component to another. A set of projector attributes defines the shape of the data that flows from one component to another through connector points. If a single component has multiple output connector points, it means that the component provides multiple data streams to downstream components. Many components have output connector points added automatically by the delegate when the component is created, so it may not be necessary to explicitly add them later. That is, even though this is a "create" method, it may actually "reuse" an existing connector point that is unconnected. The name of the output connector point will be autogenerated (e.g. "OUTPUT1"). If no output connector point can be created or found, returns null.

Returns:

The newly created output connector point, or an unused existing one, or null.

Throws:

MapComponentException

PropertyException

MappingException

createOutputConnectorPoint

MapConnectorPoint createOutputConnectorPoint(java.lang.String name)
                                      throws MappingException

Adds an output connector point to this component. An output connector point represents a point through which a downstream component can be connected to this one. The connection represents data flow from one component to another. A set of projector attributes defines the shape of the data that flows from one component to another through connector points. If a single component has multiple output connector points, it means that the component provides multiple data streams to downstream components. Many components have output connector points added automatically by the delegate when the component is created, so it may not be necessary to explicitly add them later. That is, even though this is a "create" method, it may actually "reuse" an existing connector point that is unconnected. To force creation of a new connector point, even if existing CP's are unused, this can be done by passing the empty string "" as the name. If no output point can be created or found, returns null.

Parameters:

name - The name given to the newly created connector point, or to an unconnected existing connector point. If null, a name will be autogenerated (e.g. "OUTPUT1"), and reuse of an unused existing connector point will be tried first. If "", a name will be autogenerated, and only creation of a new connector point will be tried.

Returns:

The newly created output connector point, or an unused existing one, or null.

Throws:

MapComponentException

PropertyException

MappingException

removeInputConnectorPoint

void removeInputConnectorPoint(MapConnectorPoint point)
                        throws MapComponentException

Removes an existing input connector point.

Parameters:

point - The connector point to be removed.

Throws:

MapComponentException

removeInputConnectorPoint

void removeInputConnectorPoint(MapConnectorPoint point,
                               boolean removeReferencingExpressions)
                        throws MapComponentException

Removes an existing input connector point.

Parameters:

point - The connector point to be removed.

removeReferencingExpressions - If true, set all expression text to blank for all expressions that reference attributes through the removed connector point.

Throws:

MapComponentException

removeInputConnectorPoint

void removeInputConnectorPoint(java.lang.String pName)
                        throws MapComponentException

Removes an existing input connector point.

Parameters:

pName -

Throws:

MapComponentException

removeOutputConnectorPoint

void removeOutputConnectorPoint(MapConnectorPoint point)
                         throws MapComponentException

Removes an existing output connector point.

Parameters:

point - The connector point to be removed.

Throws:

MapComponentException

removeOutputConnectorPoint

void removeOutputConnectorPoint(MapConnectorPoint point,
                                boolean removeReferencingExpressions)
                         throws MapComponentException

Removes an existing output connector point.

Parameters:

point - The connector point to be removed.

removeReferencingExpressions - If true, set all expression text to blank for all expressions that reference attributes through the removed connector point.

Throws:

MapComponentException

removeAllConnections

void removeAllConnections()
                   throws MapComponentException

Removes all connections from all input and output connector points of this component.

Throws:

MapComponentException

removeAllConnections

void removeAllConnections(boolean removeReferencingExpressions)
                   throws MapComponentException

Removes all connections from all input and output connector points of this component.

Throws:

MapComponentException

removeAllInputConnections

void removeAllInputConnections()
                        throws MapComponentException

Removes all input connections from all input connector points of this component.

Throws:

MapComponentException

getInputConnectorPoint

MapConnectorPoint getInputConnectorPoint(int index)
                                  throws MapComponentException

Get the input connector point with the specified index order.

Parameters:

index - The index order of the connector point. An exception is thrown if the index is out of range.

Throws:

MapComponentException

getOutputConnectorPoint

MapConnectorPoint getOutputConnectorPoint(int index)
                                   throws MapComponentException

Get the output connector point with the specified index order.

Parameters:

index - The index order of the connector point. An exception is thrown if the index is out of range.

Throws:

MapComponentException

getOutputConnectorPoint

MapConnectorPoint getOutputConnectorPoint(java.lang.String name)
                                   throws MapComponentException

Get the first output connector with the specified name

Parameters:

name - The name of the connector point. An exception is thrown if the name is null or empty

Throws:

MapComponentException

getInputConnectorPoint

MapConnectorPoint getInputConnectorPoint(java.lang.String name)
                                  throws MapComponentException

Get the first input connector with the specified name

Parameters:

name - The name of the connector point. An exception is thrown if the name is null or empty

Throws:

MapComponentException

getInputPoint

MapConnectorPoint getInputPoint()
                         throws MapComponentException

Convenience method to return the first input connector point, if there is only one.

Throws:

MapComponentException

getOutputPoint

MapConnectorPoint getOutputPoint()
                          throws MapComponentException

Convenience method to return the first output connector point, if there is only one.

Throws:

MapComponentException

getComponentCategory

IMapComponent.ComponentCategory getComponentCategory()

Return the component category (e.g. projector, selector, etc.). See the enum definition for supported categories.

See Also:

IMapComponent.ComponentCategory

getPrefix

java.lang.String getPrefix()
                    throws MapComponentException,
                           MappingException

Gets a short prefix used when auto-generating names for components. For example, the prefix value for a filter component might be something like "FILT".

Throws:

MapComponentException

MappingException

isProjector

boolean isProjector()

Return true if this component is a projector.

See Also:

IMapComponent.ComponentCategory

isSelector

boolean isSelector()

Return true if this component is a selector.

See Also:

IMapComponent.ComponentCategory

isDecorator

boolean isDecorator()

Return true if this component is a decorator component.

See Also:

IMapComponent.ComponentCategory

isMultiInputSelector

boolean isMultiInputSelector()

Return true if this component is a selector with multiple input points (e.g. join)

isPassive

boolean isPassive()
           throws MapComponentException

Return true if this is a passive component type, meaning that it's output can be connected to an input connector point along with other non-passive or passive outputs. Examples of passive components are sequence, variable, or input parameter.

Throws:

MapComponentException

getUpstreamInScopeLeafAttributes

java.util.List getUpstreamInScopeLeafAttributes()
                                         throws MappingException,
                                                AdapterException

Get the upstream in-scope leaf attributes for this component. The in-scope attributes are attributes that can be used in expressions owned by the component.

Throws:

MappingException

AdapterException

getUpstreamInScopeLeafPoints

java.util.List getUpstreamInScopeLeafPoints()
                                     throws MappingException,
                                            AdapterException

Get the upstream in-scope leaf connector points for this component. The in-scope connector points are points whose attributes can be used in expressions owned by this component.

Throws:

MappingException

AdapterException

getInScopeAttributes

java.util.List getInScopeAttributes()
                             throws MappingException,
                                    AdapterException

Get all attributes that are in-scope for expressions owned by this component or it's child objects. Same as getUpstreamInScopeAttributes.

Throws:

AdapterException

MappingException

getProjectedAttributes

java.util.List getProjectedAttributes()
                               throws MappingException,
                                      AdapterException

Get a list of attributes that are projected by the output of this component.

Throws:

MappingException

AdapterException

getAttributes

java.util.List getAttributes()
                      throws MappingException,
                             AdapterException

Gets a list of all attributes owned by all connector points for this component.

Throws:

MapComponentException

PropertyException

AdapterException

MappingException

getConnectedAttributes

java.util.List getConnectedAttributes()
                               throws MappingException,
                                      AdapterException

Gets a list of attributes connected by downstream expressions owned by all connector points for this component

Throws:

MapComponentException

PropertyException

MappingException

AdapterException

getAttributeExpressions

java.util.List getAttributeExpressions()
                                throws MappingException,
                                       AdapterException

Get a list of all attribute expressions owned by all connector points for this component.

Returns:

The list of all attribute expressions.

Throws:

MapComponentException

PropertyException

AdapterException

MappingException

getTopmostComponent

IMapComponent getTopmostComponent()

Get the top level of the component owner hierarchy that is still a component itself.

getOwningComponent

IMapComponent getOwningComponent()
                          throws MapComponentException

Get the component that acts as a component owner for this one, if any. If the component owner is not a component, return null.

Throws:

MapComponentException

getFullName

java.lang.String getFullName()

Returns the fully qualified name of this component. The qualifier includes any component owners that are components themselves, but not the interface name.

getComponentLocation

ILocation getComponentLocation(IContext contextAdapter)
                        throws AdapterException,
                               MapComponentException,
                               MapPhysicalException

Get the location adapter for the location of the bound object for this component, if any. If there is no bound object or if the bound object is not an external object with a location, then null is returned.

Parameters:

contextAdapter - A context adapter to use when creating the location. If null, then the default context for the owning interface is used.

Returns:

The location adapter for this component.

Throws:

AdapterException

MapPhysicalException

MapComponentException

getComponentLocation

ILocation getComponentLocation(IContext contextAdapter,
                               boolean logicalOnly)
                        throws AdapterException,
                               MapComponentException,
                               MapPhysicalException

Get the location adapter for the location of the bound object for this component, if any. If there is no bound object or if the bound object is not an external object with a location, then null is returned.

Parameters:

contextAdapter - A context adapter to use when creating the location. If null, then the default context for the owning interface is used.

logicalOnly - If true, a logical schema adapter will be returned, even if the location is a fixed physical location due to a forced context.

Returns:

The location adapter for this component.

Throws:

AdapterException

MapPhysicalException

MapComponentException

isEndpoint

boolean isEndpoint()
            throws MappingException

Return true if this component is an end point in the component graph, else false. A component is an end point if it has at least one input connection, and no output connections.

Returns:

True if the component is a end point.

Throws:

MappingException

isTarget

boolean isTarget()
          throws MappingException

Return true if this component is a target, else false. A component is a target if it has at least one input connection, and either no output connections or is a data storage component type, and it is not passive.

Returns:

True if the component is a target.

Throws:

MapComponentException

MappingException

isSource

boolean isSource()
          throws MapComponentException

Return true if this component is a source, else false. A component is a source if it is a projector with no input connections, some output connections, and it is not passive.

Returns:

True if the component is a source.

Throws:

MapComponentException

isSubComponent

boolean isSubComponent()
                throws MapComponentException

Return true if this component is owned by a component owner which is itself a component.

Throws:

MapComponentException

isSignatureOwnerHolder

boolean isSignatureOwnerHolder()

Return true if this component is a map signature owner holder, and thus contains a map signature owner object (reusable mapping or expandable mapping).

isInScope

boolean isInScope(MapAttribute sourceAttribute)

Return true if the specified attribute would be in scope for expressions owned by this component.

Parameters:

sourceAttribute - The source attribute for which to check scoping.

isInScope

boolean isInScope(IMapComponent sourceComponent)

Return true if the specified source component would be in scope for expressions owned by this component.

getConnectorPointToLeaf

MapConnectorPoint getConnectorPointToLeaf(IMapComponent toComponent)
                                   throws MapConnectionException

Get a connector point owned by this component that is connected to the specified component, if any. If no connector point connects to the specified component, return null.

Parameters:

toComponent - The component to which to find the connected connector point.

Returns:

The connector point that is connected to the specified component.

Throws:

MapConnectionException

getUpstreamSources

java.util.List getUpstreamSources()
                           throws MapComponentException

Get the upstream sources for this component. The graph is walked upstream starting from the inputs of this component, looking for source components.

Returns:

The list of upstream sources for the component.

Throws:

MapComponentException

getOutputAttributes

java.util.List getOutputAttributes()
                            throws MappingException,
                                   AdapterException

Get all output attributes owned by this component.

Returns:

The list of output attributes.

Throws:

MapComponentException

PropertyException

AdapterException

MappingException

getOutputAttributeExpressions

java.util.List getOutputAttributeExpressions()
                                      throws MappingException,
                                             AdapterException

Get all expressions of all output attributes for this component. For a target component, these are the loading expressions. For a projector component, these define the projection. There may be multiple expressions per attribute for the case of a multiplexing type operator such as a union.

Returns:

The list of output attribute expressions.

Throws:

MapComponentException

PropertyException

AdapterException

MappingException

reorderInputConnectorPoint

void reorderInputConnectorPoint(MapConnectorPoint point,
                                int newIndex)
                         throws MapComponentException

Reorder the input connector points. The specified input connector point will be reordered to the specified index in the list.

Parameters:

point - The input connector point to be reordered.

newIndex - The new index for the connector point.

Throws:

MapComponentException

reorderOutputConnectorPoint

void reorderOutputConnectorPoint(MapConnectorPoint point,
                                 int newIndex)
                          throws MapComponentException

Reorder the output connector points. The specified input connector point will be reordered to the specified index in the list.

Parameters:

point - The output connector point to be reordered.

newIndex - The new index for the connector point.

Throws:

MapComponentException

isCompositeComponent

boolean isCompositeComponent()

Return true if this component owns it's own set of components.

Returns:

True if this is a composite component that owns other components.

getNextAvailableInput

MapConnectorPoint getNextAvailableInput(java.lang.String name)
                                 throws MappingException

Retrieve the next available unconnected input connector point for the component. If all current inputs are connected, or if the name param is the empty string "", and if the component allows another input to be created, creates a new input point and returns it. If no available unconnected input can be found or created, returns null.

Parameters:

name - The name to be given to the next unconnected input connector point, or to a newly created input connector point. If null, a name will be autogenerated (e.g. "INPUT1"), and reuse of an unused existing connector point will be tried first. If "", a name will be autogenerated, and only creation of a new connector point will be tried.

Returns:

The next available unconnected input point, or a newly created one, or null.

Throws:

MapComponentException

PropertyException

MappingException

getNextAvailableOutput

MapConnectorPoint getNextAvailableOutput(java.lang.String name)
                                  throws MappingException

Retrieve the next available unconnected output connector point for the component. If all current outputs are connected, or if the name param is the empty string "", and if the component allows another output to be created, creates a new output point and returns it. If no available unconnected output can be found or created, returns null.

Parameters:

name - The name to be given to the next unconnected output connector point, or to a newly created output connector point. If null, a name will be autogenerated (e.g. "OUTPUT1"), and reuse of an unused existing connector point will be tried first. If "", a name will be autogenerated, and only creation of a new connector point will be tried.

Returns:

The next available unconnected output point, or a newly created one, or null.

Throws:

MapComponentException

PropertyException

MappingException

getConnectorTo

MapConnector getConnectorTo(IMapComponent comp)
                     throws MapComponentException

Return the connector that connects this component to the specified component if they are connected, else return null.

Parameters:

comp -

Throws:

MapComponentException

getDelegate

MapComponentDelegate getDelegate()
                          throws MapComponentException

Get the delegate for this component, for access to special delegate-only functions. The delegate contains extra component methods for a specific component type.

Throws:

MapComponentException

getExpressionReferences

java.util.List getExpressionReferences()
                                throws MappingException,
                                       AdapterException

Gets all expression references for expressions owned by this component and it's sub-objects.

Returns:

The list of references.

Throws:

AdapterException

PropertyException

MapComponentException

ExpressionParseException

MappingException

referencesObject

boolean referencesObject(IExpressionReferencedObject object)
                  throws MappingException,
                         AdapterException

Return true if the specified object is referenced by an expression owned by this component or it's sub-objects.

Parameters:

object -

Throws:

AdapterException

PropertyException

MapComponentException

ExpressionParseException

MappingException

isOfType

boolean isOfType(java.lang.String componentTypeName)

Return true if the component type matches the specified type name. The type name is not a full delegate class name.

Parameters:

componentTypeName - The name of the component type.

getExecuteOnHint

MapExpression.ExecuteOnLocation getExecuteOnHint()
                                          throws PropertyException

Return an execute location hint if the component supports it, otherwise "NO_HINT".

Throws:

PropertyException

setExecuteOnHint

void setExecuteOnHint(MapExpression.ExecuteOnLocation loc)
               throws PropertyException

Set the execute-on hint for this component, if applicable, otherwise throw exception.

Parameters:

loc -

Throws:

PropertyException

getIntegrationType

java.lang.String getIntegrationType()
                             throws MappingException

If this is a target component, get it's integration type. If no integration type is defined, return null. The integration type is used to find default component KM matches.

Returns:

The integration type string.

Throws:

MapComponentException

MappingException

getAllExpressions

java.util.List getAllExpressions()
                          throws MappingException,
                                 AdapterException

Get a list of all expressions owned by the component and it's sub-objects.

Returns:

A list of all the expressions.

Throws:

AdapterException

PropertyException

MapComponentException

MappingException

getFlowConstraints

DatastoreConstraint[] getFlowConstraints()

isProposedConnectionValid

boolean isProposedConnectionValid(IMapComponent to,
                                  boolean existingConnectionOK)

Return true if the proposed connection is valid.

Parameters:

to - The "to" connector point for the proposed connection.

existingConnectionOK - If true, then return true even if a connection already exists between the components.

getProposedConnectionIssues

java.util.List getProposedConnectionIssues(IMapComponent to,
                                           boolean existingConnectionOK)

Validates the proposed connection to the specified "to" component. If the connection is valid, an empty issue list is returned. If there are error or fatal-level issues in the returned list, the proposed connection is not valid.

Parameters:

to - The to component for the proposed connection.

existingConnectionOK - If true, then return true even if a connection already exists between the components.

connectTo

MapConnector connectTo(IMapComponent comp,
                       MapPathSpecifier path,
                       java.lang.String name)
                throws MappingException

Connect from this component to the specified component, along the specified path.

Parameters:

comp - The "to" component for the connection.

path - The path specifier for the connection.

name - The name of the new connection. If null, a unique name will be generated.

Throws:

MappingException

isValidForTechnology

boolean isValidForTechnology(ITechnology techno,
                             java.util.List issues)
                      throws MappingException

Check whether component is valid for a technology.

Parameters:

techno - The technology to validate against

Returns:

true if valid, false if not

Throws:

MappingException

isAddInputConnectorPointAllowed

boolean isAddInputConnectorPointAllowed()

Return true if it is allowed to add an input connector point to this component.

isAddOutputConnectorPointAllowed

boolean isAddOutputConnectorPointAllowed()

Return true if it is allowed to add an output connector point to this component.

getTechnicalDescription

java.lang.String getTechnicalDescription()
                                  throws MappingException

If this is a Join/Filter/LookUp/Datastore Component return technical description of corresponding expression

Returns:

The technical description string.

Throws:

MapComponentException

MappingException

getAdapter

AdapterBase getAdapter()
                throws AdapterException

Get the repository adapter used to resolve model object references for this object.

Specified by:

getAdapter in interface IRoot

Throws:

AdapterException