Package uk.gov.gchq.gaffer.data.element.id

Interface EdgeId

All Superinterfaces:

ElementId, Serializable

All Known Implementing Classes:

Edge, EdgeSeed, LazyEdge

public interface EdgeId
extends ElementId

An EdgeId is an interface describing the core methods that are required in order to identify an Edge.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	EdgeId.MatchedVertex	Enumerated type to denote which vertex of an Edge matches an input parameter.

Nested classes/interfaces inherited from interface uk.gov.gchq.gaffer.data.element.id.ElementId

ElementId.Matches

Method Summary

Modifier and Type	Method	Description
default Object	getAdjacentMatchedVertexValue()
Object	getDestination()	Get the destination vertex.
DirectedType	getDirectedType()	Get the directionality of the current edge.
EdgeId.MatchedVertex	getMatchedVertex()	Get the vertex which is to be reported if a matched vertex is requested.
default Object	getMatchedVertexValue()
Object	getSource()	Get the source vertex.
default boolean	isDirected()
default boolean	isEqual(EdgeId that)	Note this does not include the matchedVertex field.
default boolean	isEqual(ElementId that)
default ElementId.Matches	isRelated(ElementId that)	This is related to an ElementId if either the ElementId is equal to this EdgeId or it is an EntityId and its identifier matches this EdgeId's source or destination.
default ElementId.Matches	isRelated(EntityId that)	This is related to an EntityId if the EntityId's identifier matches this EdgeId's source or destination.
default boolean	isUndirected()
default void	setIdentifiers(Object source, Object destination, DirectedType directed)
void	setIdentifiers(Object source, Object destination, DirectedType directedType, EdgeId.MatchedVertex matchedVertex)

Methods inherited from interface uk.gov.gchq.gaffer.data.element.id.ElementId

getClassName, setClassName

Method Detail

getSource

Object getSource()

Get the source vertex.

Returns:

the object at the edge source

getDestination

Object getDestination()

Get the destination vertex.

Returns:

the object at the edge destination

getDirectedType

DirectedType getDirectedType()

Get the directionality of the current edge.

Returns:

the directed type

isDirected

default boolean isDirected()

Returns:

true if directed is DIRECTED, EITHER or null. Otherwise false.

isUndirected

default boolean isUndirected()

Returns:

true if directed is UNDIRECTED, EITHER or null. Otherwise false.

setIdentifiers

default void setIdentifiers(Object source,
                            Object destination,
                            DirectedType directed)

setIdentifiers

void setIdentifiers(Object source,
                    Object destination,
                    DirectedType directedType,
                    EdgeId.MatchedVertex matchedVertex)

getMatchedVertex

EdgeId.MatchedVertex getMatchedVertex()

Get the vertex which is to be reported if a matched vertex is requested.

Returns:

the matched vertex

isEqual

default boolean isEqual(ElementId that)

Specified by:

isEqual in interface ElementId

isEqual

default boolean isEqual(EdgeId that)

Note this does not include the matchedVertex field.

Parameters:

that - the reference EdgeId with which to compare.

Returns:

true if this object is the same as the edge argument; false otherwise.

isRelated

default ElementId.Matches isRelated(ElementId that)

This is related to an ElementId if either the ElementId is equal to this EdgeId or it is an EntityId and its identifier matches this EdgeId's source or destination.

Specified by:

isRelated in interface ElementId

Parameters:

that - the ElementId to compare

Returns:

An instance of ElementId.Matches to describe how the ids are related.

isRelated

default ElementId.Matches isRelated(EntityId that)

This is related to an EntityId if the EntityId's identifier matches this EdgeId's source or destination.

Parameters:

that - the ElementId to compare

Returns:

An instance of ElementId.Matches to describe how the ids are related.

getMatchedVertexValue

default Object getMatchedVertexValue()

getAdjacentMatchedVertexValue

default Object getAdjacentMatchedVertexValue()