|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface INodeLocator
an interface to aid processing engines in locating or describing components of a model during a process. Implementations perform two primary functions:
Implementations are model-specific and should be defined within model configuration files. They should also
not implement this interface directly, but extend AbstractNodeLocator
.
AbstractNodeLocator
Method Summary | |
---|---|
Properties |
describe(Object element)
describe the specified element. |
Object |
find(String path,
Object startNode)
finds an object in a model given the specified path. |
Object[] |
findAll(String path,
Object startNode)
finds all objects in a model that match the specified path. |
String |
locate(Object element,
Object root)
locate a component within a model from the given root. |
Method Detail |
---|
String locate(Object element, Object root)
describey
to provide a
richer description of the component.
element
- element within a graph to be locatedroot
- - root from which element is to be located or null
if
element is to be found from a start node in the graph
Object find(String path, Object startNode)
locate
is just such a path.
If a startNode is specified, the path is assumed to have that startNode
as its context node. If the startNode is null
, the model's start nodes
will be used as supplying potential context nodes for the path.
The parameters for searching for a node can be defined in
the Configuration.MODEL_ID
symbol pool using the public symbolic constants of this interface.
path
- - path to desired node in the modelstartNode
- - context for the path (may be null
)
null
if no object in the model
matches the given pathObject[] findAll(String path, Object startNode)
locate
is just such a path.
If a startNode is specified, the path is assumed to have that startNode
as its context node. If the startNode is null
, the model's start nodes
will be used as supplying potential context nodes for the path.
The parameters for searching for a node can be defined in
the Configuration.MODEL_ID
symbol pool using the public symbolic constants of this interface.
path
- - path to desired nodes in the modelstartNode
- - context for the path (may be null
)
Properties describe(Object element)
element
- element to be described or distinguished
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |