Module org.elasticsearch.compute
Package org.elasticsearch.compute.data

Interface BytesRefVector

All Superinterfaces:
org.apache.lucene.util.Accountable, AutoCloseable, Closeable, RefCounted, Releasable, Vector
All Known Implementing Classes:
BytesRefArrayVector, BytesRefArrowBufVector, ConstantBytesRefVector, ConstantNullVector, DirectBytesRefVector, OrdinalBytesRefVector
public sealed interface BytesRefVector extends Vector permits ConstantBytesRefVector, BytesRefArrayVector, ConstantNullVector, OrdinalBytesRefVector, DirectBytesRefVector, BytesRefArrowBufVector
Vector that stores BytesRef values. This class is generated. Edit X-Vector.java.st instead.

  • Method Details

    • getBytesRef

      org.apache.lucene.util.BytesRef getBytesRef(int position, org.apache.lucene.util.BytesRef dest)
      Build a contiguous array of bytes for the value stored at the given position. The underlying data is generally stored in pages that look like byte[][] with some data spanning more than one of the inner byte[] arrays. In that case, this builds a byte[] in the BytesRef, copies the bytes, and returns it. Otherwise, this returns a zero-copy snapshot of the underlying data. Except arrow. Arrow always copies.

      If possible, use get(int, org.elasticsearch.common.bytes.PagedBytesCursor) because it only needs to copy in the arrow implementation.

      Parameters:
      position - the position index
      dest - the destination
      Returns:
      the data value (as a BytesRef)

    • get

      PagedBytesCursor get(int position, PagedBytesCursor scratch)
      Retrieves the bytes value stored at the given value index using a PagedBytesCursor for zero-copy access to the underlying paged byte storage. Except arrow. Arrow always copies.
      Parameters:
      position - the position index
      scratch - the cursor to initialize and return
      Returns:
      the initialized cursor pointing to the value's bytes

    • asBlock

      BytesRefBlock asBlock()
      Description copied from interface: Vector
      Returns a new Block containing this vector.
      Specified by:
      asBlock in interface Vector
      Returns:
      a new Block containing this vector

    • asOrdinals

      OrdinalBytesRefVector asOrdinals()
      Returns an ordinal BytesRef vector if this vector is backed by a dictionary and ordinals; otherwise, returns null. Callers must not release the returned vector as no extra reference is retained by this method.

    • filter

      BytesRefVector filter(boolean mayContainDuplicates, int[] positions, int offset, int length)
      Description copied from interface: Vector
      Creates a new vector that only exposes the positions provided. Materialization of the selected positions is avoided.
      Specified by:
      filter in interface Vector
      Parameters:
      mayContainDuplicates - may the positions array contain duplicate positions?
      positions - the positions array
      offset - the start index in the positions array
      length - the number of positions to use from the array
      Returns:
      a filtered vector

    • filter

      default BytesRefVector filter(boolean mayContainDuplicates, int... positions)
      Description copied from interface: Vector
      Creates a new vector that only exposes the positions provided. Materialization of the selected positions is avoided.
      Specified by:
      filter in interface Vector
      Parameters:
      mayContainDuplicates - may the positions array contain duplicate positions?
      positions - the positions to retain
      Returns:
      a filtered vector

    • keepMask

      BytesRefBlock keepMask(BooleanVector mask)
      Description copied from interface: Vector
      Build a Block the same values as this Vector, but replacing all values for which mask.getBooleanValue(position) returns false with null. The mask vector must be at least as long as this Vector.
      Specified by:
      keepMask in interface Vector

    • deepCopy

      default BytesRefVector deepCopy(BlockFactory blockFactory)
      Make a deep copy of this Vector using the provided BlockFactory, likely copying all data.
      Specified by:
      deepCopy in interface Vector

    • lookup

      ReleasableIterator<? extends BytesRefBlock> lookup(IntBlock positions, ByteSizeValue targetBlockSize)
      Description copied from interface: Vector
      Builds an Iterator of new Blocks with the same Vector.elementType() as this Vector whose values are copied from positions in this Vector. It has the same number of positions as the positions parameter.

      For example, if this vector contained [a, b, c] and were called with the block [0, 1, 1, [1, 2]] then the result would be [a, b, b, [b, c]].

      This process produces count(positions) values per positions which could be quite large. Instead of returning a single Block, this returns an Iterator of Blocks containing all of the promised values.

      The returned ReleasableIterator may retain a reference to the positions parameter. Close it to release those references.

      This block is built using the same BlockFactory as was used to build the positions parameter.

      Specified by:
      lookup in interface Vector

    • slice

      BytesRefVector slice(int beginInclusive, int endExclusive)
      Return a subset of this vector from beginInclusive to endExclusive. This may return the same instance if the range covers all positions, but if it does it will RefCounted.incRef() it.
      Specified by:
      slice in interface Vector

    • valueMaxByteSize

      int valueMaxByteSize()
      The maximum size in bytes of any single value stored in this vector, or 0 if there are no values. Scans all positions to find the maximum.
      Specified by:
      valueMaxByteSize in interface Vector
      Returns:
      the maximum byte size of any single value in this vector

    • equals

      boolean equals(Object obj)
      Compares the given object with this vector for equality. Returns true if and only if the given object is a BytesRefVector, and both vectors are equal.
      Overrides:
      equals in class Object

    • hashCode

      int hashCode()
      Returns the hash code of this vector, as defined by hash(BytesRefVector).
      Overrides:
      hashCode in class Object

    • equals

      static boolean equals(BytesRefVector vector1, BytesRefVector vector2)
      Returns true if the given vectors are equal to each other, otherwise false. Two vectors are considered equal if they have the same position count, and contain the same values in the same order. This definition ensures that the equals method works properly across different implementations of the BytesRefVector interface.

    • hash

      static int hash(BytesRefVector vector)
      Generates the hash code for the given vector. The hash code is computed from the vector's values. This ensures that vector1.equals(vector2) implies that vector1.hashCode()==vector2.hashCode() for any two vectors, vector1 and vector2, as required by the general contract of Object.hashCode().

    • readFrom

      static BytesRefVector readFrom(BlockFactory blockFactory, StreamInput in) throws IOException
      Deserializes a Vector from the given stream input.
      Throws:
      IOException

    • writeTo

      default void writeTo(StreamOutput out) throws IOException
      Serializes this Vector to the given stream output.
      Throws:
      IOException