public interface Edge extends OsidRelationship
A Edge
represents relationship between two nodes.
Modifier and Type | Method and Description |
---|---|
java.math.BigDecimal |
getCost()
Gets the cost of this edge.
|
Node |
getDestinationNode()
Gets the destination node of this edge.
|
Id |
getDestinationNodeId()
Gets the
Id of the destination node of this edge. |
java.math.BigDecimal |
getDistance()
Gets the distance of this edge.
|
EdgeRecord |
getEdgeRecord(Type edgeRecordType)
Gets the edge record corresponding to the given
Edge
record Type. |
Node |
getSourceNode()
Gets the
Id of the source node of this edge. |
Id |
getSourceNodeId()
Gets the source node of this edge.
|
boolean |
isBiDirectional()
Tests if this directional edge is bi-directional.
|
boolean |
isDirectional()
Tests if this is a directional edge.
|
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
boolean isDirectional()
true
if this edge is directional, false
otherwisemandatory
- This method must be implemented. boolean isBiDirectional()
true
if this edge is directional and
bi-directional, false
otherwiseIllegalStateException
- isDirectional()
is false
mandatory
- This method must be implemented. java.math.BigDecimal getCost()
mandatory
- This method must be implemented. java.math.BigDecimal getDistance()
mandatory
- This method must be implemented. Id getSourceNodeId()
Id
mandatory
- This method must be implemented. Node getSourceNode() throws OperationFailedException
Id
of the source node of this edge. If the
edge is uni-directional, the source node is the node at the beginning
of the edge, otherwise it may be relative to the means of traversal of
the graph.OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getDestinationNodeId()
Id
of the destination node of this edge. If
the edge is uni-directional, the destination node is the node at the
end of the edge, otherwise it may be relative to the means of
traversal of the graph. Id
mandatory
- This method must be implemented. Node getDestinationNode() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. EdgeRecord getEdgeRecord(Type edgeRecordType) throws OperationFailedException
Edge
record Type.
This method is used to retrieve an object
implementing the requested record. The edgeRecordType
may be the Type
returned in getRecordTypes()
or any of its parents in a Type
hierarchy where
hasRecordType(edgeRecordType)
is true
.edgeRecordType
- the type of edge record to retrieveNullArgumentException
- edgeRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(edgeRecordType)
is false
mandatory
- This method must be implemented.