com.oakgrovesystems.reactor
Interface LabelPathToIdMapper

All Known Implementing Classes:
ClientLabelPathToIdMapper

public interface LabelPathToIdMapper


Method Summary
 com.oakgrovesystems.reactor.ReactorObjectId getId(com.oakgrovesystems.reactor.LabelPath pathToMap)
          Maps a LabelPath to a ReactorObjectId.
 com.oakgrovesystems.reactor.ReactorObjectId getId(com.oakgrovesystems.reactor.LabelPath pathToMap, java.lang.Class filterClass)
          Maps a LabelPath to a ReactorObjectId.
 com.oakgrovesystems.reactor.ReactorObjectId getId(com.oakgrovesystems.reactor.LabelPath pathToMap, java.lang.Class filterClass, com.oakgrovesystems.reactor.ReactorObjectId root)
          Maps a LabelPath to a ReactorObjectId with the id specified as the starting point for label path resolution.
 com.oakgrovesystems.reactor.ReactorObjectId getId(com.oakgrovesystems.reactor.LabelPath pathToMap, com.oakgrovesystems.reactor.ReactorObjectId root)
          Maps a LabelPath to a ReactorObjectId with the id specified as the starting point for label path resolution.
 com.oakgrovesystems.reactor.ReactorObjectId getIdForUniqueLabelPath(com.oakgrovesystems.reactor.LabelPath uniquePathToMap)
          Maps a LabelPath to a ReactorObjectId.
 com.oakgrovesystems.reactor.ReactorObjectId getIdForUniqueLabelPath(com.oakgrovesystems.reactor.LabelPath uniquePathToMap, java.lang.Class filterClass)
          Maps a LabelPath to a ReactorObjectId.
 com.oakgrovesystems.reactor.ReactorObjectId getIdForUniqueLabelPath(com.oakgrovesystems.reactor.LabelPath uniquePathToMap, java.lang.Class filterClass, com.oakgrovesystems.reactor.ReactorObjectId root)
          Maps a LabelPath to a ReactorObjectId with the id specified as the starting point for label path resolution.
 com.oakgrovesystems.reactor.ReactorObjectId getIdForUniqueLabelPath(com.oakgrovesystems.reactor.LabelPath uniquePathToMap, com.oakgrovesystems.reactor.ReactorObjectId root)
          Maps a LabelPath to a ReactorObjectId with the id specified as the starting point for label path resolution.
 java.util.Set getIdSet(com.oakgrovesystems.reactor.LabelPath pathToMap)
          Maps a LabelPath to a Set of ReactorObjectIds
 java.util.Set getIdSet(com.oakgrovesystems.reactor.LabelPath pathToMap, java.lang.Class filterClass)
          Maps a LabelPath to a Set of ReactorObjectIds
 java.util.Set getIdSet(com.oakgrovesystems.reactor.LabelPath pathToMap, java.lang.Class filterClass, boolean definitionsOnly)
          Maps a LabelPath to a Set of ReactorObjectIds
 java.util.Set getIdSet(com.oakgrovesystems.reactor.LabelPath pathToMap, java.lang.Class filterClass, com.oakgrovesystems.reactor.ReactorObjectId root)
          Maps a LabelPath to a Set of ReactorObjectIds with the id specified as the starting point for label path resolution
 java.util.Set getIdSet(com.oakgrovesystems.reactor.LabelPath pathToMap, com.oakgrovesystems.reactor.ReactorObjectId root)
          Maps a LabelPath to a Set of ReactorObjectIds using the Process with the id specified as the starting point for label path resolution
 

Method Detail

getIdSet

public java.util.Set getIdSet(com.oakgrovesystems.reactor.LabelPath pathToMap)
Maps a LabelPath to a Set of ReactorObjectIds

Parameters:
pathToMap - The LabelPath that must resolve to an object for that object to be included in the returned Set.
Returns:
The Set of ReactorObjectIds of all Objects o available to the mapper such that the LabelPath pathToMap will resolve to o. Returns an empty set if no such objects are available to the mapper.

getIdSet

public java.util.Set getIdSet(com.oakgrovesystems.reactor.LabelPath pathToMap,
                              com.oakgrovesystems.reactor.ReactorObjectId root)
Maps a LabelPath to a Set of ReactorObjectIds using the Process with the id specified as the starting point for label path resolution

Parameters:
pathToMap - The LabelPath that must resolve to an object for that object to be included in the returned Set.
Returns:
The Set of ReactorObjectIds of all Objects o available to the mapper such that the LabelPath pathToMap will resolve to o. Returns an empty set if no such objects are available to the mapper.

getIdSet

public java.util.Set getIdSet(com.oakgrovesystems.reactor.LabelPath pathToMap,
                              java.lang.Class filterClass)
Maps a LabelPath to a Set of ReactorObjectIds

Parameters:
pathToMap - The LabelPath that must resolve to an object for that object to be included in the returned Set.
filterClass - The Class with which an object must be assignment compatible in order to be included in the returned Set.
Returns:
The Set of ReactorObjectIds of all Objects o available to the mapper such that the LabelPath pathToMap will resolve to o and filterClass.isInstance(o)==true. Returns an empty set if no such objects are available to the mapper.

getIdSet

public java.util.Set getIdSet(com.oakgrovesystems.reactor.LabelPath pathToMap,
                              java.lang.Class filterClass,
                              boolean definitionsOnly)
Maps a LabelPath to a Set of ReactorObjectIds

Parameters:
pathToMap - The LabelPath that must resolve to an object for that object to be included in the returned Set.
filterClass - The Class with which an object must be assignment compatible in order to be included in the returned Set.
definitionsOnly - If true, the objects must be in a process definition tree.
Returns:
The Set of ReactorObjectIds of all Objects o available to the mapper such that the LabelPath pathToMap will resolve to o and filterClass.isInstance(o)==true. Returns an empty set if no such objects are available to the mapper.

getIdSet

public java.util.Set getIdSet(com.oakgrovesystems.reactor.LabelPath pathToMap,
                              java.lang.Class filterClass,
                              com.oakgrovesystems.reactor.ReactorObjectId root)
Maps a LabelPath to a Set of ReactorObjectIds with the id specified as the starting point for label path resolution

Parameters:
pathToMap - The LabelPath that must resolve to an object for that object to be included in the returned Set.
filterClass - The Class with which an object must be assignment compatible in order to be included in the returned Set.
Returns:
The Set of ReactorObjectIds of all Objects o available to the mapper such that the LabelPath pathToMap will resolve to o and filterClass.isInstance(o)==true. Returns an empty set if no such objects are available to the mapper.

getId

public com.oakgrovesystems.reactor.ReactorObjectId getId(com.oakgrovesystems.reactor.LabelPath pathToMap)
Maps a LabelPath to a ReactorObjectId. If the LabelPath provided maps to more than one ReactorObjectId, this method may return any one of them.

Parameters:
pathToMap - The LabelPath that must resolve to an object for that object to be included in the returned Set.
Returns:
The ReactorObjectId of an Object o such that the LabelPath pathToMap will resolve to o. Returns null if no such objects are available to the mapper.

getId

public com.oakgrovesystems.reactor.ReactorObjectId getId(com.oakgrovesystems.reactor.LabelPath pathToMap,
                                                         com.oakgrovesystems.reactor.ReactorObjectId root)
Maps a LabelPath to a ReactorObjectId with the id specified as the starting point for label path resolution. If the LabelPath provided maps to more than one ReactorObjectId, this method may return any one of them.

Parameters:
pathToMap - The LabelPath that must resolve to an object for that object to be included in the returned Set.
Returns:
The ReactorObjectId of an Object o such that the LabelPath pathToMap will resolve to o. Returns null if no such objects are available to the mapper.

getId

public com.oakgrovesystems.reactor.ReactorObjectId getId(com.oakgrovesystems.reactor.LabelPath pathToMap,
                                                         java.lang.Class filterClass)
Maps a LabelPath to a ReactorObjectId. If the LabelPath provided maps to more than one ReactorObjectId, this method may return any one of them.

Parameters:
pathToMap - The LabelPath that must resolve to an object for that object to be included in the returned Set.
filterClass -
Returns:
The ReactorObjectId of an Object o such that the LabelPath pathToMap will resolve to o and filterClass.isInstance(o)==true. Returns null if no such objects are available to the mapper.

getId

public com.oakgrovesystems.reactor.ReactorObjectId getId(com.oakgrovesystems.reactor.LabelPath pathToMap,
                                                         java.lang.Class filterClass,
                                                         com.oakgrovesystems.reactor.ReactorObjectId root)
Maps a LabelPath to a ReactorObjectId with the id specified as the starting point for label path resolution. If the LabelPath provided maps to more than one ReactorObjectId, this method may return any one of them.

Parameters:
pathToMap - The LabelPath that must resolve to an object for that object to be included in the returned Set.
filterClass -
Returns:
The ReactorObjectId of an Object o such that the LabelPath pathToMap will resolve to o and filterClass.isInstance(o)==true. Returns null if no such objects are available to the mapper.

getIdForUniqueLabelPath

public com.oakgrovesystems.reactor.ReactorObjectId getIdForUniqueLabelPath(com.oakgrovesystems.reactor.LabelPath uniquePathToMap)
                                                                    throws IdentifierMappingException
Maps a LabelPath to a ReactorObjectId.

Parameters:
uniquePathToMap - The LabelPath that must resolve to an object for that object to be included in the returned Set.
Returns:
The ReactorObjectId of an Object o such that the LabelPath pathToMap will resolve to o. Returns null if no such objects are available to the mapper.
Throws:
IdentifierMappingException - If the LabelPath provided maps to more than one object.

getIdForUniqueLabelPath

public com.oakgrovesystems.reactor.ReactorObjectId getIdForUniqueLabelPath(com.oakgrovesystems.reactor.LabelPath uniquePathToMap,
                                                                           com.oakgrovesystems.reactor.ReactorObjectId root)
                                                                    throws IdentifierMappingException
Maps a LabelPath to a ReactorObjectId with the id specified as the starting point for label path resolution.

Parameters:
uniquePathToMap - The LabelPath that must resolve to an object for that object to be included in the returned Set.
Returns:
The ReactorObjectId of an Object o such that the LabelPath pathToMap will resolve to o. Returns null if no such objects are available to the mapper.
Throws:
IdentifierMappingException - If the LabelPath provided maps to more than one object.

getIdForUniqueLabelPath

public com.oakgrovesystems.reactor.ReactorObjectId getIdForUniqueLabelPath(com.oakgrovesystems.reactor.LabelPath uniquePathToMap,
                                                                           java.lang.Class filterClass)
                                                                    throws IdentifierMappingException
Maps a LabelPath to a ReactorObjectId.

Parameters:
uniquePathToMap - The LabelPath that must resolve to an object for that object to be included in the returned Set.
filterClass - The Class with which an object must be assignment compatible in order to be included in the returned Set.
Returns:
The ReactorObjectId of an Object o such that the LabelPath pathToMap will resolve to o and filterClass.isInstance(o)==true. Returns null if no such objects are available to the mapper.
Throws:
IdentifierMappingException - If the LabelPath provided maps to more than one object that is assignment compatible with the given class.

getIdForUniqueLabelPath

public com.oakgrovesystems.reactor.ReactorObjectId getIdForUniqueLabelPath(com.oakgrovesystems.reactor.LabelPath uniquePathToMap,
                                                                           java.lang.Class filterClass,
                                                                           com.oakgrovesystems.reactor.ReactorObjectId root)
                                                                    throws IdentifierMappingException
Maps a LabelPath to a ReactorObjectId with the id specified as the starting point for label path resolution.

Parameters:
uniquePathToMap - The LabelPath that must resolve to an object for that object to be included in the returned Set.
filterClass - The Class with which an object must be assignment compatible in order to be included in the returned Set.
Returns:
The ReactorObjectId of an Object o such that the LabelPath pathToMap will resolve to o and filterClass.isInstance(o)==true. Returns null if no such objects are available to the mapper.
Throws:
IdentifierMappingException - If the LabelPath provided maps to more than one object that is assignment compatible with the given class.


Copyright (c) 1999-2004 Oak Grove Systems. All Rights Reserved.