org.beanio.internal.config
Class GroupConfig

java.lang.Object
  org.beanio.internal.util.TreeNode<ComponentConfig>
      org.beanio.internal.config.ComponentConfig
          org.beanio.internal.config.PropertyConfig
              org.beanio.internal.config.GroupConfig

All Implemented Interfaces:

Cloneable, Iterable<ComponentConfig>, SelectorConfig, Replicateable

Direct Known Subclasses:

StreamConfig

public class GroupConfig
extends PropertyConfig
implements SelectorConfig

A group is used to organize records and the overall structure of a stream. A group may contain records and/or other groups. In many cases, a group does not map to any physical aspect of a stream.

The minSize, maxSize, and nillable attributes do not apply to groups.

Since:

2.0

Author:

Kevin Seim

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

GroupConfig()
Constructs a new GroupConfig.

Method Summary

char	getComponentType() Returns the component type.
String	getKey() Returns the name of the property descendant to use for the Map key when collection is set to map.
Integer	getOrder() Returns the order this group must appear within the context of its parent group component.
String	getTarget() Returns the name of the target property for this group.
protected boolean	isSupportedChild(ComponentConfig child) Returns whether a node is a supported child of this node.
void	setKey(String key) Sets the name of the property descendant to use for the Map key when collection is set to map.
void	setOrder(Integer order) Sets the order this group must appear within the context of its parent group component.
void	setTarget(String target) Sets the name of the target property for this group, which can be used in lieu of class to return descendant property types.

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

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

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

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

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.config.SelectorConfig

getMaxOccurs, getMinOccurs, getName

Constructor Detail

GroupConfig

public GroupConfig()

Constructs a new GroupConfig.

Method Detail

getComponentType

public char getComponentType()

Description copied from class: ComponentConfig

Returns the component type.

Specified by:

getComponentType in interface SelectorConfig

Specified by:

getComponentType in class ComponentConfig

Returns:

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

getOrder

public Integer getOrder()

Returns the order this group 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 group 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

getKey

public String getKey()

Returns the name of the property descendant to use for the Map key when collection is set to map.

Overrides:

getKey in class PropertyConfig

Returns:

the key property name

setKey

public void setKey(String key)

Sets the name of the property descendant to use for the Map key when collection is set to map.

Parameters:

key - the key property name

getTarget

public String getTarget()

Returns the name of the target property for this group.

Returns:

the target property name

setTarget

public void setTarget(String target)

Sets the name of the target property for this group, which can be used in lieu of class to return descendant property types.

Parameters:

target - the target property name

isSupportedChild

protected boolean isSupportedChild(ComponentConfig child)

Description copied from class: TreeNode

Returns whether a node is a supported child of this node. Called by TreeNode.add(TreeNode).

Overrides:

isSupportedChild in class PropertyConfig

Parameters:

child - the node to test

Returns:

true if the child is allowed