Package org.apache.juneau.marshall.parquet

Class ParquetParser

java.lang.Object

org.apache.juneau.marshall.Context

org.apache.juneau.marshall.MarshallingContextable

org.apache.juneau.marshall.parser.Parser

org.apache.juneau.marshall.parser.InputStreamParser

org.apache.juneau.marshall.parquet.ParquetParser

All Implemented Interfaces:

ParquetMetaProvider, ArrayRecordReadable, RecordReadable

public class ParquetParser
extends InputStreamParser
implements ParquetMetaProvider, RecordReadable, ArrayRecordReadable

Parses Apache Parquet binary data into bean collections.

Always returns a List<T>; each row in the file becomes one list element.

Media types:

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.apache.juneau.marshall.parser.InputStreamParser

InputStreamParser.DefaultBuilder

Nested classes/interfaces inherited from class org.apache.juneau.marshall.parser.Parser

Parser.Null

Field Summary

Fields

Modifier and Type	Field	Description
static final ParquetParser	DEFAULT	Default parser.

Fields inherited from class org.apache.juneau.marshall.parser.Parser

autoCloseStreams, consumes, debugOutputLines, listener, nulls, trimStrings, unbuffered

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
ParquetParser(ParquetParser.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
ParquetParser.Builder	copy()	Creates a builder from this context object.
static ParquetParser.Builder	create()	Creates a new parser builder.
ParquetParserSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
int	getMaxCount()	Returns the maximum allowed wire-declared element count (row/value counts).
int	getMaxDecompressedBytes()	Returns the maximum allowed aggregate decompressed-byte total across every page read during a single parse.
int	getMaxInputLength()	Returns the maximum allowed size (in bytes) of the whole Parquet input buffered before parsing.
int	getMaxLength()	Returns the maximum allowed wire-declared length (in bytes) for a single Parquet page.
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 cursor is buffered/RecordAdapter-backed, not O(1) streaming.
boolean	isRecordStreaming()	The Parquet record cursor is buffered/RecordAdapter-backed, not O(1) streaming.
RecordReader	readArrayRecords(Object input)	Convenience delegator for the buffered array-element RecordReader using default session arguments.
RecordReader	readRecords(Object input)	Convenience delegator for the whole-value RecordReader using default session arguments.

Methods inherited from class org.apache.juneau.marshall.parser.InputStreamParser

getBinaryFormat, getSession, isReaderParser

Methods inherited from class org.apache.juneau.marshall.parser.Parser

canHandle, createParserBuilder, doRead, getDebugOutputLines, getListener, getMediaTypes, getNulls, getPrimaryMediaType, isAutoCloseStreams, isTrimStrings, isUnbuffered, properties, read, read, read, read, read, read, readArgs, readIntoCollection, readIntoMap, readWithOuter

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.ArrayRecordReadable

readArrayRecords

Field Details

DEFAULT

public static final ParquetParser DEFAULT

Default parser.

Constructor Details

ParquetParser

public ParquetParser(ParquetParser.Builder builder)

Constructor.

Parameters:

builder - The builder for this parser.

Method Details

create

public static ParquetParser.Builder create()

Creates a new parser builder.

Returns:

A new builder.

getMaxLength

public int getMaxLength()

Returns the maximum allowed wire-declared length (in bytes) for a single Parquet page.

Returns:

The maximum length in bytes.

getMaxCount

public int getMaxCount()

Returns the maximum allowed wire-declared element count (row/value counts).

Returns:

The maximum count.

getMaxInputLength

public int getMaxInputLength()

Returns the maximum allowed size (in bytes) of the whole Parquet input buffered before parsing.

Returns:

The maximum input size in bytes.

getMaxDecompressedBytes

public int getMaxDecompressedBytes()

Returns the maximum allowed aggregate decompressed-byte total across every page read during a single parse.

Returns:

The maximum aggregate decompressed-byte total.

copy

public ParquetParser.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 Parser

Returns:

A new Builder object.

createSession

public ParquetParserSession.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 InputStreamParser

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.

readRecords

public RecordReader readRecords(Object input)
                         throws IOException

Convenience delegator for the whole-value RecordReader using default session arguments. The real implementation lives on ParquetParserSession.readRecords(Object).

Specified by:

readRecords in interface RecordReadable

Parameters:

input - The input.

Returns:

A new RecordReader cursor.

Throws:

IOException - If a problem occurred opening the underlying input.

readArrayRecords

public RecordReader readArrayRecords(Object input)
                              throws IOException

Convenience delegator for the buffered array-element RecordReader using default session arguments. The real implementation lives on ParquetParserSession.readArrayRecords(Object).

Specified by:

readArrayRecords in interface ArrayRecordReadable

Parameters:

input - The input.

Returns:

A buffered RecordReader.

Throws:

IOException - If a problem occurred reading the input.

isRecordStreaming

public boolean isRecordStreaming()

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

Specified by:

isRecordStreaming in interface RecordReadable

Returns:

Always false.

isArrayRecordStreaming

public boolean isArrayRecordStreaming()

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

Specified by:

isArrayRecordStreaming in interface ArrayRecordReadable

Returns:

Always false.