Package org.apache.graphar.readers.arrowchunk

Interface AdjListArrowChunkReader

  • All Superinterfaces:
    com.alibaba.fastffi.CXXPointer, com.alibaba.fastffi.FFIPointer, com.alibaba.fastffi.FFIType
    public interface AdjListArrowChunkReader
extends com.alibaba.fastffi.CXXPointer
    The arrow chunk reader for adj list topology chunk.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Result<StdSharedPtr<ArrowTable>> getChunk()
      Get the current offset chunk as arrow::Array.
      Result<Long> getRowNumOfChunk()
      Get the number of rows of the current chunk table.
      Status nextChunk()
      Sets chunk position indicator to next chunk.
      Status seek​(@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long offset)
      Sets chunk position indicator for reader by edge index.
      Status seekChunkIndex​(@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long vertexChunkIndex)
      Sets chunk position to the specific vertex chunk and edge chunk.
      Status seekChunkIndex​(@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long vertexChunkIndex, @com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long chunkIndex)
      Sets chunk position to the specific vertex chunk and edge chunk.
      Status seekDst​(@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long offset)
      Sets chunk position indicator for reader by destination vertex id.
      Status seekSrc​(@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long id)
      Sets chunk position indicator for reader by source vertex id.

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

        delete

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

        getAddress

    • Method Detail

      • seekSrc

        Status seekSrc​(@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long id)
        Sets chunk position indicator for reader by source vertex id.
        Parameters:
        id - the source vertex id.

      • seekDst

        Status seekDst​(@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long offset)
        Sets chunk position indicator for reader by destination vertex id.
        Parameters:
        offset - the destination vertex id.

      • seek

        Status seek​(@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long offset)
        Sets chunk position indicator for reader by edge index.
        Parameters:
        offset - edge index of the vertex chunk. Note: the offset is the edge index of the vertex chunk, not the edge index of the whole graph.

      • getRowNumOfChunk

        Result<Long> getRowNumOfChunk()
        Get the number of rows of the current chunk table.

      • nextChunk

        Status nextChunk()
        Sets chunk position indicator to next chunk.
        Returns:
        Status: ok or EndOfChunk error if the reader is at the end of current vertex chunk, or IndexError error if the reader is at the end of all vertex chunks.

      • seekChunkIndex

        Status seekChunkIndex​(@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long vertexChunkIndex)
        Sets chunk position to the specific vertex chunk and edge chunk.
        Parameters:
        vertexChunkIndex - the vertex chunk index.
        Returns:
        Status: ok or error

      • seekChunkIndex

        Status seekChunkIndex​(@com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long vertexChunkIndex,
                      @com.alibaba.fastffi.FFITypeAlias("graphar::IdType") long chunkIndex)
        Sets chunk position to the specific vertex chunk and edge chunk.
        Parameters:
        vertexChunkIndex - the vertex chunk index.
        chunkIndex - the edge chunk index of vertex_chunk_index, C++ default is 0.
        Returns:
        Status: ok or error