Package org.apache.arrow.flatbuf
Class Map
java.lang.Object
com.google.flatbuffers.Table
org.apache.arrow.flatbuf.Map
public final class Map
extends com.google.flatbuffers.Table
A Map is a logical nested type that is represented as
List<entries: Struct<key: K, value: V>>
In this layout, the keys and values are each respectively contiguous. We do
not constrain the key and value types, so the application is responsible
for ensuring that the keys are hashable and unique. Whether the keys are sorted
may be set in the metadata for this field.
In a field with Map type, the field has a child Struct field, which then
has two children: key type and the second the value type. The names of the
child fields may be respectively "entries", "key", and "value", but this is
not enforced.
Map
```text
- child[0] entries: Struct
- child[0] key: K
- child[1] value: V
```
Neither the "entries" field nor the "key" field may be nullable.
The metadata is structured so that Arrow systems without special handling
for Map can make Map an alias for List. The "layout" attribute for the Map
field must have the same contents as a List.
-
Nested Class Summary
-
Field Summary
Fields inherited from class com.google.flatbuffers.Table
bb, bb_pos
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescription__assign
(int _i, ByteBuffer _bb) void
__init
(int _i, ByteBuffer _bb) static void
addKeysSorted
(com.google.flatbuffers.FlatBufferBuilder builder, boolean keysSorted) static int
createMap
(com.google.flatbuffers.FlatBufferBuilder builder, boolean keysSorted) static int
endMap
(com.google.flatbuffers.FlatBufferBuilder builder) static Map
getRootAsMap
(ByteBuffer _bb) static Map
getRootAsMap
(ByteBuffer _bb, Map obj) boolean
Set to true if the keys within each value are sortedstatic void
startMap
(com.google.flatbuffers.FlatBufferBuilder builder) static void
Methods inherited from class com.google.flatbuffers.Table
__has_identifier, __indirect, __indirect, __offset, __offset, __reset, __reset, __string, __string, __union, __union, __vector, __vector_as_bytebuffer, __vector_in_bytebuffer, __vector_len, compareStrings, compareStrings, getByteBuffer, keysCompare, sortTables
-
Constructor Details
-
Map
public Map()
-
-
Method Details
-
ValidateVersion
public static void ValidateVersion() -
getRootAsMap
-
getRootAsMap
-
__init
-
__assign
-
keysSorted
public boolean keysSorted()Set to true if the keys within each value are sorted -
createMap
public static int createMap(com.google.flatbuffers.FlatBufferBuilder builder, boolean keysSorted) -
startMap
public static void startMap(com.google.flatbuffers.FlatBufferBuilder builder) -
addKeysSorted
public static void addKeysSorted(com.google.flatbuffers.FlatBufferBuilder builder, boolean keysSorted) -
endMap
public static int endMap(com.google.flatbuffers.FlatBufferBuilder builder)
-