Interface EntityId
-
- All Superinterfaces:
ElementId
,Serializable
- All Known Implementing Classes:
Entity
,EntitySeed
,LazyEntity
public interface EntityId extends ElementId
AnEntityId
is an interface describing the core methods that are required in order to identify anEntity
.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface uk.gov.gchq.gaffer.data.element.id.ElementId
ElementId.Matches
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description Object
getVertex()
Get the vertex object.default boolean
isEqual(ElementId that)
default boolean
isEqual(EntityId that)
default ElementId.Matches
isRelated(EdgeId that)
This is related to anEdgeId
if either the EdgeId's source or destination matches this EntityId's vertex.default ElementId.Matches
isRelated(ElementId that)
This is related to anElementId
if either the ElementId is equal to this EntityId or it is an EdgeId and its source or destination matches this EntityId's vertex.void
setVertex(Object vertex)
Set the vertex object.-
Methods inherited from interface uk.gov.gchq.gaffer.data.element.id.ElementId
getClassName, setClassName
-
-
-
-
Method Detail
-
getVertex
Object getVertex()
Get the vertex object.- Returns:
- the vertex
-
setVertex
void setVertex(Object vertex)
Set the vertex object.- Parameters:
vertex
- the vertex object to set
-
isEqual
default boolean isEqual(EntityId that)
-
isRelated
default ElementId.Matches isRelated(ElementId that)
This is related to anElementId
if either the ElementId is equal to this EntityId or it is an EdgeId and its source or destination matches this EntityId's vertex.- Specified by:
isRelated
in interfaceElementId
- Parameters:
that
- theElementId
to compare- Returns:
- An instance of
ElementId.Matches
to describe how the seeds are related.
-
isRelated
default ElementId.Matches isRelated(EdgeId that)
This is related to anEdgeId
if either the EdgeId's source or destination matches this EntityId's vertex.- Parameters:
that
- theEdgeId
to compare- Returns:
- An instance of
ElementId.Matches
to describe how the seeds are related.
-
-