org.ws4d.java.schema

Class ElementContainer

java.lang.Object

org.ws4d.java.schema.ElementContainer

All Implemented Interfaces:

SchemaConstants, Any

Direct Known Subclasses:

AllContainer, ChoiceContainer, SequenceContainer

public abstract class ElementContainer
extends java.lang.Object
implements Any

This class represents the model group part of XML Schema.

http://www.w3.org/ TR/xmlschema11-1/#Model_Groups

It allows to add elements, groups and other containers.

XML Schema

It is possible to create nested container structures like this:

 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.example.org">
    <element name="nested" type="nestedType" />
    <xs:complexType name="nestedType">
       <xs:all>
          <xs:element name="a" type="xs:string" />
          <xs:element name="b" type="xs:string" />
          <xs:sequence>
              <xs:element name="c" type="xs:string" />
              <xs:element name="d" type="xs:string" />
              <xs:choice>
                 <xs:element name="e" type="xs:string" />
                 <xs:element name="f" type="xs:string" />
              </xs:choice>
          </xs:sequence>
       </xs:all>
    </xs:complexType>
 </xs:schema>
 

Framework

 // get primitive data types
 Type xsString = SchemaUtil.getSchemaType("string");

 // create inner elements
 Element a = new Element(new QName("a", "http://www.example.org"), xsString);
 Element b = new Element(new QName("b", "http://www.example.org"), xsString);
 Element c = new Element(new QName("c", "http://www.example.org"), xsString);
 Element d = new Element(new QName("d", "http://www.example.org"), xsString);
 Element e = new Element(new QName("f", "http://www.example.org"), xsString);

 // create the nested structure (bottom-up)
 ChoiceContainer choice = new ChoiceContainer();
 choice.addElement(e);
 choice.addElement(f);

 SequenceContainer sequence = new SequenceContainer();
 sequence.add(c);
 sequence.add(d);
 sequence.addContainer(choice);

 // create the complex type
 ComplexType nestedType = new ComplexType(new QName("nestedType", "http://www.example.org"),
 ComplexType.CONTAINER_ALL);
 nestedType.addElement(a);
 nestedType.addElement(b);

 // get the enclosed container and add the other container
 AllContainer all = nestedType.getContainer();
 all.addContainer(sequence);

 

Field Summary

Fields

Modifier and Type	Field and Description
protected List	container
protected int	containerCount
protected int	elementCount
protected int	groupCount
protected int	max
protected int	min

Fields inherited from interface org.ws4d.java.schema.Any

ATTRIBUTE_NAME, ATTRIBUTE_TYPE, ATTRIBUTE_VALUE_FALSE, ATTRIBUTE_VALUE_TRUE, TAG_ANY, TAG_ANYATTRIBUTE

Fields inherited from interface org.ws4d.java.constants.SchemaConstants

ATTRIBUTE_ABSTRACT, ATTRIBUTE_DEFAULT, ATTRIBUTE_FIXED, ATTRIBUTE_USE, ATTRIBUTE_XSINIL, ATTRIBUTE_XSINIL_QUALIFIED, ATTRIBUTE_XSITYPE, ATTRIBUTE_XSITYPE_QUALIFIED, DOCUMENTATION_LANG, DOCUMENTATION_LANG_QUALIFIED, ELEMENT_ALL, ELEMENT_ALL_QUALIFIED, ELEMENT_CHOICE, ELEMENT_CHOICE_QUALIFIED, ELEMENT_DEFAULT, ELEMENT_DEFAULT_QUALIFIED, ELEMENT_FIXED, ELEMENT_FIXED_QUALIFIED, ELEMENT_MAXOCCURS, ELEMENT_MINOCCURS, ELEMENT_NILLABLE, ELEMENT_PARENT, ELEMENT_PARENT_QUALIFIED, ELEMENT_RESTRICTIONS, ELEMENT_SEQUENCE, ELEMENT_SEQUENCE_QUALIFIED, ELEMENT_SUBSTITUTIONS, ELEMENT_UNIONS, FACET_ENUMERATION, FACET_ENUMERATION_QUALIFIED, FACET_FRACTIONDIGITS, FACET_FRACTIONDIGITS_QUALIFIED, FACET_LENGTH, FACET_LENGTH_QUALIFIED, FACET_MAXEXCLUSIVE, FACET_MAXEXCLUSIVE_QUALIFIED, FACET_MAXINCLUSIVE, FACET_MAXINCLUSIVE_QUALIFIED, FACET_MAXLENGTH, FACET_MAXLENGTH_QUALIFIED, FACET_MINEXCLUSIVE, FACET_MINEXCLUSIVE_QUALIFIED, FACET_MININCLUSIVE, FACET_MININCLUSIVE_QUALIFIED, FACET_MINLENGTH, FACET_MINLENGTH_QUALIFIED, FACET_PATTERN, FACET_PATTERN_QUALIFIED, FACET_TOTALDIGITS, FACET_TOTALDIGITS_QUALIFIED, FACET_WHITESPACE, FACET_WHITESPACE_QUALIFIED, LIST_ITEMTYPE, MAXOCCURS_UNBOUNDED, SCHEMA_ANNOTATION, SCHEMA_ANNOTATION_QUALIFIED, SCHEMA_ANY, SCHEMA_ANY_QUALIFIED, SCHEMA_ANYATTRIBUTE, SCHEMA_ANYATTRIBUTE_QUALIFIED, SCHEMA_APP_INFO, SCHEMA_APP_INFO_QUALIFIED, SCHEMA_ATTRIBUTE, SCHEMA_ATTRIBUTE_QUALIFIED, SCHEMA_ATTRIBUTEFORMDEFAULT, SCHEMA_ATTRIBUTEFORMDEFAULT_QUALIFIED, SCHEMA_ATTRIBUTEGROUP, SCHEMA_ATTRIBUTEGROUP_QUALIFIED, SCHEMA_BASE, SCHEMA_BASE_QUALIFIED, SCHEMA_COMPLEXCONTENT, SCHEMA_COMPLEXCONTENT_QUALIFIED, SCHEMA_COMPLEXTYPE, SCHEMA_COMPLEXTYPE_QUALIFIED, SCHEMA_DOCUMENTATION, SCHEMA_DOCUMENTATION_QUALIFIED, SCHEMA_ELEMENT, SCHEMA_ELEMENT_QUALIFIED, SCHEMA_ELEMENTFORMDEFAULT, SCHEMA_ELEMENTFORMDEFAULT_QUALIFIED, SCHEMA_EXTENSION, SCHEMA_EXTENSION_QUALIFIED, SCHEMA_FACETS, SCHEMA_FORM, SCHEMA_FORM_QUALIFIED, SCHEMA_GROUP, SCHEMA_GROUP_QUALIFIED, SCHEMA_IMPORT, SCHEMA_IMPORT_QUALIFIED, SCHEMA_INCLUDE, SCHEMA_INCLUDE_QUALIFIED, SCHEMA_ITEMLIST, SCHEMA_ITEMLIST_QUALIFIED, SCHEMA_ITEMTYPE, SCHEMA_ITEMTYPE_QUALIFIED, SCHEMA_LIST, SCHEMA_LIST_QUALIFIED, SCHEMA_LOCATION, SCHEMA_LOCATION_QUALIFIED, SCHEMA_MEMBERTYPES, SCHEMA_MEMBERTYPES_QUALIFIED, SCHEMA_NAME, SCHEMA_NAME_QUALIFIED, SCHEMA_NAMESPACE, SCHEMA_NAMESPACE_QUALIFIED, SCHEMA_NONAMESPACESCHEMALOCATION, SCHEMA_NONAMESPACESCHEMALOCATION_QUALIFIED, SCHEMA_NOTATION, SCHEMA_NOTATION_QUALIFIED, SCHEMA_PUBLIC, SCHEMA_PUBLIC_QUALIFIED, SCHEMA_QUALIFIED, SCHEMA_QUALIFIED_QUALIFIED, SCHEMA_REDEFINE, SCHEMA_REDEFINE_QUALIFIED, SCHEMA_REF, SCHEMA_REF_QUALIFIED, SCHEMA_RESTRICTION, SCHEMA_RESTRICTION_QUALIFIED, SCHEMA_SCHEMA, SCHEMA_SCHEMA_QUALIFIED, SCHEMA_SIMPLECONTENT, SCHEMA_SIMPLECONTENT_QUALIFIED, SCHEMA_SIMPLETYPE, SCHEMA_SIMPLETYPE_QUALIFIED, SCHEMA_STYPES, SCHEMA_SUBSTITUTIONGROUP, SCHEMA_SUBSTITUTIONGROUP_QUALIFIED, SCHEMA_SYSTEM, SCHEMA_SYSTEM_QUALIFIED, SCHEMA_TARGETNAMESPACE, SCHEMA_TARGETNAMESPACE_QUALIFIED, SCHEMA_TYPE, SCHEMA_TYPE_QUALIFIED, SCHEMA_UNION, SCHEMA_UNION_QUALIFIED, SCHEMA_UNQUALIFIED, SCHEMA_UNQUALIFIED_QUALIFIED, SCHEMA_VALUE, SCHEMA_VALUE_QUALIFIED, SCHEMA_VALUEVECTOR, SCHEMA_VALUEVECTOR_QUALIFIED, USE_OPTIONAL, USE_PROHIBITED, USE_REQUIRED, XMLSCHEMA_NAMESPACE, XMLSCHEMA_PREFIX, XSD_ALLMODEL, XSD_ANYATTRIBUTE, XSD_ANYELEMENT, XSD_ATTRIBUTE, XSD_ATTRIBUTEGROUP, XSD_CHOICEMODEL, XSD_COMPLEXTYPE, XSD_ELEMENT, XSD_EXTENDEDCOMPLEXCONTENT, XSD_EXTENDEDSIMPLECONTENT, XSD_GROUP, XSD_NOTATION, XSD_RESTRICTEDCOMPLEXCONTENT, XSD_RESTRICTEDSIMPLECONTENT, XSD_RESTRICTEDSIMPLETYPE, XSD_SCHEMA, XSD_SEQUENCEMODEL, XSD_SIMPLETYPE, XSI_NAMESPACE, XSI_PREFIX

Method Summary

Modifier and Type	Method and Description
void	addAnyElement(AnyElement e) Adds an any element to the container.
void	addContainer(ElementContainer container) Adds another container to this container.
void	addElement(Element e) Adds an element to the container.
void	addGroup(Group g) Adds a group of elements to the container.
Iterator	all()
Iterator	allElements() Returns an iterator of elements from this container and all elements from nested containers.
Iterator	containers() Returns an iterator of containers inside this container.
Iterator	getContainerContent()
abstract int	getContainerType() Returns the information about the type of this container.
Element	getElementByName(QName name) Returns an element from the container with matching name.
Element	getElementByName(java.lang.String name) Returns an element with matching name from the container.
int	getElementCount() Returns the element count of the enclosed containers.
Element	getFirstElement()
int	getInnerContainerCount() Returns the number of containers inside this container.
Element	getLocalElementByName(QName name) Returns a local element (i.e.
Element	getLocalElementByName(java.lang.String name) Returns a local element (i.e.
int	getMaxOccurs() Returns the maximum occurrence for the container.
int	getMinOccurs() Returns the minimum occurrence for the container.
boolean	hasElements() Returns true if the container has element definitions, false otherwise.
Iterator	listAll()
void	mergeContainer(ElementContainer container) Merge one container into this container.
Iterator	ownElements() Returns an iterator of elements from this container.
protected void	serialize0(XmlSerializer serializer, Schema schema)
void	setMaxOccurs(int max) Sets the maximum occurrence for the container.
void	setMinOccurs(int min) Sets the minimum occurrence for the container.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ws4d.java.schema.Any

getSchemaIdentifier

Field Detail

container

protected List container

min

protected int min

max

protected int max

containerCount

protected int containerCount

elementCount

protected int elementCount

groupCount

protected int groupCount

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getMinOccurs

public int getMinOccurs()

Returns the minimum occurrence for the container.

The "minOccurs" attribute in XML Schema describes the minimum occurrence of the container inside the created XML instance document.

Returns:

the minimum occurrence for the container.

setMinOccurs

public void setMinOccurs(int min)

Sets the minimum occurrence for the container.

The "minOccurs" attribute in XML Schema describes the minimum occurrence of the container inside the created XML instance document.

Parameters:

min - the minimum occurrence for the container.

getMaxOccurs

public int getMaxOccurs()

Returns the maximum occurrence for the container.

The "maxOccurs" attribute in XML Schema describes the maximum occurrence of the container inside the created XML instance document.

Returns:

the maximum occurrence for the container.

setMaxOccurs

public void setMaxOccurs(int max)

Sets the maximum occurrence for the container.

The "maxOccurs" attribute in XML Schema describes the maximum occurrence of the container inside the created XML instance document.

Parameters:

max - the maximum occurrence for the container.

mergeContainer

public void mergeContainer(ElementContainer container)

Merge one container into this container.

Parameters:

container - the container which should be merged with this one.

getInnerContainerCount

public int getInnerContainerCount()

Returns the number of containers inside this container.

Returns:

the number of containers inside this container.

addContainer

public void addContainer(ElementContainer container)

Adds another container to this container.

Parameters:

container - the container to add.

addElement

public void addElement(Element e)

Adds an element to the container.

Parameters:

e - the element to add.

addAnyElement

public void addAnyElement(AnyElement e)

Adds an any element to the container. This allows to add elements from other schemas to the XML instance document.

Parameters:

e - the element to add.

addGroup

public void addGroup(Group g)

Adds a group of elements to the container.

Parameters:

g - the group to add.

getElementCount

public int getElementCount()

Returns the element count of the enclosed containers.

Returns:

the element count.

getElementByName

public Element getElementByName(QName name)

Returns an element from the container with matching name.

Parameters:

name - the qualified name of the element which should be returned.

Returns:

the element.

getLocalElementByName

public Element getLocalElementByName(QName name)

Returns a local element (i.e. one that is directly contained by this container) from the container with matching name.

Parameters:

name - the qualified name of the element which should be returned.

Returns:

the element.

getElementByName

public Element getElementByName(java.lang.String name)

Returns an element with matching name from the container.

This method will NOT verify the namespace.

Parameters:

name - the name of the element which should be returned.

Returns:

the element.

getLocalElementByName

public Element getLocalElementByName(java.lang.String name)

Returns a local element (i.e. one that is directly contained by this container) with matching name from the container.

This method will NOT verify the namespace.

Parameters:

name - the name of the element which should be returned.

Returns:

the element.

listAll

public Iterator listAll()

containers

public Iterator containers()

Returns an iterator of containers inside this container.

Returns:

the containers.

all

public Iterator all()

getFirstElement

public Element getFirstElement()

ownElements

public Iterator ownElements()

Returns an iterator of elements from this container.

Returns:

the elements.

allElements

public Iterator allElements()

Returns an iterator of elements from this container and all elements from nested containers.

Returns:

the elements.

getContainerContent

public Iterator getContainerContent()

hasElements

public boolean hasElements()

Returns true if the container has element definitions, false otherwise.

Returns:

true if the container has element definitions, false otherwise.

serialize0

protected void serialize0(XmlSerializer serializer,
                          Schema schema)
                   throws java.io.IOException

Throws:

java.io.IOException

getContainerType

public abstract int getContainerType()

Returns the information about the type of this container. (xs:all, xs:sequence or xs:choice).

Returns:

the type of this container.