Package io.objectbox.flatbuffers

Class BaseVector

java.lang.Object
io.objectbox.flatbuffers.BaseVector
Direct Known Subclasses:
BooleanVector, ByteVector, ClusterPeerConfig.Vector, Credentials.Vector, DoubleVector, FlatStoreOptions.Vector, FloatVector, HnswParams.Vector, IdUid.Vector, IntVector, JwtConfig.Vector, LongVector, Model.Vector, ModelEntity.Vector, ModelProperty.Vector, ModelRelation.Vector, ShortVector, StringVector, SyncServerOptions.Vector, UnionVector
public class BaseVector extends Object
All vector access objects derive from this class, and add their own accessors.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected ByteBuffer
    bb
    The underlying ByteBuffer to hold the data of the vector.
    private int
    element_size
    Used to hold the vector element size in table.
    private int
    length
    Used to hold the vector size.
    private int
    vector
    Used to hold the vector data position.

  • Constructor Summary

    Constructors
    Constructor
    Description
    BaseVector()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected int
    __element(int j)
    Gets the element position in vector's ByteBuffer.
    protected void
    __reset(int _vector, int _element_size, ByteBuffer _bb)
    Re-init the internal state with an external buffer ByteBuffer, an offset within and element size.
    protected int
    __vector()
    Get the start data of a vector.
    int
    length()
    Get the length of a vector.
    void
    reset()
    Resets the internal state with a null ByteBuffer and a zero position.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • vector

      private int vector
      Used to hold the vector data position.

    • length

      private int length
      Used to hold the vector size.

    • element_size

      private int element_size
      Used to hold the vector element size in table.

    • bb

      protected ByteBuffer bb
      The underlying ByteBuffer to hold the data of the vector.

  • Constructor Details

    • BaseVector

      public BaseVector()

  • Method Details

    • __vector

      protected int __vector()
      Get the start data of a vector.
      Returns:
      Returns the start of the vector data.

    • __element

      protected int __element(int j)
      Gets the element position in vector's ByteBuffer.
      Parameters:
      j - An `int` index of element into a vector.
      Returns:
      Returns the position of the vector element in a ByteBuffer.

    • __reset

      protected void __reset(int _vector, int _element_size, ByteBuffer _bb)
      Re-init the internal state with an external buffer ByteBuffer, an offset within and element size. This method exists primarily to allow recycling vector instances without risking memory leaks due to ByteBuffer references.

    • reset

      public void reset()
      Resets the internal state with a null ByteBuffer and a zero position. This method exists primarily to allow recycling vector instances without risking memory leaks due to ByteBuffer references. The instance will be unusable until it is assigned again to a ByteBuffer.

    • length

      public int length()
      Get the length of a vector.
      Returns:
      Returns the length of the vector.