Package org.apache.juneau.marshall.csv

Class CsvParserSession

java.lang.Object

org.apache.juneau.marshall.ContextSession

org.apache.juneau.marshall.MarshallingSession

org.apache.juneau.marshall.parser.ParserSession

org.apache.juneau.marshall.parser.ReaderParserSession

org.apache.juneau.marshall.csv.CsvParserSession

All Implemented Interfaces:

BeanSession, ConverterSession, RecordReadable

public class CsvParserSession
extends ReaderParserSession
implements RecordReadable

Session object that lives for the duration of a single use of CsvParser.

Parses CSV (Comma Separated Values) input into Java objects. The first row of the CSV is treated as a header row providing column names. Subsequent rows are treated as data rows.

The following target type mappings are supported:

• Collection<Bean> / Bean[] — Header row provides property names; each data row becomes a bean.
• Collection<Map> / Map[] — Header row provides map keys; each data row becomes a map.
• Collection<SimpleType> / SimpleType[] — Single value column; each row's value is coerced to the element type.
• Single Bean — Header row + one data row → one bean.
• Single Map — Header row + one data row → one map.
• Object — Returns a JsonList of JsonMap entries.

Notes:

• This class is not thread safe and is typically discarded after one use.

Nested Class Summary

Nested Classes

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

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

ReaderParserSession.DefaultBuilder

Field Summary

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

DEFAULT_MAX_PARSE_DEPTH

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

NAME_PROPERTY_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CsvParserSession(CsvParserSession.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
static CsvParserSession.Builder	create(CsvParser ctx)	Creates a new builder for this object.
protected <T> T	doRead(ParserPipe pipe, ClassMeta<T> type)	Workhorse method.
boolean	isRecordStreaming()	Streaming-quality signal queryable before opening a cursor.
RecordReader	readRecords(Object input)	Opens a low-level RecordReader cursor over the specified input.

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

create, createPipe, getStreamCharset, isReaderParser, properties

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

allocateLocal, cast, checkRequired, convertAttrToType, create, doReadIntoCollection, doReadIntoMap, doReadToBeanConsumer, enterParseDepth, exitParseDepth, getCalendarFormat, getClassMeta, getDateFormat, getDebugOutputLines, getDurationFormat, getInputAsString, getJavaMethod, getLastLocation, getListener, getListener, getListenerClass, getLocaleFormat, getNulls, getOuter, getPeriodFormat, getPosition, getSchema, getStringBuilder, getTemporalFormat, getTimeZoneFormat, isAutoCloseStreams, isTrimStrings, isUnbuffered, mark, onBeanSetterException, onUnknownProperty, parentBean, read, read, read, read, read, read, readArgs, readCalendar, readDate, readDuration, readIntoCollection, readIntoMap, readPeriod, readTemporal, readToBeanConsumer, returnStringBuilder, setCurrentClass, setCurrentProperty, setName, setParent, setPipe, swapParentBean, trim, trim, unmark, unswap

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

addWarning, convertToMemberType, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, convertToType, create, get, getActiveView, getAnnotationProvider, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionary, getBeanFieldVisibility, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getClassLoader, getClassMeta, getClassMeta, getClassMetaForObject, getClassMetaForObject, getLocale, getMarshallingContext, getMediaType, getNotBeanClasses, getNotBeanPackagesNames, getPropertyNamer, getSwaps, getTimeZone, getTimeZoneId, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isFindFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnoreMissingSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isPropertyInActiveView, isRecordComponentOrder, isUnsortedProperties, isUseInterfaceProxies, isUseJavaBeanIntrospector, isValidateSchema, newBean, newBean, newBeanMap, newBeanMap, newGenericList, newGenericMap, newGenericMap, object, parseToList, parseToMap, string, toArray, toBeanMap, toBeanMap, toBeanMap

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

checkForWarnings, getContext, getSessionProperties, getWarnings, 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.commons.conversion.ConverterSession

get

Constructor Details

CsvParserSession

protected CsvParserSession(CsvParserSession.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static CsvParserSession.Builder create(CsvParser ctx)

Creates a new builder for this object.

Parameters:

ctx - The context creating this session.

Returns:

A new builder.

readRecords

public RecordReader readRecords(Object input)
                         throws IOException

Description copied from interface: RecordReadable

Opens a low-level RecordReader cursor over the specified input.

When invoked on a convenience Parser the cursor is opened with default session args (mirroring read(...)). Callers that need request-derived configuration (locale, timezone, schema, swaps) should instead call createSession(args).build() and invoke this method on the resulting ParserSession (which is also a RecordReadable).

Specified by:

readRecords in interface RecordReadable

Parameters:

input - The input. Subtypes define the supported types (typically Reader / CharSequence / InputStream / byte[] / File).

Returns:

A new RecordReader cursor.

Throws:

IOException - If a problem occurred reading the underlying input.

isRecordStreaming

public boolean isRecordStreaming()

Description copied from interface: RecordReadable

Streaming-quality signal queryable before opening a cursor.

Specified by:

isRecordStreaming in interface RecordReadable

Returns:

true if RecordReadable.readRecords(Object) returns an O(1)-memory streaming cursor; false for buffered (whole-value) formats backed by RecordAdapter.

doRead

protected <T> T doRead(ParserPipe pipe,
 ClassMeta<T> type)
                throws IOException,
ParseException

Description copied from class: ParserSession

Workhorse method.

Subclasses are expected to implement this method or Parser.doRead(ParserSession,ParserPipe,ClassMeta).

The default implementation of this method simply calls Parser.doRead(ParserSession,ParserPipe,ClassMeta).

Overrides:

doRead in class ParserSession

Type Parameters:

T - The class type of the object to create.

Parameters:

pipe - Where to get the input from.

type - The class type of the object to create. If null or Object.class, object type is based on what's being parsed. For example, when parsing JSON text, it may return a String, Number, JsonMap, etc...

Returns:

The parsed object.

Throws:

IOException - Thrown by underlying stream.

ParseException - Malformed input encountered.