| org.geotools.graph.structure.Graphable
All known Subclasses: org.geotools.graph.structure.basic.BasicGraphable, org.geotools.graph.structure.opt.OptGraphable,
| Graphable | | public interface Graphable (Code) | | Represents a component of a graph. Graph components
model "real life" entities. These entities are represented by an
underyling object reference.
See Also: Graph
author:
Justin Deoliveira, Refractions Research Inc, jdeolive@refractions.net |
| Method Summary | |
| public int | getCount()
Returns the value of the counter for the component. | | public int | getID()
Returns an identifier for the component. | | public Object | getObject()
Returns the underlying object referenced by the graph component. | | public Iterator | getRelated()
Returns an iterator over any related components. | | public boolean | isVisited()
Determines if the component has been marked as visited. | | public void | setCount(int count)
Sets the value of the counter for the component. | | public void | setID(int id)
Sets the identifying integer for the component. | | public void | setObject(Object obj)
Sets the underlying object reference for the component. | | public void | setVisited(boolean visited)
Marks the component as being visited/unvisited. |
| getCount | | public int getCount()(Code) | | Returns the value of the counter for the component. Graph components
have a counter associated with them to be used for graph queries, graph
traversals, or user defined purposes.
int The value of the counter for the component. |
| getID | | public int getID()(Code) | | Returns an identifier for the component. This number is not
necessarily persistent or unique.
Identifying integer. |
| getObject | | public Object getObject()(Code) | | Returns the underlying object referenced by the graph component.
Underlying object reference, the entity being modelled by graph component. |
| getRelated | | public Iterator getRelated()(Code) | | Returns an iterator over any related components. A graph component is
related to other components of the graph of similary type through some
relationship.
Iterator An iterator over other components of the graph that are related to the component. |
| isVisited | | public boolean isVisited()(Code) | | Determines if the component has been marked as visited. The visited
flag serves as a binary switch for the component which can be used
for graph queries, graph traversals, or user defined purposes.
True if visited(on), false if unvisited(off). |
| setCount | | public void setCount(int count)(Code) | | Sets the value of the counter for the component. Graph components
have a counter associated with them to be used for graph queries, graph
traversals, or user defined purposes.
Parameters:
count - The new value of the counter for the component. |
| setID | | public void setID(int id)(Code) | | Sets the identifying integer for the component.
Parameters:
id - New identifying integer. |
| setObject | | public void setObject(Object obj)(Code) | | Sets the underlying object reference for the component.
Parameters:
obj - The entity being modelled by the graph component. |
| setVisited | | public void setVisited(boolean visited)(Code) | | Marks the component as being visited/unvisited. The visited
flag serves as a binary switch for the component which can be used
for graph queries, graph traversals, or user defined purposes.
Parameters:
visited - True if visited(on), false if unvisited(off). |
|
|