Package org.apache.graphar.vertices

Interface VertexIter

  • All Superinterfaces:
    com.alibaba.fastffi.CXXPointer, com.alibaba.fastffi.FFIPointer, com.alibaba.fastffi.FFIType
    public interface VertexIter
extends com.alibaba.fastffi.CXXPointer
    The iterator for traversing a type of vertices.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static interface  VertexIter.Factory
      The add operator.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean eq​(VertexIter other)
      The equality operator.
      Vertex get()
      Construct and return the vertex of the current offset.
      @com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long id()
      Get the vertex id of the current offset.
      VertexIter inc()  
      <T> Result<T> property​(StdString property, T tObject)
      Get the value for a property of the current vertex.

      • Methods inherited from interface com.alibaba.fastffi.CXXPointer

        delete

      • Methods inherited from interface com.alibaba.fastffi.FFIPointer

        getAddress

    • Method Detail

      • get

        Vertex get()
        Construct and return the vertex of the current offset.

      • id

        @com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long id()
        Get the vertex id of the current offset.

      • property

        <T> Result<T> property​(StdString property,
                       T tObject)
        Get the value for a property of the current vertex.
        Parameters:
        property - StdString that describe property.
        tObject - An object that instance of the return type. Supporting types:StdString, Long

        e.g.
        StdString name = StdString.create("name");
        StdString nameProperty = vertexIter.property(name, name);

        If you don't want to create an object, cast `Xxx` class to `XxxGen` and call this method with `(ReturnType) null`.
        e.g.
        StdString nameProperty = ((VertexIterGen)vertexIter).property(StdString.create("name"), (StdString) null);

        Returns:
        Result: The property value or error.

      • eq

        boolean eq​(VertexIter other)
        The equality operator.