Package org.xmlet.xsdparser.xsdelements

Class XsdAbstractElement

java.lang.Object

org.xmlet.xsdparser.xsdelements.XsdAbstractElement

Direct Known Subclasses:

XsdAnnotationChildren, XsdIdentifierElements

public abstract class XsdAbstractElement
extends java.lang.Object

This class serves as a base to every element class, i.e. XsdElement, XsdAttribute, etc.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ABSTRACT_TAG
static java.lang.String	ATTRIBUTE_FORM_DEFAULT
protected java.util.Map<java.lang.String,java.lang.String>	attributesMap	A Map object containing the keys/values of the attributes that belong to the concrete element instance.
static java.lang.String	BASE_TAG
static java.lang.String	BLOCK_DEFAULT
static java.lang.String	BLOCK_TAG
(package private) XsdAbstractElement	cloneOf	Indicates the source from this object was cloned, if applicable.
static java.lang.String	DEFAULT_ELEMENT_TAG
static java.lang.String	DEFAULT_TAG
static java.lang.String	ELEMENT_FORM_DEFAULT
static java.lang.String	FINAL_DEFAULT
static java.lang.String	FINAL_TAG
static java.lang.String	FIXED_TAG
static java.lang.String	FORM_TAG
static java.lang.String	ID_TAG
static java.lang.String	ITEM_TYPE_TAG
static java.lang.String	MAX_OCCURS_TAG
static java.lang.String	MEMBER_TYPES_TAG
static java.lang.String	MIN_OCCURS_TAG
static java.lang.String	MIXED_TAG
static java.lang.String	NAME_TAG
static java.lang.String	NAMESPACE
static java.lang.String	NILLABLE_TAG
(package private) XsdAbstractElement	parent	The instance which contains the present element.
boolean	parentAvailable	Indicates if this element has the Parent available.
(package private) XsdParserCore	parser	The XsdParserCore instance that parsed this element.
static java.lang.String	REF_TAG
static java.lang.String	SCHEMA_LOCATION
static java.lang.String	SOURCE_TAG
static java.lang.String	SUBSTITUTION_GROUP_TAG
static java.lang.String	TARGET_NAMESPACE
static java.lang.String	TYPE_TAG
static java.lang.String	USE_TAG
protected static java.lang.String	VALUE_TAG
static java.lang.String	VERSION
(package private) XsdAbstractElementVisitor	visitor	The visitor instance for this element.
protected java.util.function.Function<XsdAbstractElement,XsdAbstractElementVisitor>	visitorFunction
static java.lang.String	XML_LANG_TAG
static java.lang.String	XMLNS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XsdAbstractElement(XsdParserCore parser, java.util.Map<java.lang.String,java.lang.String> attributesMap, java.util.function.Function<XsdAbstractElement,XsdAbstractElementVisitor> visitorFunction)

Method Summary

Modifier and Type	Method	Description
void	accept(XsdAbstractElementVisitor xsdAbstractElementVisitor)	Base method for all accept methods.
XsdAbstractElement	clone(java.util.Map<java.lang.String,java.lang.String> placeHolderAttributes)	Performs a copy of the current object for replacing purposes.
XsdAbstractElement	clone(java.util.Map<java.lang.String,java.lang.String> placeHolderAttributes, XsdAbstractElement parent)	Performs a copy of the current object for replacing purposes.
(package private) static boolean	compareReference(NamedConcreteElement element, java.lang.String unsolvedRef)
static boolean	compareReference(NamedConcreteElement element, UnsolvedReference reference)
protected static java.util.Map<java.lang.String,java.lang.String>	convertNodeMap(org.w3c.dom.NamedNodeMap nodeMap)	Converts a NamedNodeMap to a Map object.
java.util.Map<java.lang.String,java.lang.String>	getAttributesMap()
XsdAbstractElement	getCloneOf()
java.util.List<ReferenceBase>	getElements()
XsdAbstractElement	getParent()
XsdAbstractElement	getParent(boolean enforceParentAvailability)
XsdParserCore	getParser()
XsdAbstractElementVisitor	getVisitor()	Obtains the visitor of a concrete XsdAbstractElement instance.
java.util.stream.Stream<XsdAbstractElement>	getXsdElements()
XsdSchema	getXsdSchema()
static XsdSchema	getXsdSchema(XsdAbstractElement element, java.util.List<XsdAbstractElement> hierarchy)
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.
void	setCloneOf(XsdAbstractElement cloneOf)	Sets source of the clone of the current XsdAbstractElement object.
void	setParent(XsdAbstractElement parent)
void	setParentAvailable(boolean parentAvailable)
void	validateSchemaRules()	Runs verifications on each concrete element to ensure that the XSD schema rules are verified.
static ReferenceBase	xsdParseSkeleton(org.w3c.dom.Node node, XsdAbstractElement element)	The base code for parsing any XsdAbstractElement.
(package private) static java.lang.String	xsdRawContentParse(org.w3c.dom.Node node)	In special cases such as XsdAppInfo and XsdDocumentation the contents are a simple text node, in which case this function is more suited than using the xsdParseSkeleton(org.w3c.dom.Node, org.xmlet.xsdparser.xsdelements.XsdAbstractElement) since those types of elements can't have children nodes.

Methods inherited from class java.lang.Object

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

Field Detail

attributesMap

protected java.util.Map<java.lang.String,java.lang.String> attributesMap

A Map object containing the keys/values of the attributes that belong to the concrete element instance.

ATTRIBUTE_FORM_DEFAULT

public static final java.lang.String ATTRIBUTE_FORM_DEFAULT

See Also:

Constant Field Values

ELEMENT_FORM_DEFAULT

public static final java.lang.String ELEMENT_FORM_DEFAULT

See Also:

Constant Field Values

BLOCK_DEFAULT

public static final java.lang.String BLOCK_DEFAULT

See Also:

Constant Field Values

FINAL_DEFAULT

public static final java.lang.String FINAL_DEFAULT

See Also:

Constant Field Values

TARGET_NAMESPACE

public static final java.lang.String TARGET_NAMESPACE

See Also:

Constant Field Values

VERSION

public static final java.lang.String VERSION

See Also:

Constant Field Values

XMLNS

public static final java.lang.String XMLNS

See Also:

Constant Field Values

ID_TAG

public static final java.lang.String ID_TAG

See Also:

Constant Field Values

NAME_TAG

public static final java.lang.String NAME_TAG

See Also:

Constant Field Values

ABSTRACT_TAG

public static final java.lang.String ABSTRACT_TAG

See Also:

Constant Field Values

DEFAULT_ELEMENT_TAG

public static final java.lang.String DEFAULT_ELEMENT_TAG

See Also:

Constant Field Values

FIXED_TAG

public static final java.lang.String FIXED_TAG

See Also:

Constant Field Values

TYPE_TAG

public static final java.lang.String TYPE_TAG

See Also:

Constant Field Values

MIXED_TAG

public static final java.lang.String MIXED_TAG

See Also:

Constant Field Values

BLOCK_TAG

public static final java.lang.String BLOCK_TAG

See Also:

Constant Field Values

FINAL_TAG

public static final java.lang.String FINAL_TAG

See Also:

Constant Field Values

USE_TAG

public static final java.lang.String USE_TAG

See Also:

Constant Field Values

SUBSTITUTION_GROUP_TAG

public static final java.lang.String SUBSTITUTION_GROUP_TAG

See Also:

Constant Field Values

DEFAULT_TAG

public static final java.lang.String DEFAULT_TAG

See Also:

Constant Field Values

FORM_TAG

public static final java.lang.String FORM_TAG

See Also:

Constant Field Values

NILLABLE_TAG

public static final java.lang.String NILLABLE_TAG

See Also:

Constant Field Values

MIN_OCCURS_TAG

public static final java.lang.String MIN_OCCURS_TAG

See Also:

Constant Field Values

MAX_OCCURS_TAG

public static final java.lang.String MAX_OCCURS_TAG

See Also:

Constant Field Values

ITEM_TYPE_TAG

public static final java.lang.String ITEM_TYPE_TAG

See Also:

Constant Field Values

BASE_TAG

public static final java.lang.String BASE_TAG

See Also:

Constant Field Values

SOURCE_TAG

public static final java.lang.String SOURCE_TAG

See Also:

Constant Field Values

XML_LANG_TAG

public static final java.lang.String XML_LANG_TAG

See Also:

Constant Field Values

MEMBER_TYPES_TAG

public static final java.lang.String MEMBER_TYPES_TAG

See Also:

Constant Field Values

SCHEMA_LOCATION

public static final java.lang.String SCHEMA_LOCATION

See Also:

Constant Field Values

NAMESPACE

public static final java.lang.String NAMESPACE

See Also:

Constant Field Values

REF_TAG

public static final java.lang.String REF_TAG

See Also:

Constant Field Values

VALUE_TAG

protected static final java.lang.String VALUE_TAG

See Also:

Constant Field Values

parent

XsdAbstractElement parent

The instance which contains the present element.

parser

XsdParserCore parser

The XsdParserCore instance that parsed this element.

visitor

XsdAbstractElementVisitor visitor

The visitor instance for this element.

cloneOf

XsdAbstractElement cloneOf

Indicates the source from this object was cloned, if applicable.

parentAvailable

public boolean parentAvailable

Indicates if this element has the Parent available. This was created as a way of indicating that the parent of the current element isn't present to avoid circular memory dependencies.

visitorFunction

protected final java.util.function.Function<XsdAbstractElement,XsdAbstractElementVisitor> visitorFunction

Constructor Detail

XsdAbstractElement

protected XsdAbstractElement(@NotNull
                             XsdParserCore parser,
                             @NotNull
                             java.util.Map<java.lang.String,java.lang.String> attributesMap,
                             java.util.function.Function<XsdAbstractElement,XsdAbstractElementVisitor> visitorFunction)

Method Detail

getAttributesMap

public java.util.Map<java.lang.String,java.lang.String> getAttributesMap()

getVisitor

public XsdAbstractElementVisitor getVisitor()

Obtains the visitor of a concrete XsdAbstractElement instance.

Returns:

The concrete visitor instance.

validateSchemaRules

public void validateSchemaRules()

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

accept

public void accept(XsdAbstractElementVisitor xsdAbstractElementVisitor)

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

Parameters:

xsdAbstractElementVisitor - The visitor that is visiting the current instance.

getElements

public java.util.List<ReferenceBase> getElements()

clone

public XsdAbstractElement clone(@NotNull
                                java.util.Map<java.lang.String,java.lang.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.

Parameters:

placeHolderAttributes - The additional attributes to add to the clone.

Returns:

A copy of the object from which is called upon.

clone

public XsdAbstractElement clone(@NotNull
                                java.util.Map<java.lang.String,java.lang.String> placeHolderAttributes,
                                XsdAbstractElement parent)

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

Parameters:

placeHolderAttributes - The additional attributes to add to the clone.

Returns:

A copy of the object from which is called upon.

getXsdElements

public java.util.stream.Stream<XsdAbstractElement> getXsdElements()

Returns:

All the ConcreteElement objects present in the concrete implementation of the XsdAbstractElement class. It doesn't return the UnsolvedReference objects.

getXsdSchema

public XsdSchema getXsdSchema()

getXsdSchema

public static XsdSchema getXsdSchema(XsdAbstractElement element,
                                     java.util.List<XsdAbstractElement> hierarchy)

xsdParseSkeleton

public static ReferenceBase xsdParseSkeleton(org.w3c.dom.Node node,
                                             XsdAbstractElement element)

The base code for parsing any XsdAbstractElement. All the concrete implementations of this class should call this method in order to parse its children.

Parameters:

node - The node from where the element will be parsed.

element - The concrete element that will be populated and returned.

Returns:

A wrapper object that contains the parsed XSD object.

getParser

public XsdParserCore getParser()

convertNodeMap

protected static java.util.Map<java.lang.String,java.lang.String> convertNodeMap(org.w3c.dom.NamedNodeMap nodeMap)

Converts a NamedNodeMap to a Map object. This is meant to simplify the manipulation of the information.

Parameters:

nodeMap - The NamedNodeMap to convert to a Map object.

Returns:

The Map object that was generated by the conversion.

replaceUnsolvedElements

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

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.

compareReference

public static boolean compareReference(NamedConcreteElement element,
                                       UnsolvedReference reference)

compareReference

static boolean compareReference(NamedConcreteElement element,
                                java.lang.String unsolvedRef)

getParent

public XsdAbstractElement getParent()

Returns:

The parent of the current XsdAbstractElement object.

getParent

public XsdAbstractElement getParent(boolean enforceParentAvailability)

Returns:

The parent of the current XsdAbstractElement object.

getCloneOf

public XsdAbstractElement getCloneOf()

Returns:

The source of the clone of the current XsdAbstractElement object.

setCloneOf

public void setCloneOf(XsdAbstractElement cloneOf)

Sets source of the clone of the current XsdAbstractElement object.

setParent

public void setParent(XsdAbstractElement parent)

setParentAvailable

public void setParentAvailable(boolean parentAvailable)

xsdRawContentParse

static java.lang.String xsdRawContentParse(org.w3c.dom.Node node)

In special cases such as XsdAppInfo and XsdDocumentation the contents are a simple text node, in which case this function is more suited than using the xsdParseSkeleton(org.w3c.dom.Node, org.xmlet.xsdparser.xsdelements.XsdAbstractElement) since those types of elements can't have children nodes.

Parameters:

node - The Node containing either a XsdAppInfo or XsdDocumentation.

Returns:

The textual value contained in the Node parameter.