Package dev.grafeo.gwp.types

Record Class GqlPath

java.lang.Object
java.lang.Record
dev.grafeo.gwp.types.GqlPath
Record Components:
nodes - the nodes in the path
edges - the edges in the path
public record GqlPath(List<GqlNode> nodes, List<GqlEdge> edges) extends Record
A path through a property graph: an alternating sequence of nodes and edges.

nodes[i] and nodes[i+1] are connected by edges[i].

  • Constructor Details

    • GqlPath

      public GqlPath(List<GqlNode> nodes, List<GqlEdge> edges)
      Creates an instance of a GqlPath record class.
      Parameters:
      nodes - the value for the nodes record component
      edges - the value for the edges record component

  • Method Details

    • length

      public int length()
      The number of edges in the path (path length).
      Returns:
      the number of edges

    • start

      public Optional<GqlNode> start()
      The start node of the path.
      Returns:
      the first node, or empty if the path has no nodes

    • end

      public Optional<GqlNode> end()
      The end node of the path.
      Returns:
      the last node, or empty if the path has no nodes

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • nodes

      public List<GqlNode> nodes()
      Returns the value of the nodes record component.
      Returns:
      the value of the nodes record component

    • edges

      public List<GqlEdge> edges()
      Returns the value of the edges record component.
      Returns:
      the value of the edges record component