Package org.xmlet.xsdparser.xsdelements

Class XsdGroup

java.lang.Object

org.xmlet.xsdparser.xsdelements.XsdAbstractElement

org.xmlet.xsdparser.xsdelements.XsdIdentifierElements

org.xmlet.xsdparser.xsdelements.XsdAnnotatedElements

org.xmlet.xsdparser.xsdelements.XsdNamedElements

org.xmlet.xsdparser.xsdelements.XsdGroup

public class XsdGroup
extends XsdNamedElements

A class representing the xsd:complexType element. Extends XsdNamedElements because it's one of the XsdAbstractElement concrete classes that can have a XsdNamedElements.name attribute.

See Also:

xsd:group description and usage at w3c

Field Summary

Fields

Modifier and Type	Field	Description
private XsdMultipleElements	childElement	The child element of the XsdGroup instance.
private String	maxOccurs	Specifies the maximum number of times this element can occur in the parent element.
private Integer	minOccurs	Specifies the minimum number of times this element can occur in the parent element.
private XsdGroupVisitor	visitor	XsdGroupVisitor instance which restricts his children to XsdAll, XsdChoice or XsdSequence instances.
static String	XS_TAG
static String	XSD_TAG

Fields inherited from class org.xmlet.xsdparser.xsdelements.XsdAbstractElement

ABSTRACT_TAG, ATTRIBUTE_FORM_DEFAULT, BASE_TAG, BLOCK_DEFAULT, BLOCK_TAG, DEFAULT_ELEMENT_TAG, DEFAULT_TAG, ELEMENT_FORM_DEFAULT, elementFieldsMap, FINAL_DEFAULT, FINAL_TAG, FIXED_TAG, FORM_TAG, ID_TAG, ITEM_TYPE_TAG, MAX_OCCURS_TAG, MEMBER_TYPES_TAG, MIN_OCCURS_TAG, MIXED_TAG, NAME_TAG, NAMESPACE, NILLABLE_TAG, parent, parser, REF_TAG, SCHEMA_LOCATION, SOURCE_TAG, SUBSTITUTION_GROUP_TAG, TARGET_NAMESPACE, TYPE_TAG, USE_TAG, VALUE_TAG, VERSION, XML_LANG_TAG, XMLNS

Fields inherited from class org.xmlet.xsdparser.xsdelements.XsdNamedElements

name

Constructor Summary

Constructors

Modifier	Constructor	Description
private	XsdGroup(XsdParser parser, Map<String,String> elementFieldsMapParam)
private	XsdGroup(XsdAbstractElement parent, XsdParser parser, Map<String,String> elementFieldsMapParam)

Method Summary

Modifier and Type	Method	Description
void	accept(XsdAbstractElementVisitor visitorParam)	Base method for all accept methods.
XsdNamedElements	clone(Map<String,String> placeHolderAttributes)	Performs a copy of the current object for replacing purposes.
XsdAll	getChildAsAll()
XsdChoice	getChildAsChoice()
XsdSequence	getChildAsSequence()
XsdMultipleElements	getChildElement()
List<ReferenceBase>	getElements()
String	getMaxOccurs()
Integer	getMinOccurs()
XsdGroupVisitor	getVisitor()	Obtains the visitor of a concrete XsdAbstractElement instance.
static ReferenceBase	parse(XsdParser parser, Node node)
private void	rule2()	Asserts if the current object has the name attribute when not being a direct child of the XsdSchema element, which is not allowed, throwing an exception in that case.
private void	rule3()	Asserts if the current has no value for its name attribute while being a direct child of the top level XsdSchema element, which is required.
void	setChildElement(XsdMultipleElements childElement)
void	setFields(Map<String,String> elementFieldsMapParam)	Sets the occurs fields either with the Map values or with their default values.
void	validateSchemaRules()	Runs verifications on each concrete element to ensure that the XSD schema rules are verified.

Methods inherited from class java.lang.Object

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

Methods inherited from class org.xmlet.xsdparser.xsdelements.XsdAbstractElement

convertNodeMap, getElementFieldsMap, getParent, getParser, getXsdElements, replaceUnsolvedElements, setParent, xsdParseSkeleton, xsdRawContentParse

Methods inherited from class org.xmlet.xsdparser.xsdelements.XsdAnnotatedElements

getAnnotation, setAnnotation

Methods inherited from class org.xmlet.xsdparser.xsdelements.XsdIdentifierElements

getId

Methods inherited from class org.xmlet.xsdparser.xsdelements.XsdNamedElements

getName, getRawName, setName

Field Detail

XSD_TAG

public static final String XSD_TAG

See Also:

Constant Field Values

XS_TAG

public static final String XS_TAG

See Also:

Constant Field Values

visitor

private XsdGroupVisitor visitor

XsdGroupVisitor instance which restricts his children to XsdAll, XsdChoice or XsdSequence instances. Can also have XsdAnnotation children as per inheritance of XsdAnnotatedElementsVisitor.

childElement

private XsdMultipleElements childElement

The child element of the XsdGroup instance. It can be a XsdAll, XsdChoice or a XsdSequence instance.

minOccurs

private Integer minOccurs

Specifies the minimum number of times this element can occur in the parent element. The value can be any number bigger or equal to 0. Default value is 1. This attribute cannot be used if the parent element is the XsdSchema element.

maxOccurs

private String maxOccurs

Specifies the maximum number of times this element can occur in the parent element. The value can be any number bigger or equal to 0, or if you want to set no limit on the maximum number, use the value "unbounded". Default value is 1. This attribute cannot be used if the parent element is the XsdSchema element.

Constructor Detail

XsdGroup

private XsdGroup(@NotNull
                 XsdParser parser,
                 @NotNull
                 Map<String,String> elementFieldsMapParam)

XsdGroup

private XsdGroup(XsdAbstractElement parent,
                 @NotNull
                 XsdParser parser,
                 @NotNull
                 Map<String,String> elementFieldsMapParam)

Method Detail

setFields

public void setFields(@NotNull
                      Map<String,String> elementFieldsMapParam)

Sets the occurs fields either with the Map values or with their default values.

Overrides:

setFields in class XsdNamedElements

Parameters:

elementFieldsMapParam - The Map object containing the information previously contained in the Node object.

validateSchemaRules

public void validateSchemaRules()

Runs verifications on each concrete element to ensure that the XSD schema rules are verified.

Overrides:

validateSchemaRules in class XsdNamedElements

rule2

private void rule2()

Asserts if the current object has the name attribute when not being a direct child of the XsdSchema element, which is not allowed, throwing an exception in that case.

rule3

private void rule3()

Asserts if the current has no value for its name attribute while being a direct child of the top level XsdSchema element, which is required. Throws an exception if no name is present.

accept

public void accept(XsdAbstractElementVisitor visitorParam)

Description copied from class: XsdAbstractElement

Base method for all accept methods. It serves as a way to guarantee that every accept call assigns the parent field.

Overrides:

accept in class XsdAbstractElement

Parameters:

visitorParam - The visitor that is visiting the current instance.

getVisitor

public XsdGroupVisitor getVisitor()

Description copied from class: XsdAbstractElement

Obtains the visitor of a concrete XsdAbstractElement instance.

Specified by:

getVisitor in class XsdAbstractElement

Returns:

The concrete visitor instance.

getElements

public List<ReferenceBase> getElements()

Overrides:

getElements in class XsdAbstractElement

Returns:

A list with the child element of the XsdGroup instance.

clone

public XsdNamedElements clone(@NotNull
                              Map<String,String> placeHolderAttributes)

Performs a copy of the current object for replacing purposes. The cloned objects are used to replace UnsolvedReference objects in the reference solving process.

Specified by:

clone in class XsdNamedElements

Parameters:

placeHolderAttributes - The additional attributes to add to the clone.

Returns:

A copy of the object from which is called upon.

setChildElement

public void setChildElement(XsdMultipleElements childElement)

getChildElement

public XsdMultipleElements getChildElement()

getChildAsAll

public XsdAll getChildAsAll()

Returns:

The childElement as a XsdAll object or null if childElement isn't a XsdAll instance.

getChildAsChoice

public XsdChoice getChildAsChoice()

Returns:

The childElement as a XsdChoice object or null if childElement isn't a XsdChoice instance.

getChildAsSequence

public XsdSequence getChildAsSequence()

Returns:

The childElement as a XsdSequence object or null if childElement isn't a XsdSequence instance.

parse

public static ReferenceBase parse(@NotNull
                                  XsdParser parser,
                                  Node node)

getMinOccurs

public Integer getMinOccurs()

getMaxOccurs

public String getMaxOccurs()