org.beanio.config
Class GroupConfig

java.lang.Object
  org.beanio.config.NodeConfig
      org.beanio.config.GroupConfig

public class GroupConfig
extends NodeConfig

Stores configuration settings for a record group. Records and groups are used to define the layout of stream.

Since:

1.0

Author:

Kevin Seim

Field Summary

Fields inherited from class org.beanio.config.NodeConfig

GROUP, RECORD

Constructor Summary

GroupConfig()

Method Summary

void	addChild(NodeConfig child) Adds a child record or subgroup to this group.
List<NodeConfig>	getChildren() Returns the child nodes of this group.
char	getType() Returns NodeConfig.GROUP.
String	getXmlName() Returns XML element local name of this group.
String	getXmlNamespace() Returns the XML namespace for this group element.
String	getXmlPrefix() Returns the XML prefix for the namespace assigned to this group element.
String	getXmlType() Returns the XML node type of this group.
void	setChildren(List<NodeConfig> children) Sets the list of child nodes.
void	setXmlName(String xmlName) Sets the XML element local name of this group.
void	setXmlNamespace(String xmlNamespace) Sets the XML namespace for this group element.
void	setXmlPrefix(String xmlPrefix) Sets the XML prefix for the namespace assigned to this group element.
void	setXmlType(String xmlType) Sets the XML node type of this group.

Methods inherited from class org.beanio.config.NodeConfig

getMaxOccurs, getMinOccurs, getName, getOrder, setMaxOccurs, setMinOccurs, setName, setOrder

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupConfig

public GroupConfig()

Method Detail

getType

public char getType()

Returns NodeConfig.GROUP.

Specified by:

getType in class NodeConfig

Returns:

NodeConfig.RECORD or NodeConfig.GROUP

addChild

public void addChild(NodeConfig child)

Adds a child record or subgroup to this group.

Parameters:

child - the child node to add

getChildren

public List<NodeConfig> getChildren()

Returns the child nodes of this group.

Returns:

the list of child nodes

setChildren

public void setChildren(List<NodeConfig> children)

Sets the list of child nodes.

Parameters:

children - the list of child nodes

getXmlType

public String getXmlType()

Returns the XML node type of this group.

Returns:

the XML node type

Since:

1.1

See Also:

XmlTypeConstants

setXmlType

public void setXmlType(String xmlType)

Sets the XML node type of this group.

Parameters:

xmlType - the XML node type

Since:

1.1

See Also:

XmlTypeConstants

getXmlName

public String getXmlName()

Returns XML element local name of this group.

Returns:

the XML element local name of this group

Since:

1.1

setXmlName

public void setXmlName(String xmlName)

Sets the XML element local name of this group. If set to null (the default), the XML name defaults to the group name.

Parameters:

xmlName - the XML element local name of this group

Since:

1.1

getXmlNamespace

public String getXmlNamespace()

Returns the XML namespace for this group element.

Returns:

the XML namespace

Since:

1.1

setXmlNamespace

public void setXmlNamespace(String xmlNamespace)

Sets the XML namespace for this group element. If set to null (default), the namespace is inherited from its parent group, or if this group does not have a parent, namespaces are ignored.

Parameters:

xmlNamespace - the XML namespace

Since:

1.1

getXmlPrefix

public String getXmlPrefix()

Returns the XML prefix for the namespace assigned to this group element.

Returns:

the XML namespace prefix

Since:

1.1

setXmlPrefix

public void setXmlPrefix(String xmlPrefix)

Sets the XML prefix for the namespace assigned to this group element. If set to null and a namespace is set, the namespace will replace the default namespace when marshaling the group. If a namespace is not set, the prefix is ignored.

Parameters:

xmlPrefix - the XML namespace prefix

Since:

1.1