org.beanio.internal.parser

Class Aggregation

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CollectionParser, MapParser

public abstract class Aggregation
extends DelegatingParser
implements Property, Iteration

Base class for parser components capable of aggregating descendant properties.

Since:

2.0.1

Property Summary

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

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	lazy
protected Field	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
Aggregation() Constructs a new Aggregation.

Method Summary

Modifier and Type	Method and Description
PropertyAccessor	getAccessor()
int	getIterationIndex(ParsingContext context) Returns the index of the current iteration relative to its parent.
int	getMaxOccurs()
int	getMinOccurs()
Field	getOccurs()
boolean	isDynamicIteration() Returns whether the iteration size is variable based on another field in the record.
boolean	isIdentifier() Returns whether this parser or any descendant of this parser is used to identify a record during unmarshalling.
boolean	isLazy()
boolean	isOptional() Returns whether this node must exist during unmarshalling.
abstract boolean	isProperty() Gets the value of the property property.
protected abstract int	length(Object value) Returns the length of aggregation.
boolean	marshal(MarshallingContext context) Marshals a record.
protected abstract boolean	marshal(MarshallingContext context, Parser delegate, int minOccurs, int maxOccurs)
void	registerLocals(Set<ParserLocal<? extends Object>> locals) Called by a stream to register variables stored in the parsing context.
void	setAccessor(PropertyAccessor accessor)
void	setIdentifier(boolean identifier)
protected void	setIterationIndex(ParsingContext context, int index)
void	setLazy(boolean lazy)
void	setMaxOccurs(int maxOccurs)
void	setMinOccurs(int minOccurs)
void	setOccurs(Field occurs)
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.
boolean	unmarshal(UnmarshallingContext context) Unmarshals a record.
protected abstract boolean	unmarshal(UnmarshallingContext context, Parser delegate, int minOccurs, int maxOccurs)

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

clearValue, getParser, getSize, getValue, hasContent, matches

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

clearValue, createValue, defines, getName, getType, getValue, setType, type

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

getIterationSize

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

getName

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Property Detail

is

public abstract boolean isProperty

Gets the value of the property property.

Field Detail

lazy

protected boolean lazy

occurs

protected Field occurs

Constructor Detail

Aggregation

public Aggregation()

Constructs a new Aggregation.

Method Detail

isProperty

public abstract boolean isProperty()

Gets the value of the property property.

length

protected abstract int length(Object value)

Returns the length of aggregation.

Parameters:

value - the aggregation value

Returns:

the length

marshal

public final boolean marshal(MarshallingContext context)
                      throws IOException

Description copied from interface: Parser

Marshals a record.

Specified by:

marshal in interface Parser

Overrides:

marshal in class DelegatingParser

Parameters:

context - the MarshallingContext

Returns:

whether a value was marshalled

Throws:

IOException - if an I/O error occurs

marshal

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

Throws:

IOException

unmarshal

public final boolean unmarshal(UnmarshallingContext context)

Description copied from interface: Parser

Unmarshals a record.

Specified by:

unmarshal in interface Parser

Overrides:

unmarshal in class DelegatingParser

Parameters:

context - the UnmarshallingContext

Returns:

true if this component was present in the unmarshalled record, or false otherwise

unmarshal

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

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 DelegatingParser

Parameters:

context - the ParsingContext

value - the property value

isOptional

public boolean isOptional()

Description copied from interface: Parser

Returns whether this node must exist during unmarshalling.

Specified by:

isOptional in interface Parser

Overrides:

isOptional in class DelegatingParser

Returns:

true if this node is optional during unmarshalling, false otherwise

isIdentifier

public boolean isIdentifier()

Description copied from interface: Parser

Returns whether this parser or any descendant of this parser is used to identify a record during unmarshalling.

Specified by:

isIdentifier in interface Parser

Specified by:

isIdentifier in interface Property

Overrides:

isIdentifier in class DelegatingParser

Returns:

true if this parser or any descendant is used to identify a record

setIdentifier

public void setIdentifier(boolean identifier)

Specified by:

setIdentifier in interface Property

Throws:

UnsupportedOperationException

getAccessor

public PropertyAccessor getAccessor()

Specified by:

getAccessor in interface Property

setAccessor

public void setAccessor(PropertyAccessor accessor)

Specified by:

setAccessor in interface Property

getIterationIndex

public final int getIterationIndex(ParsingContext context)

Description copied from interface: Iteration

Returns the index of the current iteration relative to its parent.

Specified by:

getIterationIndex in interface Iteration

Returns:

the index of the current iteration

setIterationIndex

protected final void setIterationIndex(ParsingContext context,
                                       int index)

getMinOccurs

public int getMinOccurs()

setMinOccurs

public void setMinOccurs(int minOccurs)

getMaxOccurs

public int getMaxOccurs()

setMaxOccurs

public void setMaxOccurs(int maxOccurs)

getOccurs

public Field getOccurs()

setOccurs

public void setOccurs(Field occurs)

isLazy

public boolean isLazy()

setLazy

public void setLazy(boolean lazy)

isDynamicIteration

public boolean isDynamicIteration()

Description copied from interface: Iteration

Returns whether the iteration size is variable based on another field in the record.

Specified by:

isDynamicIteration in interface Iteration

Returns:

true if variable, false otherwise

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 Component

Parameters:

locals - set of local variables

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 TreeNode<Component>

Parameters:

s - the output to append