org.beanio.internal.config

Class RecordConfig

java.lang.Object

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

org.beanio.internal.config.ComponentConfig

org.beanio.internal.config.PropertyConfig

org.beanio.internal.config.SegmentConfig

org.beanio.internal.config.RecordConfig

All Implemented Interfaces:

Cloneable, Iterable<ComponentConfig>, SelectorConfig, Replicateable

public class RecordConfig
extends SegmentConfig
implements SelectorConfig

A record is a segment that is bound to a record in a stream. The physical representation of a record is dependent on the type of stream. A typical example might be a line in a fixed length or delimited flat file.

Since:

2.0

Field Summary

Fields inherited from class org.beanio.internal.config.PropertyConfig

JSON_TYPE_ARRAY, JSON_TYPE_BOOLEAN, JSON_TYPE_NONE, JSON_TYPE_NUMBER, JSON_TYPE_OBJECT, JSON_TYPE_STRING

Fields inherited from class org.beanio.internal.config.ComponentConfig

CONSTANT, FIELD, GROUP, RECORD, SEGMENT, STREAM, WRAPPER

Constructor Summary

Constructors

Constructor and Description
RecordConfig() Constructs a new RecordConfig.

Method Summary

Modifier and Type	Method and Description
char	getComponentType() Returns the component type.
Integer	getMaxLength() Returns the maximum length of the record.
Integer	getMaxMatchLength() Returns the maximum record length for identifying this record.
Integer	getMinLength() Returns the minimum length of the record.
Integer	getMinMatchLength() Returns the minimum record length for identifying this record.
Integer	getOrder() Returns the order this record must appear within the context of its parent group component.
void	setMaxLength(Integer maxLength) Sets the maximum length of the record.
void	setMaxMatchLength(Integer maxMatchLength) Sets the maximum record length for identifying this record.
void	setMinLength(Integer minLength) Sets the minimum length of the record.
void	setMinMatchLength(Integer minMatchLength) Sets the minimum record length for identifying this record.
void	setOrder(Integer order) Sets the order this record must appear within the context of its parent group component.

Methods inherited from class org.beanio.internal.config.SegmentConfig

getDefaultExistence, getKey, getPropertyList, getTarget, isConstant, isSupportedChild, setConstant, setDefaultExistence, setKey, setTarget

Methods inherited from class org.beanio.internal.config.PropertyConfig

getCollection, getGetter, getJsonArrayIndex, getJsonName, getJsonType, getLabel, getMaxOccurs, getMaxOccursRef, getMaxSize, getMinOccurs, getMinOccursRef, getMinSize, getOccursRef, getPosition, getSetter, getType, getUntil, getXmlType, isBound, isCollection, isIdentifier, isJsonArray, isLazy, isNillable, isRepeating, setBound, setCollection, setGetter, setIdentifier, setJsonArray, setJsonArrayIndex, setJsonName, setJsonType, setLabel, setLazy, setMaxOccurs, setMaxOccursRef, setMaxSize, setMinOccurs, setMinOccursRef, setMinSize, setNillable, setOccursRef, setPosition, setSetter, setType, setUntil, setXmlType

Methods inherited from class org.beanio.internal.config.ComponentConfig

getOrdinal, getXmlName, getXmlNamespace, getXmlPrefix, isXmlNamespaceAware, setOrdinal, setXmlName, setXmlNamespace, setXmlNamespaceAware, setXmlPrefix

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

add, clone, find, getChildren, getFirst, getName, isDescendant, iterator, print, 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.config.SelectorConfig

getMaxOccurs, getMinOccurs, getName

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

RecordConfig

public RecordConfig()

Constructs a new RecordConfig.

Method Detail

getComponentType

public char getComponentType()

Description copied from class: ComponentConfig

Returns the component type.

Specified by:

getComponentType in interface SelectorConfig

Overrides:

getComponentType in class SegmentConfig

Returns:

one of ComponentConfig.GROUP, ComponentConfig.RECORD, ComponentConfig.SEGMENT, ComponentConfig.FIELD, ComponentConfig.CONSTANT or ComponentConfig.WRAPPER

getMinLength

public Integer getMinLength()

Returns the minimum length of the record. Depending on the type of stream, the length may refer to the number of fields or the number of characters.

Returns:

the minimum record length, or null if not set

setMinLength

public void setMinLength(Integer minLength)

Sets the minimum length of the record. Depending on the type of stream, the length may refer to the number of fields or the number of characters.

Parameters:

minLength - the minimum record length, or null if not set

getMaxLength

public Integer getMaxLength()

Returns the maximum length of the record. Depending on the type of stream, the length may refer to the number of fields or the number of characters.

Returns:

the maximum record length, or null if not set

setMaxLength

public void setMaxLength(Integer maxLength)

Sets the maximum length of the record. Depending on the type of stream, the length may refer to the number of fields or the number of characters.

Parameters:

maxLength - the maximum record length, or null if not set

getMinMatchLength

public Integer getMinMatchLength()

Returns the minimum record length for identifying this record.

Returns:

the minimum record length, or null if no minimum length applies

setMinMatchLength

public void setMinMatchLength(Integer minMatchLength)

Sets the minimum record length for identifying this record.

Parameters:

minMatchLength - the minimum record length, or null if no minimum length applies

getMaxMatchLength

public Integer getMaxMatchLength()

Returns the maximum record length for identifying this record.

Returns:

the maximum record length, or null if no maximum length applies

setMaxMatchLength

public void setMaxMatchLength(Integer maxMatchLength)

Sets the maximum record length for identifying this record.

Parameters:

maxMatchLength - the maximum record length, or null if no maximum length applies

getOrder

public Integer getOrder()

Returns the order this record must appear within the context of its parent group component. Records and groups assigned the same order number may appear in any order.

Specified by:

getOrder in interface SelectorConfig

Returns:

the order of this record

setOrder

public void setOrder(Integer order)

Sets the order this record must appear within the context of its parent group component. Records and groups assigned the same order number may appear in any order.

Specified by:

setOrder in interface SelectorConfig

Parameters:

order - the order of this record