wt.graph
Interface ObjectGraphEdge

All Superinterfaces:

Cloneable, GraphEdgeModel, Link, NetFactor, ObjectMappable, Persistable, Serializable

All Known Subinterfaces:

ObjectGraphEdgeTemplate

All Known Implementing Classes:

AbstractObjectGraphEdge, AbstractObjectGraphEdgeTemplate

public interface ObjectGraphEdge

extends Persistable, Link, GraphEdgeModel

Provides a top-level abstraction of an edge in an object graph. Each edge represents an object in the graph where it is either a type of link or object reference.

When an edge represents an instance of a type of link it can take on the form of any of the types of predefined (bidirectional) binary links. When an edge represents a type of object reference it can take on the form of any of the types of predefined (unidirectional) object references.

The way in which this versitility is realized is each edge can hold at least one, and up to two, edge references. An edge reference can in turn hold either an object identifier or version foreign key as the query key. However, no one edge reference can hold zero or two keys.

Supported API: false

Extendable: false

Field Summary

static String	EXCLUDED Label for the attribute; The flag that indicates whether or not an edge is to be excluded from the object graph, and if so all nodes playing the role of neighbor to the origin.
static String	GRAPH Label for the attribute.
static String	ID Label for the attribute.
static String	INFO Label for the attribute.
static String	NEIGHBOR_ROLE Label for the attribute.
static String	ORIGIN_ROLE Label for the attribute.
static String	ROLE_AOBJECT_REF Label for the attribute.
static String	ROLE_BOBJECT_REF Label for the attribute.

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.fc.Link

ALL_ROLES, BOTH_ROLES, ROLE_AOBJECT_ROLE, ROLE_BOBJECT_ROLE

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.
GraphNodeModel	getNeighbor() Gets the object for the association that plays role: NEIGHBOR_ROLE.
GraphNodeModel	getOrigin() Gets the object for the association that plays role: ORIGIN_ROLE.
WTReference	getRoleAObjectRef() Supported API: false
WTReference	getRoleBObjectRef() Supported API: false
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.
void	setNeighbor(GraphNodeModel neighbor) Sets the object for the association that plays role: NEIGHBOR_ROLE.
void	setOrigin(GraphNodeModel origin) Sets the object for the association that plays role: ORIGIN_ROLE.
void	setRoleAObjectRef(WTReference a_RoleAObjectRef) Supported API: false
void	setRoleBObjectRef(WTReference a_RoleBObjectRef) Supported API: false

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.fc.Link

appendJoinCriteria, appendRoleCriteria, getAllObjects, getJoinValues, getLinkInfo, getObject, getOtherObject, getRole, getRoleAObject, getRoleAObjectId, getRoleBObject, getRoleBObjectId, getRoleIdName, getRoleObject, setRoleAObject, setRoleBObject, setRoleObject

Methods inherited from interface wt.util.graph.GraphEdgeModel

clone, equals

Field Detail

ORIGIN_ROLE

public static final String ORIGIN_ROLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

NEIGHBOR_ROLE

public static final String NEIGHBOR_ROLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

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 an edge is to be excluded from the object graph, and if so all nodes playing the role of neighbor to the origin. By default a node is always included.

Supported API: false

See Also:

Constant Field Values

ROLE_AOBJECT_REF

public static final String ROLE_AOBJECT_REF

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

ROLE_BOBJECT_REF

public static final String ROLE_BOBJECT_REF

Label for the attribute.

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

getOrigin

public GraphNodeModel getOrigin()

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

Supported API: false

Returns:

GraphNodeModel

setOrigin

public void setOrigin(GraphNodeModel origin)

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

Supported API: false

Parameters:

origin -

getNeighbor

public GraphNodeModel getNeighbor()

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

Supported API: false

Returns:

GraphNodeModel

setNeighbor

public void setNeighbor(GraphNodeModel neighbor)

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

Supported API: false

Parameters:

neighbor -

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

getRoleAObjectRef

public WTReference getRoleAObjectRef()

Supported API: false

Specified by:

getRoleAObjectRef in interface Link

Returns:

WTReference

setRoleAObjectRef

public void setRoleAObjectRef(WTReference a_RoleAObjectRef)

Supported API: false

Specified by:

setRoleAObjectRef in interface Link

Parameters:

a_RoleAObjectRef - The role A object for this Link.

getRoleBObjectRef

public WTReference getRoleBObjectRef()

Supported API: false

Specified by:

getRoleBObjectRef in interface Link

Returns:

WTReference

setRoleBObjectRef

public void setRoleBObjectRef(WTReference a_RoleBObjectRef)

Supported API: false

Specified by:

setRoleBObjectRef in interface Link

Parameters:

a_RoleBObjectRef - The role A object for this Link.

setExcluded

public void setExcluded(Boolean value)

Supported API: false

Parameters:

value -

isExcluded

public boolean isExcluded()

Supported API: false

Returns:

boolean