org.beanio.internal.parser

Class CollectionParser

java.lang.Object

org.beanio.internal.util.TreeNode<Component>

org.beanio.internal.parser.Component

org.beanio.internal.parser.ParserComponent

org.beanio.internal.parser.DelegatingParser

org.beanio.internal.parser.Aggregation

org.beanio.internal.parser.CollectionParser

All Implemented Interfaces:

Cloneable, Iterable<Component>, Iteration, Parser, Property, Replicateable

Direct Known Subclasses:

ArrayParser

public class CollectionParser
extends Aggregation

A CollectionParser provides iteration support for a Segment or Field, and is optionally bound to a Collection type property value.

A CollectionParser must contain exactly one child ParserComponent.

Since:

2.0

Property Summary

Type	Property and Description
boolean	is Gets the value of the property property.

Field Summary

Fields inherited from class org.beanio.internal.parser.Aggregation

lazy, occurs

Fields inherited from interface org.beanio.internal.parser.Property

AGGREGATION_ARRAY, AGGREGATION_COLLECTION, AGGREGATION_MAP, COLLECTION, COMPLEX, MAP, SIMPLE

Constructor Summary

Constructors

Constructor and Description
CollectionParser() Constructs a new CollectionParser.

Method Summary

Modifier and Type	Method and Description
void	clearValue(ParsingContext context) Clears the current property value.
protected Collection<Object>	createCollection()
Object	createValue(ParsingContext context) Creates the property value and returns it.
boolean	defines(Object value)
protected Collection<Object>	getCollection(ParsingContext context) Returns the collection value being parsed.
int	getIterationSize() Returns the size of the components that make up a single iteration.
Class<? extends Collection<Object>>	getType()
Object	getValue(ParsingContext context) Returns the unmarshalled property value.
boolean	hasContent(ParsingContext context) Returns whether this parser or any of its descendant have content for marshalling.
protected boolean	isInvalid(ParsingContext context) Returns whether this iteration contained invalid values when last unmarshalled.
boolean	isProperty() Gets the value of the property property.
protected int	length(Object value) Returns the length of aggregation.
protected boolean	marshal(MarshallingContext context, Parser delegate, int minOccurs, int maxOccurs)
boolean	matches(UnmarshallingContext context) Returns whether this parser and its children match a record being unmarshalled.
void	registerLocals(Set<ParserLocal<? extends Object>> locals) Called by a stream to register variables stored in the parsing context.
void	setType(Class<?> collectionType)
void	setValue(ParsingContext context, Object value) Sets the property value for marshaling.
protected void	toParamString(StringBuilder s) Called by TreeNode.toString() to append node parameters to the output.
int	type() Returns the property type.
protected boolean	unmarshal(UnmarshallingContext context, Parser delegate, int minOccurs, int maxOccurs)

Methods inherited from class org.beanio.internal.parser.Aggregation

getAccessor, getIterationIndex, getMaxOccurs, getMinOccurs, getOccurs, isDynamicIteration, isIdentifier, isLazy, isOptional, marshal, setAccessor, setIdentifier, setIterationIndex, setLazy, setMaxOccurs, setMinOccurs, setOccurs, unmarshal

Methods inherited from class org.beanio.internal.parser.DelegatingParser

getParser, getSize

Methods inherited from class org.beanio.internal.parser.ParserComponent

isSupportedChild

Methods inherited from class org.beanio.internal.util.TreeNode

add, clone, find, getChildren, getFirst, getName, isDescendant, iterator, print, print, setName, size, sort, toString, updateReferences

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.beanio.internal.parser.Property

getName

Methods inherited from interface org.beanio.internal.parser.Parser

getName

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Property Detail

is

public boolean isProperty

Gets the value of the property property.

Specified by:

isProperty in class Aggregation

Constructor Detail

CollectionParser

public CollectionParser()

Constructs a new CollectionParser.

Method Detail

clearValue

public void clearValue(ParsingContext context)

Description copied from interface: Parser

Clears the current property value.

Specified by:

clearValue in interface Parser

Specified by:

clearValue in interface Property

Overrides:

clearValue in class DelegatingParser

Parameters:

context - the ParsingContext

defines

public boolean defines(Object value)

matches

public boolean matches(UnmarshallingContext context)

Description copied from interface: Parser

Returns whether this parser and its children match a record being unmarshalled.

Specified by:

matches in interface Parser

Overrides:

matches in class DelegatingParser

Parameters:

context - the UnmarshallingContext

Returns:

true if matched, false otherwise

marshal

protected boolean marshal(MarshallingContext context,
                          Parser delegate,
                          int minOccurs,
                          int maxOccurs)
                   throws IOException

Specified by:

marshal in class Aggregation

Throws:

IOException

unmarshal

protected boolean unmarshal(UnmarshallingContext context,
                            Parser delegate,
                            int minOccurs,
                            int maxOccurs)

Specified by:

unmarshal in class Aggregation

isProperty

public boolean isProperty()

Gets the value of the property property.

Specified by:

isProperty in class Aggregation

isInvalid

protected boolean isInvalid(ParsingContext context)

Returns whether this iteration contained invalid values when last unmarshalled.

Returns:

true if this iteration contained invalid values

getCollection

protected Collection<Object> getCollection(ParsingContext context)

Returns the collection value being parsed.

Returns:

the Collection

length

protected int length(Object value)

Description copied from class: Aggregation

Returns the length of aggregation.

Specified by:

length in class Aggregation

Parameters:

value - the aggregation value

Returns:

the length

setType

public void setType(Class<?> collectionType)

getType

public Class<? extends Collection<Object>> getType()

createValue

public Object createValue(ParsingContext context)

Description copied from interface: Property

Creates the property value and returns it.

Parameters:

context - the ParsingContext

Returns:

the property value

getValue

public Object getValue(ParsingContext context)

Description copied from interface: Parser

Returns the unmarshalled property value.

Specified by:

getValue in interface Parser

Specified by:

getValue in interface Property

Overrides:

getValue in class DelegatingParser

Parameters:

context - the ParsingContext

Returns:

the property value

setValue

public void setValue(ParsingContext context,
                     Object value)

Description copied from interface: Parser

Sets the property value for marshaling.

Specified by:

setValue in interface Parser

Specified by:

setValue in interface Property

Overrides:

setValue in class Aggregation

Parameters:

context - the ParsingContext

value - the property value

createCollection

protected Collection<Object> createCollection()

type

public int type()

Description copied from interface: Property

Returns the property type.

Returns:

Property.SIMPLE, Property.COMPLEX, Property.AGGREGATION_ARRAY, Property.COLLECTION, Property.AGGREGATION_COLLECTION, or Property.MAP

getIterationSize

public int getIterationSize()

Description copied from interface: Iteration

Returns the size of the components that make up a single iteration.

Returns:

the iteration size

registerLocals

public void registerLocals(Set<ParserLocal<? extends Object>> locals)

Description copied from class: Component

Called by a stream to register variables stored in the parsing context. This method should be overridden by subclasses that need to register one or more parser context variables.

Overrides:

registerLocals in class Aggregation

Parameters:

locals - set of local variables

hasContent

public boolean hasContent(ParsingContext context)

Description copied from interface: Parser

Returns whether this parser or any of its descendant have content for marshalling.

Specified by:

hasContent in interface Parser

Overrides:

hasContent in class DelegatingParser

Parameters:

context - the ParsingContext

Returns:

true if there is content for marshalling, false otherwise

toParamString

protected void toParamString(StringBuilder s)

Description copied from class: TreeNode

Called by TreeNode.toString() to append node parameters to the output.

Overrides:

toParamString in class Aggregation

Parameters:

s - the output to append