Module org.apache.arrow.format
Package org.apache.arrow.flatbuf

Class Field

java.lang.Object
com.google.flatbuffers.Table
org.apache.arrow.flatbuf.Field
public final class Field extends com.google.flatbuffers.Table
---------------------------------------------------------------------- A field represents a named column in a record / row batch or child of a nested type.

  • Constructor Details

    • Field

      public Field()

  • Method Details

    • ValidateVersion

      public static void ValidateVersion()

    • getRootAsField

      public static Field getRootAsField(ByteBuffer _bb)

    • getRootAsField

      public static Field getRootAsField(ByteBuffer _bb, Field obj)

    • __init

      public void __init(int _i, ByteBuffer _bb)

    • __assign

      public Field __assign(int _i, ByteBuffer _bb)

    • name

      public String name()
      Name is not required, in i.e. a List

    • nameAsByteBuffer

      public ByteBuffer nameAsByteBuffer()

    • nameInByteBuffer

      public ByteBuffer nameInByteBuffer(ByteBuffer _bb)

    • nullable

      public boolean nullable()
      Whether or not this field can contain nulls. Should be true in general.

    • typeType

      public byte typeType()

    • type

      public com.google.flatbuffers.Table type(com.google.flatbuffers.Table obj)
      This is the type of the decoded value if the field is dictionary encoded.

    • dictionary

      public DictionaryEncoding dictionary()
      Present only if the field is dictionary encoded.

    • dictionary

      public DictionaryEncoding dictionary(DictionaryEncoding obj)

    • children

      public Field children(int j)
      children apply only to nested data types like Struct, List and Union. For primitive types children will have length 0.

    • children

      public Field children(Field obj, int j)

    • childrenLength

      public int childrenLength()

    • childrenVector

      public Field.Vector childrenVector()

    • childrenVector

      public Field.Vector childrenVector(Field.Vector obj)

    • customMetadata

      public KeyValue customMetadata(int j)
      User-defined metadata

    • customMetadata

      public KeyValue customMetadata(KeyValue obj, int j)

    • customMetadataLength

      public int customMetadataLength()

    • customMetadataVector

      public KeyValue.Vector customMetadataVector()

    • customMetadataVector

      public KeyValue.Vector customMetadataVector(KeyValue.Vector obj)

    • createField

      public static int createField(com.google.flatbuffers.FlatBufferBuilder builder, int nameOffset, boolean nullable, byte typeType, int typeOffset, int dictionaryOffset, int childrenOffset, int customMetadataOffset)

    • startField

      public static void startField(com.google.flatbuffers.FlatBufferBuilder builder)

    • addName

      public static void addName(com.google.flatbuffers.FlatBufferBuilder builder, int nameOffset)

    • addNullable

      public static void addNullable(com.google.flatbuffers.FlatBufferBuilder builder, boolean nullable)

    • addTypeType

      public static void addTypeType(com.google.flatbuffers.FlatBufferBuilder builder, byte typeType)

    • addType

      public static void addType(com.google.flatbuffers.FlatBufferBuilder builder, int typeOffset)

    • addDictionary

      public static void addDictionary(com.google.flatbuffers.FlatBufferBuilder builder, int dictionaryOffset)

    • addChildren

      public static void addChildren(com.google.flatbuffers.FlatBufferBuilder builder, int childrenOffset)

    • createChildrenVector

      public static int createChildrenVector(com.google.flatbuffers.FlatBufferBuilder builder, int[] data)

    • startChildrenVector

      public static void startChildrenVector(com.google.flatbuffers.FlatBufferBuilder builder, int numElems)

    • addCustomMetadata

      public static void addCustomMetadata(com.google.flatbuffers.FlatBufferBuilder builder, int customMetadataOffset)

    • createCustomMetadataVector

      public static int createCustomMetadataVector(com.google.flatbuffers.FlatBufferBuilder builder, int[] data)

    • startCustomMetadataVector

      public static void startCustomMetadataVector(com.google.flatbuffers.FlatBufferBuilder builder, int numElems)

    • endField

      public static int endField(com.google.flatbuffers.FlatBufferBuilder builder)