Package uk.gov.gchq.gaffer.operation.impl.get

Class GetElements

  • All Implemented Interfaces:
    Closeable, AutoCloseable, GraphFilters, OperationView, SeededGraphFilters, Input<Iterable<? extends ElementId>>, InputOutput<Iterable<? extends ElementId>,​Iterable<? extends Element>>, MultiElementIdInput, MultiInput<ElementId>, Output<Iterable<? extends Element>>, Operation
    public class GetElements
extends Object
implements InputOutput<Iterable<? extends ElementId>,​Iterable<? extends Element>>, MultiElementIdInput, SeededGraphFilters
    Gets elements from Gaffer based on ElementIds as seeds and returns Elements There are various flags to filter out the elements returned: Equal will only return Elements with identifiers that match the seed exactly. Related will return:
    • Entities when their vertex matches vertex of a EntityId
    • Entities when their vertex matches the source or destination of a EdgeId
    • Edges when their source, destination and directed type matches the EdgeId
    • Edges when their source, destination matches the EdgeId where the DirectedType of the EdgeId is DirectedType.EITHER
    • Edges when their source or destination match the EntityId's vertex
    includeIncomingOutGoing - what type of edges to include
    • IncludeIncomingOutgoingType.INCOMING - only returns edges where the destination matches the vertex of EntityId
    • IncludeIncomingOutgoingType.OUTGOING - only returns edges where the source matches the vertex of EntityId
    • IncludeIncomingOutgoingType.EITHER - returns all edges regardless of their direction
    directedType - whether to return directed, undirected or either edges
    • DirectedType.DIRECTED - only return directed edges
    • DirectedType.UNDIRECTED - only return undirected edges
    • DirectedType.EITHER - return both directed or undirected edges