|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The Marker
class provides the abstraction of a persistent named
marker. A marker is associated with a storage: the Marker
class
provides a method to retrieve an instance of Storage
that
represents the associated storage. A marker marks a specific node, its
marked node. Each marker is identified by a name that is required to
be unique within the containing storage; each marker is also identified by a
unique integer identifier.
More than one marker may mark a specific node. A node is reachable if
it is marked by one or more markers, or if it is reachable from a marked node,
recursively. The Marker
class provides methods to retrieve the
marked node and to reuse this marker to mark another node.
Method Summary | |
void |
close()
Releases a marker's resources and closes it immediately. |
void |
delete()
Deletes the underlying storage occupied by this marker in its associated storage and recursively deletes nodes and vertices that become unreachable as a result of the deletion. |
Node |
getMarkedNode()
Returns the node marked by this marker. |
java.lang.String |
getName()
Returns the name with which this marker was created. |
Storage |
getStorage()
Returns the storage associated with this marker. |
int |
getUniqueID()
Returns the integer that uniquely identifies this marker within its associated storage. |
boolean |
isClosed()
Tests to see if a marker is closed. |
void |
setMarkedNode(Node n)
Sets the node marked by this marker to n. |
Method Detail |
public java.lang.String getName() throws E4GraphException
E4GraphException
- if an error occurspublic Storage getStorage() throws E4GraphException
E4GraphException
- if an error occurspublic Node getMarkedNode() throws E4GraphException
E4GraphException
- if an error occurspublic void setMarkedNode(Node n) throws E4GraphException
n
- the new node to be marked by this markerE4GraphException
- if an error occurspublic int getUniqueID() throws E4GraphException
E4GraphException
- if an error occurspublic void delete() throws E4GraphException
E4GraphException
- if an error occurspublic boolean isClosed()
public void close()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |