Class TinkerEdge

  • All Implemented Interfaces:
    Edge, Element

    public class TinkerEdge
    extends TinkerElement
    implements Edge
    Author:
    Marko A. Rodriguez (http://markorodriguez.com)
    • Method Detail

      • property

        public <V> Property<V> property​(String key,
                                        V value)
        Description copied from interface: Element
        Add or set a property value for the Element given its key.
        Specified by:
        property in interface Element
      • keys

        public Set<String> keys()
        Description copied from interface: Element
        Get the keys of the properties associated with this element. The default implementation iterators the properties and stores the keys into a HashSet.
        Specified by:
        keys in interface Element
        Returns:
        The property key set
      • remove

        public void remove()
        Description copied from interface: Element
        Removes the Element from the graph.
        Specified by:
        remove in interface Element
      • outVertex

        public Vertex outVertex()
        Description copied from interface: Edge
        Get the outgoing/tail vertex of this edge.
        Specified by:
        outVertex in interface Edge
        Returns:
        the outgoing vertex of the edge
      • inVertex

        public Vertex inVertex()
        Description copied from interface: Edge
        Get the incoming/head vertex of this edge.
        Specified by:
        inVertex in interface Edge
        Returns:
        the incoming vertex of the edge
      • vertices

        public Iterator<Vertex> vertices​(Direction direction)
        Description copied from interface: Edge
        Retrieve the vertex (or vertices) associated with this edge as defined by the direction. If the direction is Direction.BOTH then the iterator order is: Direction.OUT then Direction.IN.
        Specified by:
        vertices in interface Edge
        Parameters:
        direction - Get the incoming vertex, outgoing vertex, or both vertices
        Returns:
        An iterator with 1 or 2 vertices
      • graph

        public Graph graph()
        Description copied from interface: Element
        Get the graph that this element is within.
        Specified by:
        graph in interface Element
        Returns:
        the graph of this element
      • properties

        public <V> Iterator<Property<V>> properties​(String... propertyKeys)
        Description copied from interface: Edge
        Get an Iterator of properties where the propertyKeys is meant to be a filter on the available keys. If no keys are provide then return all the properties.
        Specified by:
        properties in interface Edge
        Specified by:
        properties in interface Element