org.beanio.xsd.2011.01.mapping.xsd Maven / Gradle / Ivy
The BeanIO stream mapping configuration XML schema.
Copyright 2010-2011 Kevin Seim
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Root element for BeanIO stream mappings.
Declares a new global type handler, or customizes a default handler.
Declares a new stream mapping.
Declares a custom record reader factory or customizes the default one.
Declares a custom record writer factory or customizes the default one.
Declares a new type handler implementation for this stream,
or customizes a default handler.
A record is used to map a portion of the stream to a bean object.
A group is used to group records together.
The name of the stream configuration to invoke using a StreamFactory.
The stream format. Either 'csv', 'delimited' or 'fixedlength'.
Set to 'false' if child records are not ordered and may be
read from the input stream in any order. Defaults to 'true'.
The minimum number of times the stream may be read from the input
stream. Defaults to 0.
The maximum number of times the stream may be read from the input
stream. Defaults to 1.
The location of a resource bundle for customizing error messages.
The XML node type. Defaults to 'element'. Set to 'none' if a record
definition defines the root element.
The XML root element name. Defaults to the stream name.
The XML namespace for this element. A value of '*' (default) indicates any namespace
is matched when unmarshalling XML and no namespace is declared when marshalling XML.
The XML namespace prefix to use when marshalling XML. By default,
or when set to '', the default namespace is overridden for an element.
Sets a property on its parent bean object.
The name to register the type handler under.
The class name or type alias to register the type handler for.
The type handler implementation class name.
Sets a property on its parent bean object.
The class name of the record reader/writer factory implementation. If
not specified, a default implementation is used based on the stream format.
The property name to set on the parent bean object.
The property value to set on the parent bean object.
The minimum number of occurrences of this group or record. Defaults to 1.
The maximum number of occurrences of this group or record.
Defaults to 'unbounded'.
The sequence of this record or group within its parent group or stream.
Records and groups that share the same order number may appear in
any order.
The XML element name. Defaults to the record or group name.
The XML namespace of this element. A value of '*' indicates any namespace
is matched when unmarshalling XML and no namespace is declared when marshalling XML.
By default, xmlNamespace is inherited from its parent stream or group.
The XML namespace prefix to use when marshalling XML. By default,
or when set to '', the default namespace is overridden for an element.
A field is used to map a portion of its parent record to a property
of the record bean object.
A bean is used to group fields into a child bean object, which is in
turn a property of its parent record bean object.
The name of the record (used to format resource bundle keys
for error messages).
The minimum length of the record. For delimited/CSV formatted streams,
the minimum length is specified in fields. For fixed length formatted
streams, the minimum length is specified in characters.
The maximum length of the record. For delimited/CSV formatted streams,
the maximum length is specified in fields. For fixed length formatted
streams, the maximum length is specified in characters.
The class name or type alias of the bean object mapped to this record.
A record is used to map a portion of the stream to a bean object.
A group is used to group records together.
The name of the group.
The XML node type. May be set to 'element' (default) or 'none'.
The name of the field, and by default, the
name of the bean property the field maps to.
The name of the setter method name to set the field property value on the bean class.
The name of the getter method to get the field property value from the bean class.
Set to 'true' to indicate this field is used to identify the record.
Must be used in conjunction with either 'literal' or 'regex'.
Field position beginning at 0.
Set to 'true' to throw an exception if the field text is missing or empty.
The default value if the field text is missing or empty.
The minimum length of the field text (in characters).
The maximum length of the field text (in characters).
The regular expression the field text must match.
The literal expression the field text must match.
The class name or type alias of the field property value.
The type handler name for converting field text to its property value.
The format of the field property value passed to the type handler.
A DecimalFormat pattern for number types, or a SimpleDateFormat
patter for date types.
Set to 'true' if this field is not a property of its parent bean class.
Set to 'true' to trim whitespace from the field text before validation
and type conversion.
The padded length of the field text (in characters). Use 'minLength'
and 'maxLength' for validation purposes.
The character used to pad the field text. Defaults to a space
for fixed length formatted streams.
The justification of the field text when padded.
The type of collection for repeating fields. May be set to any
collection class name or one of the following: 'array', 'list',
or 'set'.
The minimum number of times this field repeats in its parent record.
Defaults to 1. XML formatted streams may set minOccurs to 0 to indicate
the element or attribute is optional when marshalling null field values.
The maximum number of times this field repeats in its parent record.
Defaults to 'minOccurs' or 1, whichever is greater.
The XML node type. May be set to 'element', 'attribute', 'text' or 'none'.
The XML element or attribute name. By default, the field name is used.
The XML namespace of this element or attribute. A value of '*' indicates any namespace
is matched when unmarshalling XML and no namespace is declared when marshalling XML.
By default, xmlNamespace is inherited from its parent record or bean.
The XML namespace prefix to use when marshalling XML. By default,
or when set to '', the default namespace is overridden for an element.
Set to true if this element is nillable. If 'true', null field values
are marshalled as nil.
The XML element name that wraps this field or collection of fields.
A field is used to map a portion of a record to a property
of its parent bean object.
A bean is used to group fields into a child bean object, which is in
turn a property of its parent bean object.
The bean name, and by default, the name of the property to set
on its parent bean object.
The name of the setter method to set this bean object on its parent bean class.
The name of the getter method to get this bean object from its parent bean class.
The class name of the bean.
The type of collection for repeating beans. May be set to any
collection class name or one of the following: 'array', 'list',
or 'set'.
The minimum number of times this bean repeats in its parent bean or record.
Defaults to 1.
The maximum number of times this bean repeats in its parent bean or record.
Defaults to 'minOccurs' or 1, whichever is greater.
The XML node type. May be set to 'element' (default) or 'none'.
The XML element name. By default, the bean name is used.
The XML namespace of this element. A value of '*' indicates any namespace
is matched when unmarshalling XML and no namespace is declared when marshalling XML.
By default, xmlNamespace is inherited from its parent record or bean.
The XML namespace prefix to use when marshalling XML. By default,
or when set to '', the default namespace is overridden for an element.
Set to true if this element is nillable. If 'true', null bean values
are marshalled as nil.
The XML element name that wraps this bean or collection of beans.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy