oracle.odi.domain.mapping

Class MapPathSpecifier

java.lang.Object

oracle.odi.domain.mapping.MapPathSpecifier

public class MapPathSpecifier
extends java.lang.Object

A non-persistent class that represents a mapping graph path between connector points. Each point in the path consists of a connector point.

Constructor Summary

Constructors

Constructor and Description
MapPathSpecifier() Constructor for an empty MapPathSpecifier object.
MapPathSpecifier(MapAttribute startAttr) A constructor for a path specifier that takes a starting attribute for the path.
MapPathSpecifier(oracle.odi.domain.mapping.MapComponent startComponent) Constructor for path specifier that specifies a starting component for the path.
MapPathSpecifier(MapConnectorPoint point) Constructor for a MapPathSpecifier object, that specifies the starting connector point for the path.
MapPathSpecifier(MapPathSpecifier pathSpec)

Method Summary

Modifier and Type	Method and Description
void	addPoint(MapConnectorPoint point) Add a point to the path.
boolean	containsPoint(MapConnectorPoint point) Return true if this path spec contains the specified point.
boolean	equals(java.lang.Object otherObj)
MapConnectorPoint	getComponentInputPointOnPath(IMapComponent comp) If the full path contains an input point that is owned by the specified component, return it, else return null.
MapConnectorPoint	getDownstreamCP(MapConnectorPoint sourceCP) Return the target connector point on this path, given the specified source connector point.
MapConnectorPoint	getFinalInputPoint() If the last point in the path point list is an input point, return it, else null.
MapConnectorPoint	getFirstPathPoint() Get the first point in the path point list.
MapConnectorPoint	getLastPathOutputPoint() Get the last point in the path point list that is an output point.
MapConnectorPoint	getLastPathPoint() Get the most downstream path point in the path.
static MapPathSpecifier	getMatchingPath(java.util.List fullPathList, MapPathSpecifier path) Return a matching path if one exists in the specified set of paths.
static MapPathSpecifier	getMatchingPath(java.util.List fullPathList, MapPathSpecifier path, boolean exactMatchRequired) Return a matching path if one exists in the specified set of paths.
java.util.List	getMinimizedPath() Get a minimized set of path points that specify this path with no ambiguity.
java.util.List	getMinimizedPath(boolean isFullyConnected) Get a minimized set of path points, that specify the path with no ambiguity.
java.util.List	getMinimizedPath(boolean isFullyConnected, boolean splitMergeInputsOnly) Get a minimized set of path points that specify this path with no ambiguity.
java.lang.String	getMinimizedPathString() Get a displayable, minimized string representation of the path.
java.lang.String	getMinimizedPathString(boolean isFullyConnected) Get a displayable, minimized string representation of the path.
java.util.List	getPath() Get the list of path points that are stored by this path specifier.
int	getPathCount() Get the number of points in the stored path point list for this path specifier.
int	getPathLength() Get the number of points in the stored path point list for this path specifier.
MapPathSpecifier	getPathPortion(MapConnectorPoint newEndPoint, boolean includeEndPoint) Return a new path specifier that represents just the portion of this path specifier that is upstream of the specified point.
java.lang.String	getPathString(boolean fullPath) Get a string representation of this path, that contains all specified path information, including CP names.
MapConnectorPoint	getPoint(int index) Return the point on the stored path point list corresponding to the specified index.
java.lang.String	getSimplifiedPathString() Get a displayable string representation of this path.
MapConnectorPoint	getSource() Get the first source connector point for this path.
MapAttribute	getStartAttribute() Get the starting attribute for this path, or null if none is defined.
IMapComponent	getStartComponent() Get the starting component for this path, or null if none is defined.
java.lang.String	getStartingPointName() Return the name of the source connector point or new connector point name.
int	hashCode()
int	indexOfPoint(MapConnectorPoint point) Get the index of the specified point in this path specifier.
void	insertPointAtStart(MapConnectorPoint point) Insert a new path point at the start of the stored path point list for this path specifier.
boolean	isAttributePath() If true, then this path specifies a starting attribute.
static boolean	isCommonSourcePointFound(MapConnectorPoint point1, MapConnectorPoint point2, MapPathSpecifier path) Return true if the 2 points have a common in-scope projector source and common point is in path.
boolean	isEmptyPath()
boolean	isMatchingPath(MapPathSpecifier otherPath) Return true if this path matches the specified path.
boolean	isMatchingPath(MapPathSpecifier otherPath, boolean exactMatchRequired) Return true if this path matches the specified path.
boolean	isPointOnPath(MapConnectorPoint point) Return true if the specified point is on the path specified by this object.
boolean	isSinglePointSpecifier() Return true if this path specifier specifies a single point, with no connection.
static boolean	isSplitMergeInputPoint(MapConnectorPoint inputPoint)
static boolean	isSplitMergeInputPoint(MapConnectorPoint inputPoint, MapPathSpecifier path)
void	setPathList(java.util.List pathList)
void	setStartAttribute(MapAttribute startAttr) Set the start attribute for this path specifier.
void	terminatePathAt(MapConnectorPoint point) Terminate this path at the specified point.
java.lang.String	toString() Get a displayable string representation of this path.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MapPathSpecifier

public MapPathSpecifier(MapConnectorPoint point)

Constructor for a MapPathSpecifier object, that specifies the starting connector point for the path.

Parameters:

point - The starting point of the path.

MapPathSpecifier

public MapPathSpecifier()

Constructor for an empty MapPathSpecifier object.

MapPathSpecifier

public MapPathSpecifier(MapAttribute startAttr)

A constructor for a path specifier that takes a starting attribute for the path. A path specifier can have a starting attribute for special cases where the path is used to trace the path from a specific attribute.

Parameters:

startAttr - The starting attribute for the path specifier.

MapPathSpecifier

public MapPathSpecifier(oracle.odi.domain.mapping.MapComponent startComponent)

Constructor for path specifier that specifies a starting component for the path.

Parameters:

startComponent - The start component for the path specifier.

MapPathSpecifier

public MapPathSpecifier(MapPathSpecifier pathSpec)

Method Detail

isSinglePointSpecifier

public boolean isSinglePointSpecifier()

Return true if this path specifier specifies a single point, with no connection.

isAttributePath

public boolean isAttributePath()

If true, then this path specifies a starting attribute.

setStartAttribute

public void setStartAttribute(MapAttribute startAttr)

Set the start attribute for this path specifier. The start attribute is only used for special cases.

getStartAttribute

public MapAttribute getStartAttribute()

Get the starting attribute for this path, or null if none is defined.

getStartComponent

public IMapComponent getStartComponent()

Get the starting component for this path, or null if none is defined.

addPoint

public void addPoint(MapConnectorPoint point)

Add a point to the path. Points must be added in sequential order from source to target.

Parameters:

point - The point to add.

setPathList

public void setPathList(java.util.List pathList)

insertPointAtStart

public void insertPointAtStart(MapConnectorPoint point)

Insert a new path point at the start of the stored path point list for this path specifier. A path point is a connector point.

Parameters:

point - The point to insert at the start of the path point list.

getPath

public java.util.List getPath()

Get the list of path points that are stored by this path specifier.

Returns:

The list of path points.

getPathLength

public int getPathLength()

Get the number of points in the stored path point list for this path specifier.

getSource

public MapConnectorPoint getSource()

Get the first source connector point for this path. Can be null if no points are defined.

getPoint

public MapConnectorPoint getPoint(int index)

Return the point on the stored path point list corresponding to the specified index.

Parameters:

index -

Returns:

getLastPathPoint

public MapConnectorPoint getLastPathPoint()

Get the most downstream path point in the path.

getLastPathOutputPoint

public MapConnectorPoint getLastPathOutputPoint()

Get the last point in the path point list that is an output point.

getFinalInputPoint

public MapConnectorPoint getFinalInputPoint()

If the last point in the path point list is an input point, return it, else null.

getComponentInputPointOnPath

public MapConnectorPoint getComponentInputPointOnPath(IMapComponent comp)
                                               throws MappingException

If the full path contains an input point that is owned by the specified component, return it, else return null.

Parameters:

comp - The component for which to find an input point on this path.

Returns:

Throws:

MappingException

getStartingPointName

public java.lang.String getStartingPointName()

Return the name of the source connector point or new connector point name.

getFirstPathPoint

public MapConnectorPoint getFirstPathPoint()

Get the first point in the path point list. Can be null if no points are defined.

containsPoint

public boolean containsPoint(MapConnectorPoint point)

Return true if this path spec contains the specified point.

isPointOnPath

public boolean isPointOnPath(MapConnectorPoint point)
                      throws MappingException

Return true if the specified point is on the path specified by this object.

Throws:

MappingException

indexOfPoint

public int indexOfPoint(MapConnectorPoint point)

Get the index of the specified point in this path specifier. If the point is not found in the stored path point list, then -1 is returned.

getPathCount

public int getPathCount()

Get the number of points in the stored path point list for this path specifier.

toString

public java.lang.String toString()

Get a displayable string representation of this path.

Overrides:

toString in class java.lang.Object

getSimplifiedPathString

public java.lang.String getSimplifiedPathString()

Get a displayable string representation of this path.

getPathString

public java.lang.String getPathString(boolean fullPath)

Get a string representation of this path, that contains all specified path information, including CP names.

Parameters:

fullPath - If true, include all intermediate points in the path, even if they are not explicitly specified.

getMinimizedPath

public java.util.List getMinimizedPath()
                                throws MappingException

Get a minimized set of path points that specify this path with no ambiguity.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

MappingException

getMinimizedPath

public java.util.List getMinimizedPath(boolean isFullyConnected)
                                throws MappingException

Get a minimized set of path points, that specify the path with no ambiguity.

Parameters:

isFullyConnected - If true, the map has been fully connected. If false, the map is being constructed and the path may specify a potential to-be-connected path.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

MappingException

getMinimizedPath

public java.util.List getMinimizedPath(boolean isFullyConnected,
                                       boolean splitMergeInputsOnly)
                                throws MappingException

Get a minimized set of path points that specify this path with no ambiguity.

Parameters:

isFullyConnected - If true, the map has been fully connected. If false, the map is being constructed and the path may specify a potential to-be-connected path.

splitMergeInputsOnly - If true, return only the list of critical split merge input points.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

MappingException

isSplitMergeInputPoint

public static boolean isSplitMergeInputPoint(MapConnectorPoint inputPoint)
                                      throws AdapterException,
                                             MappingException

Throws:

AdapterException

MappingException

isSplitMergeInputPoint

public static boolean isSplitMergeInputPoint(MapConnectorPoint inputPoint,
                                             MapPathSpecifier path)
                                      throws AdapterException,
                                             MappingException

Throws:

AdapterException

MappingException

isCommonSourcePointFound

public static boolean isCommonSourcePointFound(MapConnectorPoint point1,
                                               MapConnectorPoint point2,
                                               MapPathSpecifier path)
                                        throws AdapterException,
                                               MappingException

Return true if the 2 points have a common in-scope projector source and common point is in path. The first point is assumed to be a point on the specified path.

Parameters:

point1 -

point2 -

path -

Throws:

MappingException

AdapterException

getMinimizedPathString

public java.lang.String getMinimizedPathString()

Get a displayable, minimized string representation of the path.

Throws:

MappingException

oracle.odi.domain.mapping.exception.MapComponentException

getMinimizedPathString

public java.lang.String getMinimizedPathString(boolean isFullyConnected)

Get a displayable, minimized string representation of the path.

Parameters:

isFullyConnected - If true, the map has been fully connected. If false, the map is being constructed and the path may specify a potential to-be-connected path.

Throws:

MappingException

oracle.odi.domain.mapping.exception.MapComponentException

isMatchingPath

public boolean isMatchingPath(MapPathSpecifier otherPath)
                       throws MappingException

Return true if this path matches the specified path. This path and the other path are analyzed to determine the minimized merged input path point list, and a match is found only if all the minimized points match exactly. This is an exact match of the true minimized path. One or the other of the paths may contain ambiguities. However they will only match if both contain the same essential ambiguity.

Throws:

MappingException

isMatchingPath

public boolean isMatchingPath(MapPathSpecifier otherPath,
                              boolean exactMatchRequired)
                       throws MappingException

Return true if this path matches the specified path. This path and the other path are analyzed to determine the minimized merged input path point list, and a match is found only if all the minimized points match exactly. This is an exact match of the true minimized path. One or the other of the paths may contain ambiguities. However they will only match if both contain the same essential ambiguity.

Parameters:

exactMatchRequired - If true, then the path targets must match, as well as all the split merge points.

Throws:

MappingException

isEmptyPath

public boolean isEmptyPath()

getMatchingPath

public static MapPathSpecifier getMatchingPath(java.util.List fullPathList,
                                               MapPathSpecifier path)
                                        throws MappingException

Return a matching path if one exists in the specified set of paths. If there are multiple matching paths, the first one will be returned. A path is counted as a match if its points are contained in the expanded path of the specified match path, and they are in the same order. A path can be a matching path even if it is incomplete, as long as it does not contradict the match path.

Parameters:

fullPathList - The full path list in which to check for a matching path.

path - The path to check for.

Returns:

The full matching path from the list.

Throws:

MappingException

getMatchingPath

public static MapPathSpecifier getMatchingPath(java.util.List fullPathList,
                                               MapPathSpecifier path,
                                               boolean exactMatchRequired)
                                        throws MappingException

Return a matching path if one exists in the specified set of paths. If there are multiple matching paths, the first one will be returned. A path is counted as a match if its points are contained in the expanded path of the specified match path, and they are in the same order. A path can be a matching path even if it is incomplete, as long as it does not contradict the match path.

Parameters:

fullPathList - The full path list in which to check for a matching path.

path - The path to check for.

exactMatchRequired - If true, then the path targets must match as well as all the split merge points.

Returns:

The full matching path from the list.

Throws:

MappingException

terminatePathAt

public void terminatePathAt(MapConnectorPoint point)
                     throws MappingException

Terminate this path at the specified point.

Parameters:

point -

Throws:

MappingException

equals

public boolean equals(java.lang.Object otherObj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getDownstreamCP

public MapConnectorPoint getDownstreamCP(MapConnectorPoint sourceCP)
                                  throws MappingException

Return the target connector point on this path, given the specified source connector point.

Parameters:

sourceCP -

Returns:

Throws:

MappingException

getPathPortion

public MapPathSpecifier getPathPortion(MapConnectorPoint newEndPoint,
                                       boolean includeEndPoint)
                                throws MappingException

Return a new path specifier that represents just the portion of this path specifier that is upstream of the specified point.

Parameters:

newEndPoint - The end point of the new path specifier.

includeEndPoint - If true, include the specified new end point as the end point of the new path. Else do not include it.

Returns:

The new path specifier.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

MappingException