Class FileSchema.StructBuilder

java.lang.Object

dev.hardwood.schema.FileSchema.StructBuilder

Enclosing class:

FileSchema

public static final class FileSchema.StructBuilder
extends Object

Declares the fields of a struct group. Nested structs compose by calling struct(String, RepetitionType, Consumer) again inside the filler.

Method Summary

Modifier and Type	Method	Description
FileSchema.StructBuilder	addColumn(String columnName, PhysicalType type, RepetitionType repetition)	Append a primitive field.
FileSchema.StructBuilder	addColumn(String columnName, PhysicalType type, RepetitionType repetition, int typeLength)	Append a primitive field, giving the fixed byte length of a FIXED_LEN_BYTE_ARRAY column.
FileSchema.StructBuilder	addColumn(String columnName, PhysicalType type, RepetitionType repetition, int typeLength, LogicalType logicalType)	Append a primitive field carrying a logical type annotation, giving the fixed byte length of a FIXED_LEN_BYTE_ARRAY column.
FileSchema.StructBuilder	addColumn(String columnName, PhysicalType type, RepetitionType repetition, LogicalType logicalType)	Append a primitive field carrying a logical type annotation.
FileSchema.StructBuilder	list(String listName, RepetitionType repetition, Consumer<FileSchema.ElementBuilder> element)	Append a nested LIST field.
FileSchema.StructBuilder	map(String mapName, RepetitionType repetition, PhysicalType keyType, int keyTypeLength, LogicalType keyLogicalType, Consumer<FileSchema.ElementBuilder> value)	Append a nested MAP field whose key carries a logical type annotation, giving the fixed byte length of a FIXED_LEN_BYTE_ARRAY key.
FileSchema.StructBuilder	map(String mapName, RepetitionType repetition, PhysicalType keyType, LogicalType keyLogicalType, Consumer<FileSchema.ElementBuilder> value)	Append a nested MAP field whose key carries a logical type annotation.
FileSchema.StructBuilder	map(String mapName, RepetitionType repetition, PhysicalType keyType, Consumer<FileSchema.ElementBuilder> value)	Append a nested MAP field.
FileSchema.StructBuilder	struct(String structName, RepetitionType repetition, Consumer<FileSchema.StructBuilder> filler)	Append a nested struct field.

Methods inherited from class Object

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

Method Details

addColumn

public FileSchema.StructBuilder addColumn(String columnName,
 PhysicalType type,
 RepetitionType repetition)

Append a primitive field.

Throws:

IllegalArgumentException - if repetition is REPEATED, or the type is FIXED_LEN_BYTE_ARRAY (use the type-length overload)

addColumn

public FileSchema.StructBuilder addColumn(String columnName,
 PhysicalType type,
 RepetitionType repetition,
 int typeLength)

Append a primitive field, giving the fixed byte length of a FIXED_LEN_BYTE_ARRAY column.

Throws:

IllegalArgumentException - if repetition is REPEATED, or typeLength does not match the type (required and positive for FIXED_LEN_BYTE_ARRAY, absent otherwise)

addColumn

public FileSchema.StructBuilder addColumn(String columnName,
 PhysicalType type,
 RepetitionType repetition,
 LogicalType logicalType)

Append a primitive field carrying a logical type annotation.

Throws:

IllegalArgumentException - if repetition is REPEATED, or the annotation does not apply to the physical type

addColumn

public FileSchema.StructBuilder addColumn(String columnName,
 PhysicalType type,
 RepetitionType repetition,
 int typeLength,
 LogicalType logicalType)

Append a primitive field carrying a logical type annotation, giving the fixed byte length of a FIXED_LEN_BYTE_ARRAY column.

Throws:

IllegalArgumentException - if repetition is REPEATED, typeLength does not match the type, or the annotation does not apply to the physical type

struct

public FileSchema.StructBuilder struct(String structName,
 RepetitionType repetition,
 Consumer<FileSchema.StructBuilder> filler)

Append a nested struct field.

Throws:

IllegalArgumentException - if repetition is REPEATED or the group has no fields

list

public FileSchema.StructBuilder list(String listName,
 RepetitionType repetition,
 Consumer<FileSchema.ElementBuilder> element)

Append a nested LIST field.

Throws:

IllegalArgumentException - if repetition is REPEATED or no element is declared

map

public FileSchema.StructBuilder map(String mapName,
 RepetitionType repetition,
 PhysicalType keyType,
 Consumer<FileSchema.ElementBuilder> value)

Append a nested MAP field.

Throws:

IllegalArgumentException - if repetition is REPEATED or no value is declared

map

public FileSchema.StructBuilder map(String mapName,
 RepetitionType repetition,
 PhysicalType keyType,
 LogicalType keyLogicalType,
 Consumer<FileSchema.ElementBuilder> value)

Append a nested MAP field whose key carries a logical type annotation.

Throws:

IllegalArgumentException - if repetition is REPEATED, no value is declared, or the annotation does not apply to the key's physical type

map

public FileSchema.StructBuilder map(String mapName,
 RepetitionType repetition,
 PhysicalType keyType,
 int keyTypeLength,
 LogicalType keyLogicalType,
 Consumer<FileSchema.ElementBuilder> value)

Append a nested MAP field whose key carries a logical type annotation, giving the fixed byte length of a FIXED_LEN_BYTE_ARRAY key.

Throws:

IllegalArgumentException - if repetition is REPEATED, no value is declared, keyTypeLength does not match the key's type, or the annotation does not apply to it