Class TypeLayout

java.lang.Object
org.apache.arrow.vector.TypeLayout

public class TypeLayout extends Object
The buffer layout of vectors for a given type. It defines its own buffers followed by the buffers for the children if it is a nested type (Struct_, List, Union)
  • Constructor Details

    • TypeLayout

      public TypeLayout(List<BufferLayout> bufferLayouts, boolean isFixedBufferCount)
      Constructs a new TypeLayout.
      Parameters:
      bufferLayouts - the individual BufferLayouts for the given type
      isFixedBufferCount - whether the number of buffers is fixed
    • TypeLayout

      public TypeLayout(List<BufferLayout> bufferLayouts)
    • TypeLayout

      public TypeLayout(BufferLayout... bufferLayouts)
    • TypeLayout

      public TypeLayout(boolean isFixedBufferCount, BufferLayout... bufferLayouts)
  • Method Details

    • getTypeLayout

      public static TypeLayout getTypeLayout(ArrowType arrowType)
      Constructs a new TypeLayout for the given arrowType.
    • getTypeBufferCount

      public static int getTypeBufferCount(ArrowType arrowType)
      Gets the number of BufferLayouts for the given arrowType.
    • getBufferLayouts

      public List<BufferLayout> getBufferLayouts()
      Returns the individual BufferLayouts for the given type.
    • getBufferTypes

      public List<BufferLayout.BufferType> getBufferTypes()
      Returns the types of each buffer for this layout. A layout can consist of multiple buffers for example a validity bitmap buffer, a value buffer or an offset buffer.
    • isFixedBufferCount

      public boolean isFixedBufferCount()
      Determines whether the buffer count is fixed for the given type.
      Returns:
      true if the buffer count is fixed, false otherwise
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object