wt.graph
Interface ObjectGraphNode

All Superinterfaces:

Cloneable, GraphNodeModel, NetFactor, NodeExpander, ObjectMappable, Persistable, Serializable

All Known Subinterfaces:

ObjectGraph, ObjectGraphNodeTemplate, ObjectGraphTemplate

All Known Implementing Classes:

AbstractObjectGraph, AbstractObjectGraphNode, AbstractObjectGraphNodeTemplate, AbstractObjectGraphTemplate

public interface ObjectGraphNode

extends NodeExpander, Persistable, Cloneable, GraphNodeModel

Provides a top-level abstraction of a node in an object graph. Each node represents an object in the graph where they are connected to one another via edges.

An object graph node plays as either an origin or neighbor type of role. When starting at the root of the graph, an origin type of node is one that is traversed before its neighbors. Conversly, a neighbor type of node is traversed after its origin. Each node can have zero-to-many origins and zero-to-many neighbors.

For example, a node that has zero origins and zero, one or more neighbors is the root of an object graph. A node that has many origins and many neighbors is somewhere inside of the object graph, not at one of its boundaries (i.e., root or leaf). And a node that has one or more origins and zero neighbors is a leaf in the object graph.

Supported API: false

Extendable: false

Field Summary

static String	EXCLUDED Label for the attribute; The flag that indicates whether or not a node is to be excluded from the object graph, and if so all nodes playing the role of neighbor to itself.
static String	GRAPH Label for the attribute.
static String	ID Label for the attribute.
static String	INFO Label for the attribute.

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.util.graph.GraphNodeModel

NEIGHBOR

Method Summary

ObjectReference	getGraph() Gets the object for the association that plays role: GRAPH.
String	getId() Gets the value of the attribute: ID.
ObjectInfo	getInfo() Gets the object for the association that plays role: INFO.
boolean	isExcluded() Supported API: false
void	setExcluded(Boolean value) Supported API: false
void	setGraph(ObjectReference a_Graph) Sets the object for the association that plays role: GRAPH.
void	setId(String a_Id) Sets the value of the attribute: ID.
void	setInfo(ObjectInfo a_Info) Sets the object for the association that plays role: INFO.

Methods inherited from interface wt.visitor.NodeExpander

expandNode

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.ObjectMappable

readExternal, writeExternal

Methods inherited from interface wt.fc.NetFactor

getClassInfo, getConceptualClassname

Methods inherited from interface wt.util.graph.GraphNodeModel

clone, equals

Field Detail

ID

public static final String ID

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

EXCLUDED

public static final String EXCLUDED

Label for the attribute; The flag that indicates whether or not a node is to be excluded from the object graph, and if so all nodes playing the role of neighbor to itself. By default a node is always included.

Supported API: false

See Also:

Constant Field Values

INFO

public static final String INFO

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

GRAPH

public static final String GRAPH

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

Method Detail

getId

public String getId()

Gets the value of the attribute: ID.

Supported API: false

Returns:

String

setId

public void setId(String a_Id)
           throws WTPropertyVetoException

Sets the value of the attribute: ID.

Supported API: false

Parameters:

a_Id -

Throws:

WTPropertyVetoException

getInfo

public ObjectInfo getInfo()

Gets the object for the association that plays role: INFO.

Supported API: false

Returns:

ObjectInfo

setInfo

public void setInfo(ObjectInfo a_Info)

Sets the object for the association that plays role: INFO.

Supported API: false

Parameters:

a_Info -

getGraph

public ObjectReference getGraph()

Gets the object for the association that plays role: GRAPH.

Supported API: false

Returns:

ObjectReference

setGraph

public void setGraph(ObjectReference a_Graph)
              throws WTPropertyVetoException

Sets the object for the association that plays role: GRAPH.

Supported API: false

Parameters:

a_Graph -

Throws:

WTPropertyVetoException

setExcluded

public void setExcluded(Boolean value)

Supported API: false

Parameters:

value -

isExcluded

public boolean isExcluded()

Supported API: false

Returns:

boolean