Package org.xmlet.xsdparser.xsdelements

Class XsdComplexType

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.XsdComplexType

public class XsdComplexType
extends XsdNamedElements

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

See Also:

xsd:complexType element description and usage at w3c

Field Summary

Fields

Modifier and Type	Field	Description
private ComplexTypeBlockEnum	block	Prevents a complex type that has a specified type of derivation from being used in place of this complex type.
private ReferenceBase	childElement	The child element of XsdComplexType.
private XsdComplexContent	complexContent	A XsdComplexContent child.
private boolean	elementAbstract	Specifies whether the complex type can be used in an instance document.
private FinalEnum	elementFinal	Prevents a specified type of derivation of this complex type element.
private boolean	mixed	Specifies whether character data is allowed to appear between the child elements of this complexType element.
private XsdSimpleContent	simpleContent	A XsdSimpleContent child.
private XsdComplexTypeVisitor	visitor	XsdComplexTypeVisitor instance which restricts the children elements to: * XsdAll, XsdSequence and XsdChoice (represented by their base class XsdMultipleElements); * XsdGroup; * XsdComplexContent; * XsdSimpleContent; Can also have XsdAttribute and XsdAttributeGroup children as per inheritance of AttributesVisitor.
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

Constructor	Description
XsdComplexType(XsdParser parser, Map<String,String> elementFieldsMapParam)
XsdComplexType(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.
private boolean	childrenIsMultipleElement()
XsdComplexType	clone(Map<String,String> placeHolderAttributes)	Performs a copy of the current object for replacing purposes.
(package private) List<ReferenceBase>	getAttributes()
String	getBlock()
XsdAll	getChildAsAll()
XsdChoice	getChildAsChoice()
XsdGroup	getChildAsGroup()
XsdSequence	getChildAsSequence()
XsdComplexContent	getComplexContent()
List<ReferenceBase>	getElements()
String	getFinal()
XsdSimpleContent	getSimpleContent()
XsdComplexTypeVisitor	getVisitor()	Obtains the visitor of a concrete XsdAbstractElement instance.
Stream<XsdAttributeGroup>	getXsdAttributeGroup()
Stream<XsdAttribute>	getXsdAttributes()
XsdAbstractElement	getXsdChildElement()
boolean	isElementAbstract()
boolean	isMixed()
static ReferenceBase	parse(XsdParser parser, Node node)
void	replaceUnsolvedElements(NamedConcreteElement element)	This method iterates on the current element children and replaces any UnsolvedReference object that has a ref attribute that matches the receiving NamedConcreteElement name attribute.
private void	rule2()	Asserts if the current object has a simpleContent as children and contains a value for the mixed attribute, which isn't allowed throwing an exception in that case.
void	setChildElement(ReferenceBase childElement)
void	setComplexContent(XsdComplexContent complexContent)
void	setFields(Map<String,String> elementFieldsMapParam)	Extracts the field values from the received Map.
void	setSimpleContent(XsdSimpleContent simpleContent)
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, 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 XsdComplexTypeVisitor visitor

XsdComplexTypeVisitor instance which restricts the children elements to: * XsdAll, XsdSequence and XsdChoice (represented by their base class XsdMultipleElements); * XsdGroup; * XsdComplexContent; * XsdSimpleContent; Can also have XsdAttribute and XsdAttributeGroup children as per inheritance of AttributesVisitor. Can also have XsdAnnotation children as per inheritance of XsdAnnotatedElementsVisitor.

childElement

private ReferenceBase childElement

The child element of XsdComplexType. Can be either a XsdGroup or a XsdMultipleElements instance wrapped in a ReferenceBase object.

elementAbstract

private boolean elementAbstract

Specifies whether the complex type can be used in an instance document. True indicates that an element cannot use this complex type directly but must use a complex type derived from this complex type.

mixed

private boolean mixed

Specifies whether character data is allowed to appear between the child elements of this complexType element. This attribute is exclusive with simpleContent, only one can be present at any given time.

block

private ComplexTypeBlockEnum block

Prevents a complex type that has a specified type of derivation from being used in place of this complex type. Possible values are extension, restriction or #all.

elementFinal

private FinalEnum elementFinal

Prevents a specified type of derivation of this complex type element. Possible values are extension, restriction or #all.

complexContent

private XsdComplexContent complexContent

A XsdComplexContent child.

simpleContent

private XsdSimpleContent simpleContent

A XsdSimpleContent child. This element is exclusive with the mixed field, only one of them should be present in any XsdComplexType element.

Constructor Detail

XsdComplexType

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

XsdComplexType

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

Method Detail

setFields

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

Extracts the field values from the received Map. The elementAbstract and mixed field both have the false as a default value.

Overrides:

setFields in class XsdNamedElements

Parameters:

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

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 a simpleContent as children and contains a value for the mixed attribute, which isn't allowed throwing an exception in that case.

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 XsdComplexTypeVisitor 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:

The elements of his child as if they belong to the XsdComplexType instance.

clone

public XsdComplexType 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.

replaceUnsolvedElements

public void replaceUnsolvedElements(NamedConcreteElement element)

Description copied from class: XsdAbstractElement

This method iterates on the current element children and replaces any UnsolvedReference object that has a ref attribute that matches the receiving NamedConcreteElement name attribute.

Overrides:

replaceUnsolvedElements in class XsdAbstractElement

Parameters:

element - A fully parsed element with a name that will replace an UnsolvedReference object, if a match between the NamedConcreteElement name attribute and the UnsolvedReference ref attribute.

getXsdChildElement

public XsdAbstractElement getXsdChildElement()

getFinal

public String getFinal()

getAttributes

List<ReferenceBase> getAttributes()

getXsdAttributes

public Stream<XsdAttribute> getXsdAttributes()

getXsdAttributeGroup

public Stream<XsdAttributeGroup> getXsdAttributeGroup()

getSimpleContent

public XsdSimpleContent getSimpleContent()

getComplexContent

public XsdComplexContent getComplexContent()

isMixed

public boolean isMixed()

isElementAbstract

public boolean isElementAbstract()

parse

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

setChildElement

public void setChildElement(ReferenceBase childElement)

setComplexContent

public void setComplexContent(XsdComplexContent complexContent)

setSimpleContent

public void setSimpleContent(XsdSimpleContent simpleContent)

getBlock

public String getBlock()

getChildAsGroup

public XsdGroup getChildAsGroup()

Returns:

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

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.

childrenIsMultipleElement

private boolean childrenIsMultipleElement()