Package org.apache.juneau.marshall.parquet

Class ParquetSerializer

java.lang.Object

org.apache.juneau.marshall.Context

org.apache.juneau.marshall.MarshallingContextable

org.apache.juneau.marshall.MarshallingTraverseContext

org.apache.juneau.marshall.serializer.Serializer

org.apache.juneau.marshall.serializer.OutputStreamSerializer

org.apache.juneau.marshall.parquet.ParquetSerializer

All Implemented Interfaces:

Function<Object,byte[]>, ThrowingFunction<Object,byte[]>, ParquetMetaProvider, ArrayRecordWritable, RecordWritable

public class ParquetSerializer
extends OutputStreamSerializer
implements ParquetMetaProvider, RecordWritable, ArrayRecordWritable

Serializes bean collections to Apache Parquet binary format.

Parquet is a columnar format; each bean is one row and each bean property is one column. The serializer accepts a Collection, array, or single bean at the root.

Media types:

Produces Content-Type: application/vnd.apache.parquet

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ParquetSerializer.Builder	Builder class.

Nested classes/interfaces inherited from class org.apache.juneau.marshall.serializer.OutputStreamSerializer

OutputStreamSerializer.DefaultBuilder

Nested classes/interfaces inherited from class org.apache.juneau.marshall.serializer.Serializer

Serializer.Null

Field Summary

Fields

Modifier and Type	Field	Description
static final ParquetSerializer	DEFAULT	Default serializer.

Fields inherited from class org.apache.juneau.marshall.serializer.Serializer

accept, addBeanTypes, addRootType, keepNullProperties, listener, nonDefault, produces, sortCollections, sortMaps, trimEmptyCollections, trimEmptyMaps, trimStrings

Fields inherited from class org.apache.juneau.marshall.MarshallingContextable

marshallingContext

Fields inherited from class org.apache.juneau.marshall.Context

CONTEXT_APPLY_FILTER

Constructor Summary

Constructors

Constructor	Description
ParquetSerializer(ParquetSerializer.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
ParquetSerializer.Builder	copy()	Creates a builder from this context object.
static ParquetSerializer.Builder	create()	Creates a new builder.
ParquetSerializerSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
ParquetBeanPropertyMeta	getParquetBeanPropertyMeta(BeanPropertyMeta bpm)	Returns the Parquet-specific metadata on the specified bean property.
ParquetClassMeta	getParquetClassMeta(ClassMeta<?> cm)	Returns the Parquet-specific metadata on the specified class.
boolean	isArrayRecordStreaming()	The Parquet array-record writer is buffered/RecordAdapter-backed, not O(1) streaming.
boolean	isRecordStreaming()	The Parquet record writer is buffered/RecordAdapter-backed, not O(1) streaming.
RecordWriter	writeArrayRecords(Object output)	Convenience delegator for the buffered array-element RecordWriter using default session arguments.
RecordWriter	writeRecords(Object output)	Convenience delegator for the whole-value RecordWriter using default session arguments.

Methods inherited from class org.apache.juneau.marshall.serializer.OutputStreamSerializer

applyThrows, getBinaryFormat, getSession, isWriterSerializer, write

Methods inherited from class org.apache.juneau.marshall.serializer.Serializer

createSerializerBuilder, doWrite, forEachAcceptMediaType, getListener, getMediaTypeRanges, getPrimaryMediaType, getResponseContentType, getResponseHeaders, getUriContext, getUriRelativity, getUriResolution, isAddBeanTypes, isAddRootType, isKeepNullProperties, isNonDefault, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, properties, write, writeToString

Methods inherited from class org.apache.juneau.marshall.MarshallingTraverseContext

getDetectRecursions, getIgnoreRecursions, getInitialDepth, getMaxDepth, isDetectRecursions, isIgnoreRecursions, shouldDetectRecursions

Methods inherited from class org.apache.juneau.marshall.MarshallingContextable

getDurationFormat, getMarshallingContext, getPeriodFormat

Methods inherited from class org.apache.juneau.marshall.Context

createBuilder, getAnnotationProvider, init, isDebug, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.juneau.marshall.stream.ArrayRecordWritable

writeArrayRecords

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface org.apache.juneau.commons.function.ThrowingFunction

apply

Field Details

DEFAULT

public static final ParquetSerializer DEFAULT

Default serializer.

Constructor Details

ParquetSerializer

public ParquetSerializer(ParquetSerializer.Builder builder)

Constructor.

Parameters:

builder - The builder.

Method Details

create

public static ParquetSerializer.Builder create()

Creates a new builder.

Returns:

A new builder.

copy

public ParquetSerializer.Builder copy()

Description copied from class: Context

Creates a builder from this context object.

Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.

Overrides:

copy in class Serializer

Returns:

A new Builder object.

createSession

public ParquetSerializerSession.Builder createSession()

Description copied from class: Context

Create a session builder based on the properties defined on this context.

Use this method for creating sessions where you want to override basic settings. Otherwise, use Context.getSession() directly.

Overrides:

createSession in class OutputStreamSerializer

Returns:

A new session builder.

getParquetBeanPropertyMeta

public ParquetBeanPropertyMeta getParquetBeanPropertyMeta(BeanPropertyMeta bpm)

Description copied from interface: ParquetMetaProvider

Returns the Parquet-specific metadata on the specified bean property.

Specified by:

getParquetBeanPropertyMeta in interface ParquetMetaProvider

Parameters:

bpm - The bean property to return the metadata on.

Returns:

The metadata.

getParquetClassMeta

public ParquetClassMeta getParquetClassMeta(ClassMeta<?> cm)

Description copied from interface: ParquetMetaProvider

Returns the Parquet-specific metadata on the specified class.

Specified by:

getParquetClassMeta in interface ParquetMetaProvider

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.

writeRecords

public RecordWriter writeRecords(Object output)
                          throws IOException

Convenience delegator for the whole-value RecordWriter using default session arguments. The real implementation lives on ParquetSerializerSession.writeRecords(Object).

Specified by:

writeRecords in interface RecordWritable

Parameters:

output - The output.

Returns:

A new RecordWriter.

Throws:

IOException - If a problem occurred opening the underlying output.

writeArrayRecords

public RecordWriter writeArrayRecords(Object output)
                               throws IOException

Convenience delegator for the buffered array-element RecordWriter using default session arguments. The real implementation lives on ParquetSerializerSession.writeArrayRecords(Object).

Specified by:

writeArrayRecords in interface ArrayRecordWritable

Parameters:

output - The output.

Returns:

A new RecordWriter.

Throws:

IOException - If a problem occurred opening the underlying output.

isRecordStreaming

public boolean isRecordStreaming()

The Parquet record writer is buffered/RecordAdapter-backed, not O(1) streaming.

Specified by:

isRecordStreaming in interface RecordWritable

Returns:

Always false.

isArrayRecordStreaming

public boolean isArrayRecordStreaming()

The Parquet array-record writer is buffered/RecordAdapter-backed, not O(1) streaming.

Specified by:

isArrayRecordStreaming in interface ArrayRecordWritable

Returns:

Always false.