org.beanio.internal.parser
Class DelegatingParser

java.lang.Object
  org.beanio.internal.util.TreeNode<Component>
      org.beanio.internal.parser.Component
          org.beanio.internal.parser.ParserComponent
              org.beanio.internal.parser.DelegatingParser

All Implemented Interfaces:

Cloneable, Iterable<Component>, Parser, Replicateable

Direct Known Subclasses:

Aggregation, JsonWrapper, RecordAggregation, XmlWrapper

public abstract class DelegatingParser
extends ParserComponent

Since:

2.0

Author:

Kevin Seim

Constructor Summary

DelegatingParser()
Constructs a new DelegatingParser.

Method Summary

void	clearValue(ParsingContext context) Clears the current property value.
protected Parser	getParser()
int	getSize() Returns the size of a single occurrence of this element, which is used to offset field positions for repeating segments and fields.
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.
boolean	isIdentifier() Returns whether this parser or any descendant of this parser is used to identify a record during unmarshalling.
boolean	isLazy() Returns whether this node must exist during unmarshalling.
boolean	marshal(MarshallingContext context) Marshals a record.
boolean	matches(UnmarshallingContext context) Returns whether this parser and its children match a record being unmarshalled.
void	setValue(ParsingContext context, Object value) Sets the property value for marshaling.
boolean	unmarshal(UnmarshallingContext context) Unmarshals a record.

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

isSupportedChild

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

registerLocals

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

add, clone, find, getChildren, getFirst, getName, iterator, print, setName, size, sort, toParamString, 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.Parser

getName

Constructor Detail

DelegatingParser

public DelegatingParser()

Constructs a new DelegatingParser.

Method Detail

matches

public boolean matches(UnmarshallingContext context)

Description copied from interface: Parser

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

Parameters:

context - the UnmarshallingContext

Returns:

true if matched, false otherwise

unmarshal

public boolean unmarshal(UnmarshallingContext context)

Description copied from interface: Parser

Unmarshals a record.

Parameters:

context - the UnmarshallingContext

Returns:

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

marshal

public boolean marshal(MarshallingContext context)
                throws IOException

Description copied from interface: Parser

Marshals a record.

Parameters:

context - the MarshallingContext

Returns:

whether a value was marshalled

Throws:

IOException - if an I/O error occurs

clearValue

public void clearValue(ParsingContext context)

Description copied from interface: Parser

Clears the current property value.

Parameters:

context - the ParsingContext

setValue

public void setValue(ParsingContext context,
                     Object value)

Description copied from interface: Parser

Sets the property value for marshaling.

Parameters:

context - the ParsingContext

value - the property value

getValue

public Object getValue(ParsingContext context)

Description copied from interface: Parser

Returns the unmarshalled property value.

Parameters:

context - the ParsingContext

Returns:

the property value

getSize

public int getSize()

Description copied from interface: Parser

Returns the size of a single occurrence of this element, which is used to offset field positions for repeating segments and fields.

The concept of size is dependent on the stream format. The size of an element in a fixed length stream format is determined by the length of the element in characters, while other stream formats calculate size based on the number of fields. Some stream formats, such as XML, may ignore size settings.

Returns:

the size of this parser element

isLazy

public boolean isLazy()

Description copied from interface: Parser

Returns whether this node must exist during unmarshalling.

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.

Returns:

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

hasContent

public boolean hasContent(ParsingContext context)

Description copied from interface: Parser

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

Parameters:

context - the ParsingContext

Returns:

true if there is content for marshalling, false otherwise

getParser

protected Parser getParser()