Package uk.gov.gchq.gaffer.operation.data

Class EdgeSeed

java.lang.Object

uk.gov.gchq.gaffer.operation.data.ElementSeed

uk.gov.gchq.gaffer.operation.data.EdgeSeed

All Implemented Interfaces:

Serializable, EdgeId, ElementId

public class EdgeSeed
extends ElementSeed
implements EdgeId

An EdgeSeed contains source, destination and directed identifiers to identify an Edge. It is mainly used as a seed for queries.

See Also:

Serialized Form

Nested Class Summary

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

EdgeId.MatchedVertex

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

ElementId.Matches

Constructor Summary

Constructors

Constructor	Description
EdgeSeed()
EdgeSeed(Object source, Object destination)
EdgeSeed(Object source, Object destination, boolean directed)
EdgeSeed(Object source, Object destination, boolean directed, EdgeId.MatchedVertex matchedVertex)
EdgeSeed(Object source, Object destination, Boolean directed, DirectedType directedType, EdgeId.MatchedVertex matchedVertex)
EdgeSeed(Object source, Object destination, DirectedType directed)
EdgeSeed(Object source, Object destination, DirectedType directed, EdgeId.MatchedVertex matchedVertex)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Note this does not include the matchedVertex field.
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.
Object	getSource()	Get the source vertex.
int	hashCode()	Note this does not include the matchedVertex field.
void	setIdentifiers(Object source, Object destination, DirectedType directed, EdgeId.MatchedVertex matchedVertex)
String	toString()

Methods inherited from class uk.gov.gchq.gaffer.operation.data.ElementSeed

createSeed, createSeed, createSeed

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

getAdjacentMatchedVertexValue, getMatchedVertexValue, isDirected, isEqual, isEqual, isRelated, isRelated, isUndirected, setIdentifiers

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

getClassName, setClassName

Constructor Detail

EdgeSeed

public EdgeSeed()

EdgeSeed

public EdgeSeed(Object source,
                Object destination)

EdgeSeed

public EdgeSeed(Object source,
                Object destination,
                boolean directed)

EdgeSeed

public EdgeSeed(Object source,
                Object destination,
                DirectedType directed)

EdgeSeed

public EdgeSeed(Object source,
                Object destination,
                boolean directed,
                EdgeId.MatchedVertex matchedVertex)

EdgeSeed

public EdgeSeed(Object source,
                Object destination,
                DirectedType directed,
                EdgeId.MatchedVertex matchedVertex)

EdgeSeed

public EdgeSeed(Object source,
                Object destination,
                Boolean directed,
                DirectedType directedType,
                EdgeId.MatchedVertex matchedVertex)

Method Detail

getSource

public Object getSource()

Description copied from interface: EdgeId

Get the source vertex.

Specified by:

getSource in interface EdgeId

Returns:

the object at the edge source

getDestination

public Object getDestination()

Description copied from interface: EdgeId

Get the destination vertex.

Specified by:

getDestination in interface EdgeId

Returns:

the object at the edge destination

getDirectedType

public DirectedType getDirectedType()

Description copied from interface: EdgeId

Get the directionality of the current edge.

Specified by:

getDirectedType in interface EdgeId

Returns:

the directed type

setIdentifiers

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

Specified by:

setIdentifiers in interface EdgeId

getMatchedVertex

public EdgeId.MatchedVertex getMatchedVertex()

Description copied from interface: EdgeId

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

Specified by:

getMatchedVertex in interface EdgeId

Returns:

the matched vertex

equals

public boolean equals(Object obj)

Note this does not include the matchedVertex field.

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

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

hashCode

public int hashCode()

Note this does not include the matchedVertex field.

Overrides:

hashCode in class Object

Returns:

a hash code value for this edge.

toString

public String toString()

Overrides:

toString in class Object