oracle.odi.domain.mapping

Class MapConnectorPoint

java.lang.Object

PropertyOwner

oracle.odi.domain.mapping.MapConnectorPoint

All Implemented Interfaces:

IModelObject, IModelObjectBase, IMapConnectorPoint, IMapAttributeOwner

Direct Known Subclasses:

InputConnectorPoint, OutputConnectorPoint

@Entity
public class MapConnectorPoint
extends PropertyOwner
implements IMapAttributeOwner, IMapConnectorPoint

A class representing a connector point of a component in the component owner graph. A connector point is a point on the component where connections can be made to other components. An output connection point can contain a set of attributes, which represent column-level information in the data flow.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapConnectorPoint.Cardinality Specifies the cardinality of the projected rows, for an output connector point.
static class	MapConnectorPoint.Direction

Method Summary

Modifier and Type	Method and Description
MapConnector	connectTo(IMapComponent target) Connects this connector point to the input connector point of a downstream component.
MapConnector	connectTo(IMapComponent target, java.lang.String name) Connects this connector point to the input connector point of a downstream component.
MapConnector	connectTo(MapConnectorPoint to) Connects this connector point to another connector point.
MapConnector	connectTo(MapConnectorPoint to, java.lang.String connectionName) Connects this connector point to another connector point.
MapAttribute	createAttribute(MapAttribute sourceAttr) Create an attribute that is a copy of the specified source attribute.
MapAttribute	createExpressionAttribute(java.lang.String name, java.lang.String expressionText, IDataType dataType) Create an unbound expression attribute in an expression component just downstream of this component.
MapAttribute	findAttribute(java.lang.String name) Find an attribute owned by this connector point, with the specified name.
MapAttribute	findAttributeByBusinessName(java.lang.String businessName)
MapAttribute	findAttributeByGlobalId(java.lang.String guid)
java.util.List	getAllConnectorsTo(IMapComponent target) Gets a list of MapConnector objects that connect this point to the specified target component.
java.util.List	getAllMapReferences()
java.util.List	getAllProperties()
java.util.List	getAllProperties(boolean persistentOnly)
int	getAttributeCount() Get the total number of attributes owned by this connector point.
java.util.List	getAttributeExpressions()
java.util.List	getAttributes() Retrieve a list of all the attributes owned by this connector point.
IModelObject	getBoundObject()
java.lang.String	getBoundObjectFullName() Get the full qualified name of the bound object.
MapConnectorPoint	getChildConnectorPoint() Get the child connector point for this connector point, if any.
java.lang.String	getChildNamespaceId(java.lang.String childClassName)
MapConnector	getConnector(MapConnectorPoint point) Get a connector that connects the specified point to this point.
MapConnector	getConnectorTo(IMapComponent target) Gets the MapConnector that connects this point to the specified target component, if they are connected, else null.
MapConnector	getConnectorToLeaf(IMapComponent target) Gets the MapConnector that connects this point to the specified target component, if they are connected, else null.
MapConnector	getConnectorToLeafPoint(MapConnectorPoint to) Get a top-level connector from this point to the specified point, if one exists.
int	getCPIndex()
int	getCPOrder() Retrieve the order of this connector point relative to the other connector points of the same direction and owned by the same component.
MapConnectorPointDelegate	getDelegate() Get the connector point delegate for this connector point, if a delegate is defined, else null.
MapConnectorPoint.Direction	getDirection() Get the direction of this connector point, either INPUT or OUTPUT.
java.lang.String	getDisplayableTypeName()
java.util.List	getDownstreamConnectedComponents() Get a list of all downstream components that are connected to this output connector point.
java.util.List	getDownstreamConnectedLeafComponents() Get a list of all downstream components that are connected to this output connector point.
java.util.List	getDownstreamConnectedLeafPoints() Get a list of all downstream connector points that are connected to this output connector point.
java.util.List	getDownstreamConnectedPoints() Get a list of all downstream connector points that are connected to this output connector point.
int	getFromConnectorCount() Return the number of input connections to this connector point.
java.util.List	getFromConnectors() Get a list of all connectors that start at this point (or are connected "from" this point).
java.lang.String	getFullName() Return the fully qualified name of this connector point.
MapConnectorPoint	getHighestLevelConnectorPoint() Get the highest level parent connector point, which reflects the functional connection point for incoming or outgoing connections to low-level components, if parent connector points are defined.
java.util.List	getInScopeComponents() Return a list of all components that are in-scope for this connector point.
MapConnectorPoint	getLowestLevelConnectorPoint() Get the lowest level child connector point, which reflects the functional connection point for incoming or outgoing connections to high-level components, if child connector points are defined.
IMapRootContainer	getMapRootContainer() Get the top level mapping object that owns this connector point.
IPropertyOwner	getOwner()
MapComponent	getOwningComponent() Get the component that owns this connector point.
MapConnectorPoint	getParentConnectorPoint() Get the parent connector point for this connector point, if any.
java.util.List	getProjectedAttributes() Get all projected attributes for this connector point.
MapConnectorPointRole	getRole() Get the connector point role for this connector point.
int	getToConnectorCount() Return the number of output connections from this connector point.
java.util.List	getToConnectors() Get a list of all connectors that end at this point (or are connected "to" this point).
java.util.List	getUpstreamConnectedComponents() Get a list of all upstream components that are connected to this input connector point.
java.util.List	getUpstreamConnectedLeafComponents() Get a list of all upstream components that are connected to this input connector point.
java.util.List	getUpstreamConnectedLeafPoints() Get a list of all upstream connector points that are connected to this input connector point.
java.util.List	getUpstreamConnectedPoints() Get a list of all upstream connector points that are connected to this input connector point.
java.util.List	getUpstreamInScopeAttributes() Get all attributes that are in-scope for expressions associated with this connector point.
java.util.List	getUpstreamInScopeLeafConnectorPoints() Get all connector points that are in-scope for expression associated with this connector point, and the paths between these connector points and this point do not pass through a projector component.
java.util.List	getUpstreamInScopeLeafPoints() Get the upstream, in-scope connector points for this connector point.
java.util.List	getUpstreamInScopeLeafPoints(boolean includeInputPoints) Get the upstream, in-scope connector points for this connector point.
boolean	hasProjectorAttributes() Return true if this connector point owns projector attributes.
boolean	isAddAttributeAllowed() Return true if this connector point is allowed to own and add attributes.
boolean	isBound() Return true if this connector point is bound to some model object.
boolean	isConnected() Return true if this connector point has any connections in eiher direction, else false.
boolean	isConnectedFrom(MapConnectorPoint point) Return true if a connection from the specified connector point to this connector point already exists.
boolean	isConnectedFromLeaf(MapConnectorPoint point) Return true if a connection from the specified connector point to this connector point already exists.
boolean	isConnectedTo(IMapComponent component) Return true if this connector point is connected to the specified component.
boolean	isConnectedTo(MapConnectorPoint point) Return true if a connection from this connector point to the specified connector point already exists.
boolean	isConnectedToLeaf(IMapComponent component) Return true if this connector point is connected to the specified component.
boolean	isConnectedToNonPassivePoint() Return true if this connector point has any connections to non-passive points in either direction, else false.
boolean	isInputPoint() Return true if this is an input connector point.
boolean	isInScopeFor(IMapComponent target) Return true if this point is in scope for the target.
boolean	isInScopeFor(MapConnectorPoint targetCP) Return true if this point is in scope for the target connector point.
boolean	isInScopeFor(MapConnectorPoint targetCP, boolean includeInputPoints) Return true if this point is in scope for the target connector point.
boolean	isOutputPoint() Return true if this is an output connector point.
boolean	isReferencedAttribute(MapAttribute attr) Return true if the specified attribute is owned by this connector point and is referenced by a downstream expression.
boolean	isSplitPathFrom(IMapComponent component)
boolean	isSplitPathFrom(MapAttribute attr)
boolean	isSplitPathFrom(MapConnectorPoint point)
void	removeAllAttributes() Remove all the attributes from this connector point.
void	removeAllAttributes(boolean removeReferencingExpressions) Remove all the attributes from this connector point.
void	removeAllConnections() Removes all connections from this connector point.
void	removeAllConnections(boolean removeReferencingExpressions) Removes all connections from this connector point.
void	removeAttribute(MapAttribute attr) Remove the specified attribute from this connector point.
void	removeAttribute(MapAttribute attr, boolean removeReferencingExpressions) Remove the specified attribute from this connector point.
void	removeAttribute(java.lang.String name) Remove the attribute with the specified name from this connector point.
void	removeAttribute(java.lang.String name, boolean removeReferencingExpressions) Remove the attribute with the specified name from this connector point.
void	removeInputConnection(MapConnector fromConnector) Removes the specified connector.
void	removeInputConnection(MapConnector fromConnector, boolean removeReferencingExpressions) Removes the specified connector.
void	removeInputConnection(MapConnectorPoint from) Removes the input connection from the specified source point.
void	removeInputConnection(MapConnectorPoint from, boolean removeReferencedExpressions) Removes the input connection from the specified source point.
void	removeOutputConnection(MapConnector toConnector) Removes the specified connector.
void	removeOutputConnection(MapConnector toConnector, boolean removeReferencingExpressions) Removes the specified connector.
void	removeOutputConnection(MapConnectorPoint to) Removes the output connection to the specified target connector point.
void	removeOutputConnection(MapConnectorPoint to, boolean removeReferencedExpressions) Removes the output connection to the specified target connector point.
void	reorderAttribute(MapAttribute attr, java.lang.Integer newPos) Change the order of the specified attribute in the ordered list.
void	setBoundObject(IModelObject boundObject, IModelObject fcoObject) Sets the bound object for this connector point.
void	setChildConnectorPoint(MapConnectorPoint childPoint) Set a connector point from a child component of this component as a child connector point for this connector point.
void	setChildConnectorPoint(MapConnectorPoint childPoint, boolean force) Set a connector point from a child component of this component as a child connector point for this connector point.
void	setName(java.lang.String name)
void	setParentConnectorPoint(MapConnectorPoint parentPoint) Set a connector point from a parent component of this component as a parent connector point for this connector point.
java.lang.String	toString()
boolean	validate(java.util.List result, boolean debug) Validates the object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getName

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

getBigNumericId, getGlobalId, getNumericId

Method Detail

setName

public void setName(java.lang.String name)
             throws MappingException

Throws:

MappingException

getOwningComponent

public MapComponent getOwningComponent()

Get the component that owns this connector point.

getRole

public MapConnectorPointRole getRole()

Get the connector point role for this connector point.

getChildNamespaceId

public java.lang.String getChildNamespaceId(java.lang.String childClassName)

getDelegate

public MapConnectorPointDelegate getDelegate()
                                      throws MappingException

Get the connector point delegate for this connector point, if a delegate is defined, else null.

Throws:

MapComponentException

MappingException

getMapRootContainer

public IMapRootContainer getMapRootContainer()
                                      throws MapComponentException

Get the top level mapping object that owns this connector point.

Throws:

MapComponentException

setBoundObject

public void setBoundObject(IModelObject boundObject,
                           IModelObject fcoObject)
                    throws AdapterException,
                           MapComponentException

Sets the bound object for this connector point. If connector point binding is not allowed by the role, then an exception will be thrown.

Parameters:

boundObject - The object that will be bound to this connector point.

fcoObject - The first-class (FCO) object that owns the bound object, if any. Can be null.

Throws:

AdapterException

PropertyException

MapComponentException

getBoundObject

public IModelObject getBoundObject()
                            throws MapComponentException,
                                   AdapterException

Throws:

MapComponentException

AdapterException

isBound

public boolean isBound()

Return true if this connector point is bound to some model object.

getBoundObjectFullName

public java.lang.String getBoundObjectFullName()
                                        throws MapComponentException,
                                               AdapterException

Get the full qualified name of the bound object.

Throws:

MapComponentException

AdapterException

getFromConnectors

public java.util.List getFromConnectors()

Get a list of all connectors that start at this point (or are connected "from" this point). The list will contain items only if the connector point is an output connector point.

Returns:

The list of connectors.

getFromConnectorCount

public int getFromConnectorCount()

Return the number of input connections to this connector point.

getToConnectorCount

public int getToConnectorCount()

Return the number of output connections from this connector point.

getToConnectors

public java.util.List getToConnectors()

Get a list of all connectors that end at this point (or are connected "to" this point). The list will contain items only if the connector point is an input connector point.

Returns:

The list of connectors.

connectTo

public MapConnector connectTo(MapConnectorPoint to)
                       throws MappingException

Connects this connector point to another connector point. This connector point will be the source (or start) of the connection. The calling connector point must be an output connector point, or an exception is thrown. The connector name will be blank.

Parameters:

to - The target connector point.

Returns:

The newly created connector object.

Throws:

MapComponentException

PropertyException

MappingException

connectTo

public MapConnector connectTo(MapConnectorPoint to,
                              java.lang.String connectionName)
                       throws MappingException

Connects this connector point to another connector point. This connector point will be the source (or start) of the connection. The calling connector point must be an output connector point, or an exception is thrown. The connector will be given the specified name.

Parameters:

to - The target connector point.

connectionName - The name for the newly created connector object.

Returns:

The newly created connector object.

Throws:

MapComponentException

PropertyException

MappingException

connectTo

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

Connects this connector point to the input connector point of a downstream component. This connector point will be the source (or start) of the connection. If this connector point is already connected to the component, the connector is returned. If the target component does not have any more unconnected inputs, and if inputs are allowed to be added, an input will be added and this point will be connected to it. If no points are allowed to be added to the target and the existing points are all connected, null is returned.

Parameters:

target - The target connector point.

name - The name of the new connector point, if one is created. Can be null.

Returns:

The newly created connector object.

Throws:

MapComponentException

PropertyException

MappingException

connectTo

public MapConnector connectTo(IMapComponent target)
                       throws MappingException

Connects this connector point to the input connector point of a downstream component. This connector point will be the source (or start) of the connection. If this connector point is already connected to the component, the connector is returned. If the target component does not have any more unconnected inputs, and if inputs are allowed to be added, an input will be added and this point will be connected to it. If no points are allowed to be added to the target and the existing points are all connected, null is returned.

Parameters:

target - The target connector point.

Returns:

The newly created connector object.

Throws:

MapComponentException

PropertyException

MappingException

getConnectorTo

public MapConnector getConnectorTo(IMapComponent target)
                            throws MapComponentException

Gets the MapConnector that connects this point to the specified target component, if they are connected, else null. If the source point is connected to multiple target points in the target component, return the first one.

Parameters:

target -

Throws:

MapComponentException

getAllConnectorsTo

public java.util.List getAllConnectorsTo(IMapComponent target)
                                  throws MapComponentException

Gets a list of MapConnector objects that connect this point to the specified target component. If they are not connected, then return an empty list.

Parameters:

target -

Throws:

MapComponentException

getConnectorToLeaf

public MapConnector getConnectorToLeaf(IMapComponent target)
                                throws MapComponentException

Gets the MapConnector that connects this point to the specified target component, if they are connected, else null. All top-level connections are considered for the flattened out map, from leaf component to leaf component. The graph is flattened with respect to composite components (such as dataset), but reusable components are not expanded.

Parameters:

target -

Throws:

MapComponentException

PropertyException

isInScopeFor

public boolean isInScopeFor(IMapComponent target)
                     throws MappingException,
                            AdapterException

Return true if this point is in scope for the target.

Parameters:

target -

Throws:

AdapterException

MappingException

isInScopeFor

public boolean isInScopeFor(MapConnectorPoint targetCP)
                     throws MappingException,
                            AdapterException

Return true if this point is in scope for the target connector point.

Parameters:

target -

Throws:

AdapterException

MappingException

isInScopeFor

public boolean isInScopeFor(MapConnectorPoint targetCP,
                            boolean includeInputPoints)
                     throws MappingException,
                            AdapterException

Return true if this point is in scope for the target connector point.

Parameters:

target -

includeInputPoints - If true, the upstream input points are included as valid in-scope points.

Throws:

AdapterException

MappingException

getUpstreamInScopeLeafPoints

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

Get the upstream, in-scope connector points for this connector point.

Returns:

The upstream in-scope connector points.

Throws:

MappingException

AdapterException

getUpstreamInScopeLeafPoints

public java.util.List getUpstreamInScopeLeafPoints(boolean includeInputPoints)
                                            throws MappingException,
                                                   AdapterException

Get the upstream, in-scope connector points for this connector point.

Parameters:

includeInputPoints - If true, the input points are also included in the list of upstream in-scope points.

Returns:

The upstream in-scope connector points.

Throws:

MappingException

AdapterException

isConnectedTo

public boolean isConnectedTo(MapConnectorPoint point)
                      throws MapComponentException

Return true if a connection from this connector point to the specified connector point already exists.

Parameters:

point - The connector point to check for existing connections from this point.

Throws:

MapComponentException

isConnectedTo

public boolean isConnectedTo(IMapComponent component)

Return true if this connector point is connected to the specified component.

Throws:

MapComponentException

isConnectedToLeaf

public boolean isConnectedToLeaf(IMapComponent component)
                          throws MapConnectionException

Return true if this connector point is connected to the specified component.

Throws:

MapConnectionException

MapComponentException

isConnectedFrom

public boolean isConnectedFrom(MapConnectorPoint point)

Return true if a connection from the specified connector point to this connector point already exists.

Parameters:

point - The connector point to check for existing connections to this point.

Throws:

MapComponentException

isConnectedFromLeaf

public boolean isConnectedFromLeaf(MapConnectorPoint point)
                            throws MapConnectionException

Return true if a connection from the specified connector point to this connector point already exists. Checks the leaf components in composite components.

Parameters:

point - The connector point to check for existing connections to this point.

Throws:

MapConnectionException

MapComponentException

removeInputConnection

public void removeInputConnection(MapConnectorPoint from)
                           throws MapComponentException

Removes the input connection from the specified source point.

Parameters:

from - The source point of the connection to be deleted.

Throws:

MapComponentException

removeInputConnection

public void removeInputConnection(MapConnectorPoint from,
                                  boolean removeReferencedExpressions)
                           throws MapComponentException

Removes the input connection from the specified source point.

Parameters:

from - The source point of the connection to be deleted.

removeReferencedExpressions - If true, remove any expressions that reference through the removed connector.

Throws:

MapComponentException

removeOutputConnection

public void removeOutputConnection(MapConnectorPoint to)
                            throws MapComponentException

Removes the output connection to the specified target connector point.

Parameters:

to - The target point of the connection to be deleted.

Throws:

MapComponentException

removeOutputConnection

public void removeOutputConnection(MapConnectorPoint to,
                                   boolean removeReferencedExpressions)
                            throws MapComponentException

Removes the output connection to the specified target connector point.

Parameters:

to - The target point of the connection to be deleted.

removeReferencedExpressions - If true, remove any expressions that reference through the removed connector.

Throws:

MapComponentException

removeInputConnection

public void removeInputConnection(MapConnector fromConnector)
                           throws MapComponentException

Removes the specified connector.

Parameters:

fromConnector - The connector to be removed.

Throws:

MapComponentException

removeInputConnection

public void removeInputConnection(MapConnector fromConnector,
                                  boolean removeReferencingExpressions)
                           throws MapComponentException

Removes the specified connector.

Parameters:

fromConnector - The connector to be removed.

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

Throws:

MapComponentException

removeOutputConnection

public void removeOutputConnection(MapConnector toConnector)
                            throws MapComponentException

Removes the specified connector.

Parameters:

toConnector - The connector to be removed.

Throws:

MapComponentException

removeOutputConnection

public void removeOutputConnection(MapConnector toConnector,
                                   boolean removeReferencingExpressions)
                            throws MapComponentException

Removes the specified connector.

Parameters:

toConnector - The connector to be removed.

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

Throws:

MapComponentException

removeAllConnections

public void removeAllConnections()
                          throws MapComponentException

Removes all connections from this connector point.

Throws:

MapComponentException

removeAllConnections

public void removeAllConnections(boolean removeReferencingExpressions)
                          throws MapComponentException

Removes all connections from this connector point.

Parameters:

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

Throws:

MapComponentException

getUpstreamConnectedLeafPoints

public java.util.List getUpstreamConnectedLeafPoints()
                                              throws MapConnectionException

Get a list of all upstream connector points that are connected to this input connector point. The lowest level child points are returned if the connected points are hierarchical. All parent points will be navigated as well. The result list represents the upstream connected points of the "flattened out" map, with respect to composite components. Reusable mapping components are not flattened.

Returns:

The list of upstream connected connector points.

Throws:

MapConnectionException

MapComponentException

getDownstreamConnectedLeafPoints

public java.util.List getDownstreamConnectedLeafPoints()
                                                throws MapConnectionException

Get a list of all downstream connector points that are connected to this output connector point. The lowest level child points are returned, if the connected points are hierarchical. All parent points will be navigated as well. The result list represents the downstream connected points of the "flattened out" map, with respect to composite components. Reusable mapping components are not flattened.

Returns:

The list of downstream connected connector points.

Throws:

MapConnectionException

MapComponentException

getConnectorToLeafPoint

public MapConnector getConnectorToLeafPoint(MapConnectorPoint to)
                                     throws MapComponentException

Get a top-level connector from this point to the specified point, if one exists. The lowest level child points are considered, if the connected points are hierarchical. All parent points will be navigated as well. The result represents the connector for the "flattened out" map, with respect to composite components. Reusable mapping components are not flattened.

Returns:

The list of downstream connected connector points.

Throws:

PropertyException

MapComponentException

getUpstreamConnectedPoints

public java.util.List getUpstreamConnectedPoints()

Get a list of all upstream connector points that are connected to this input connector point.

Returns:

The list of upstream connected connector points.

Throws:

MapComponentException

getDownstreamConnectedPoints

public java.util.List getDownstreamConnectedPoints()

Get a list of all downstream connector points that are connected to this output connector point.

Returns:

The list of downstream connected connector points.

Throws:

MapComponentException

getUpstreamConnectedComponents

public java.util.List getUpstreamConnectedComponents()

Get a list of all upstream components that are connected to this input connector point.

Throws:

MapComponentException

getDownstreamConnectedComponents

public java.util.List getDownstreamConnectedComponents()

Get a list of all downstream components that are connected to this output connector point. The lowest level components are returned if the connected points are hierarchical. All parent points will be navigated as well.

Returns:

The list of upstream connected connector points.

Throws:

MapComponentException

getUpstreamConnectedLeafComponents

public java.util.List getUpstreamConnectedLeafComponents()
                                                  throws MapConnectionException

Get a list of all upstream components that are connected to this input connector point. The lowest level components are returned if the connected points are hierarchical. All parent points will be navigated as well. The graph is flattened with respect to composite components. Reusable mapping components are not flattened.

Returns:

The list of upstream connected connector points.

Throws:

MapConnectionException

MapComponentException

getDownstreamConnectedLeafComponents

public java.util.List getDownstreamConnectedLeafComponents()
                                                    throws MapConnectionException

Get a list of all downstream components that are connected to this output connector point. The lowest level components are returned if the connected points are hierarchical. All parent points will be navigated as well.

Returns:

The list of upstream connected connector points.

Throws:

MapConnectionException

MapComponentException

getConnector

public MapConnector getConnector(MapConnectorPoint point)

Get a connector that connects the specified point to this point. Can be called for an input or output connector point.

Parameters:

point -

Returns:

The connector that connects this point to the specified point.

isConnected

public boolean isConnected()

Return true if this connector point has any connections in eiher direction, else false.

isConnectedToNonPassivePoint

public boolean isConnectedToNonPassivePoint()
                                     throws MapComponentException

Return true if this connector point has any connections to non-passive points in either direction, else false.

Throws:

MapComponentException

getAllProperties

public java.util.List getAllProperties()

getAllProperties

public java.util.List getAllProperties(boolean persistentOnly)

getDirection

public MapConnectorPoint.Direction getDirection()

Get the direction of this connector point, either INPUT or OUTPUT.

isInputPoint

public boolean isInputPoint()

Return true if this is an input connector point.

isOutputPoint

public boolean isOutputPoint()

Return true if this is an output connector point.

isAddAttributeAllowed

public boolean isAddAttributeAllowed()
                              throws MappingException,
                                     AdapterException

Return true if this connector point is allowed to own and add attributes.

Throws:

MapComponentException

AdapterException

PropertyException

MappingException

getFullName

public java.lang.String getFullName()

Return the fully qualified name of this connector point.

reorderAttribute

public void reorderAttribute(MapAttribute attr,
                             java.lang.Integer newPos)
                      throws MappingException,
                             AdapterException

Description copied from interface: IMapAttributeOwner

Change the order of the specified attribute in the ordered list. The attribute must be contained by this connector point, or an exception is thrown. If the zero-based index is out of range, an exception is thrown.
Note: Bound attributes that are not referenced by any expression may be transient attributes. In that case, the order will only be changed for the current client session, but will not be permanently changed.

Specified by:

reorderAttribute in interface IMapAttributeOwner

Parameters:

attr - The attribute whose order is to be changed.

newPos - The new index of the attribute. Null represents undefined/unset/unknown.

Throws:

PropertyException

MappingException

AdapterException

getAttributeCount

public int getAttributeCount()
                      throws MappingException,
                             AdapterException

Description copied from interface: IMapAttributeOwner

Get the total number of attributes owned by this connector point.

Specified by:

getAttributeCount in interface IMapAttributeOwner

Throws:

PropertyException

MappingException

AdapterException

createExpressionAttribute

public MapAttribute createExpressionAttribute(java.lang.String name,
                                              java.lang.String expressionText,
                                              IDataType dataType)
                                       throws MappingException,
                                              AdapterException

Create an unbound expression attribute in an expression component just downstream of this component. If this component is an expression component, add it to this one.

Parameters:

name -

expressionText -

Returns:

The newly created attribute.

Throws:

PropertyException

MapComponentException

AdapterException

MappingException

createAttribute

public MapAttribute createAttribute(MapAttribute sourceAttr)
                             throws MappingException,
                                    AdapterException

Description copied from interface: IMapAttributeOwner

Create an attribute that is a copy of the specified source attribute. The name and data type are copied.

Specified by:

createAttribute in interface IMapAttributeOwner

Returns:

The newly created attribute.

Throws:

MappingException

AdapterException

removeAttribute

public void removeAttribute(MapAttribute attr)
                     throws MappingException

Description copied from interface: IMapAttributeOwner

Remove the specified attribute from this connector point.

Specified by:

removeAttribute in interface IMapAttributeOwner

Parameters:

attr - The attribute to be removed.

Throws:

MappingException

removeAttribute

public void removeAttribute(MapAttribute attr,
                            boolean removeReferencingExpressions)
                     throws MappingException

Description copied from interface: IMapAttributeOwner

Remove the specified attribute from this connector point.

Specified by:

removeAttribute in interface IMapAttributeOwner

Parameters:

attr - The attribute to be removed.

removeReferencingExpressions - If true, then any expressions that reference the removed attribute will be removed.

Throws:

MappingException

removeAttribute

public void removeAttribute(java.lang.String name)
                     throws MappingException

Description copied from interface: IMapAttributeOwner

Remove the attribute with the specified name from this connector point.

Specified by:

removeAttribute in interface IMapAttributeOwner

Parameters:

name - The name of the attribute to be removed.

Throws:

MappingException

removeAttribute

public void removeAttribute(java.lang.String name,
                            boolean removeReferencingExpressions)
                     throws MappingException

Description copied from interface: IMapAttributeOwner

Remove the attribute with the specified name from this connector point.

Specified by:

removeAttribute in interface IMapAttributeOwner

Parameters:

name - The name of the attribute to be removed.

removeReferencingExpressions - If true, then any expressions that reference the removed attribute will be removed.

Throws:

MappingException

removeAllAttributes

public void removeAllAttributes()
                         throws MapComponentException

Remove all the attributes from this connector point.

Throws:

MapComponentException

removeAllAttributes

public void removeAllAttributes(boolean removeReferencingExpressions)
                         throws MapComponentException

Remove all the attributes from this connector point.

Throws:

MapComponentException

getAttributes

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

Description copied from interface: IMapAttributeOwner

Retrieve a list of all the attributes owned by this connector point.

Specified by:

getAttributes in interface IMapAttributeOwner

Returns:

The list of all the attributes.

Throws:

PropertyException

MappingException

AdapterException

getAttributeExpressions

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

Throws:

MappingException

AdapterException

findAttribute

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

Description copied from interface: IMapAttributeOwner

Find an attribute owned by this connector point, with the specified name.

Specified by:

findAttribute in interface IMapAttributeOwner

Parameters:

name - The name of the attribute to fetch.

Returns:

The attribute with the specified name, or null if not found.

Throws:

PropertyException

AdapterException

MappingException

findAttributeByBusinessName

public MapAttribute findAttributeByBusinessName(java.lang.String businessName)
                                         throws AdapterException,
                                                MappingException

Throws:

AdapterException

MappingException

findAttributeByGlobalId

public MapAttribute findAttributeByGlobalId(java.lang.String guid)
                                     throws AdapterException,
                                            MappingException

Throws:

AdapterException

MappingException

isReferencedAttribute

public boolean isReferencedAttribute(MapAttribute attr)

Return true if the specified attribute is owned by this connector point and is referenced by a downstream expression.

Parameters:

attr - The attribute for which to determine if it is referenced.

isSplitPathFrom

public boolean isSplitPathFrom(MapAttribute attr)
                        throws MappingException

Throws:

MappingException

isSplitPathFrom

public boolean isSplitPathFrom(MapConnectorPoint point)
                        throws MappingException

Throws:

MappingException

isSplitPathFrom

public boolean isSplitPathFrom(IMapComponent component)
                        throws MappingException

Throws:

MappingException

getInScopeComponents

public java.util.List getInScopeComponents()

Return a list of all components that are in-scope for this connector point. This includes all components that are connected upstream of this connector point, navigating back through selector components in the graph until a projector is reached.

getUpstreamInScopeAttributes

public java.util.List getUpstreamInScopeAttributes()
                                            throws MappingException,
                                                   AdapterException

Get all attributes that are in-scope for expressions associated with this connector point.

Returns:

A list of upstream in-scope attributes.

Throws:

MapComponentException

PropertyException

AdapterException

MappingException

getUpstreamInScopeLeafConnectorPoints

public java.util.List getUpstreamInScopeLeafConnectorPoints()
                                                     throws MappingException,
                                                            AdapterException

Get all connector points that are in-scope for expression associated with this connector point, and the paths between these connector points and this point do not pass through a projector component.

Returns:

the list of in-scope connector points upstream of this point.

Throws:

MappingException

AdapterException

getProjectedAttributes

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

Get all projected attributes for this connector point. If the connector point is an output and the component is a projector, then the set of in scope attributes is the set of projected output attributes owned by this connector. Otherwise it consists of the set of upstream in- scope attributes, plus any that are added by this connector point.

Returns:

The list of projected attributes.

Throws:

MapComponentException

PropertyException

AdapterException

MappingException

hasProjectorAttributes

public boolean hasProjectorAttributes()
                               throws MappingException,
                                      AdapterException

Return true if this connector point owns projector attributes.

Throws:

MapComponentException

PropertyException

AdapterException

MappingException

setChildConnectorPoint

public void setChildConnectorPoint(MapConnectorPoint childPoint)

Set a connector point from a child component of this component as a child connector point for this connector point. This will allow external components to effectively connect through the parent connector point, into the child component connector points.

Parameters:

childPoint - The connector point to set as the child point.

setChildConnectorPoint

public void setChildConnectorPoint(MapConnectorPoint childPoint,
                                   boolean force)

Set a connector point from a child component of this component as a child connector point for this connector point. This will allow external components to effectively connect through the parent connector point, into the child component connector points.

Parameters:

childPoint - The connector point to set as the child point.

force - if true, force re-parse of all expression of this connector point

getChildConnectorPoint

public MapConnectorPoint getChildConnectorPoint()

Get the child connector point for this connector point, if any.

getLowestLevelConnectorPoint

public MapConnectorPoint getLowestLevelConnectorPoint()
                                               throws MapConnectionException

Get the lowest level child connector point, which reflects the functional connection point for incoming or outgoing connections to high-level components, if child connector points are defined.

Throws:

MapConnectionException

setParentConnectorPoint

public void setParentConnectorPoint(MapConnectorPoint parentPoint)

Set a connector point from a parent component of this component as a parent connector point for this connector point. This will allow external components to effectively connect through the parent connector point, into the child component connector points.

Parameters:

parentPoint - The connector point to set as the parent point.

getParentConnectorPoint

public MapConnectorPoint getParentConnectorPoint()

Get the parent connector point for this connector point, if any.

Throws:

MapComponentException

getHighestLevelConnectorPoint

public MapConnectorPoint getHighestLevelConnectorPoint()

Get the highest level parent connector point, which reflects the functional connection point for incoming or outgoing connections to low-level components, if parent connector points are defined.

getOwner

public IPropertyOwner getOwner()

validate

public boolean validate(java.util.List result,
                        boolean debug)

Validates the object. Check all properties, parse all expressions and check for reference or connection errors. If errors or warnings are found, they are added to the passed-in list of RootIssue instances.

Throws:

MapComponentException

getDisplayableTypeName

public java.lang.String getDisplayableTypeName()

toString

public java.lang.String toString()

getCPOrder

public int getCPOrder()

Retrieve the order of this connector point relative to the other connector points of the same direction and owned by the same component.

getCPIndex

public int getCPIndex()

Returns:

getAllMapReferences

public java.util.List getAllMapReferences()