XsdAbstractElement (com.github.xmlet:xsdParser 1.0.13 API)

java.lang.Object
- org.xmlet.xsdparser.xsdelements.XsdAbstractElement

Direct Known Subclasses:

XsdAnnotationChildren, XsdIdentifierElements
```
public abstract class XsdAbstractElement
extends Object
```
This class serves as a base to every element class, i.e. XsdElement, XsdAttribute, etc.

Field Summary

Fields
Modifier and Type	Field	Description
`(package private) static String`	`ABSTRACT_TAG`
`(package private) static String`	`ATTRIBUTE_FORM_DEFAULT`
`(package private) static String`	`BASE_TAG`
`(package private) static String`	`BLOCK_DEFAULT`
`(package private) static String`	`BLOCK_TAG`
`(package private) static String`	`DEFAULT_ELEMENT_TAG`
`(package private) static String`	`DEFAULT_TAG`
`(package private) static String`	`ELEMENT_FORM_DEFAULT`
`protected Map<String,String>`	`elementFieldsMap`	A `Map` object containing the keys/values of the attributes that belong to the concrete element instance.
`(package private) static String`	`FINAL_DEFAULT`
`(package private) static String`	`FINAL_TAG`
`protected static String`	`FIXED_TAG`
`(package private) static String`	`FORM_TAG`
`(package private) static String`	`ID_TAG`
`(package private) static String`	`ITEM_TYPE_TAG`
`(package private) static String`	`MAX_OCCURS_TAG`
`(package private) static String`	`MEMBER_TYPES_TAG`
`(package private) static String`	`MIN_OCCURS_TAG`
`(package private) static String`	`MIXED_TAG`
`static String`	`NAME_TAG`
`(package private) static String`	`NAMESPACE`
`(package private) static String`	`NILLABLE_TAG`
`(package private) XsdAbstractElement`	`parent`	The instance which contains the present element.
`(package private) XsdParser`	`parser`	The `XsdParser` instance that parsed this element.
`static String`	`REF_TAG`
`(package private) static String`	`SCHEMA_LOCATION`
`(package private) static String`	`SOURCE_TAG`
`(package private) static String`	`SUBSTITUTION_GROUP_TAG`
`(package private) static String`	`TARGET_NAMESPACE`
`(package private) static String`	`TYPE_TAG`
`(package private) static String`	`USE_TAG`
`protected static String`	`VALUE_TAG`
`(package private) static String`	`VERSION`
`(package private) static String`	`XML_LANG_TAG`
`(package private) static String`	`XMLNS`

Constructor Summary

Constructors
Modifier Constructor Description

protected XsdAbstractElement(XsdParser parser, Map<String,String> elementFieldsMapParam)

Constructors
Modifier	Constructor	Description
`protected`	`XsdAbstractElement(XsdParser parser, Map<String,String> elementFieldsMapParam)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`accept(XsdAbstractElementVisitor xsdAbstractElementVisitor)`	Base method for all accept methods.
`protected static Map<String,String>`	`convertNodeMap(NamedNodeMap nodeMap)`	Converts a `NamedNodeMap` to a `Map` object.
`Map<String,String>`	`getElementFieldsMap()`
`List<ReferenceBase>`	`getElements()`
`XsdAbstractElement`	`getParent()`
`XsdParser`	`getParser()`
`abstract XsdAbstractElementVisitor`	`getVisitor()`	Obtains the visitor of a concrete `XsdAbstractElement` instance.
`Stream<XsdAbstractElement>`	`getXsdElements()`
`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`	`setFields(Map<String,String> elementFieldsMapParam)`	This method serves as a base to all `XsdAbstractElement` concrete instances which need to set their class specific fields.
`void`	`setParent(XsdAbstractElement parent)`
`private void`	`setParser(XsdParser parser)`
`void`	`validateSchemaRules()`	Runs verifications on each concrete element to ensure that the XSD schema rules are verified.
`(package private) static ReferenceBase`	`xsdParseSkeleton(Node node, XsdAbstractElement element)`	The base code for parsing any `XsdAbstractElement`.
`(package private) static String`	`xsdRawContentParse(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
  - elementFieldsMap
```
protected Map<String,String> elementFieldsMap
```
    A Map object containing the keys/values of the attributes that belong to the concrete element instance.
  - ATTRIBUTE_FORM_DEFAULT
```
static final String ATTRIBUTE_FORM_DEFAULT
```
    See Also:
    
    Constant Field Values
  - ELEMENT_FORM_DEFAULT
```
static final String ELEMENT_FORM_DEFAULT
```
    See Also:
    
    Constant Field Values
  - BLOCK_DEFAULT
```
static final String BLOCK_DEFAULT
```
    See Also:
    
    Constant Field Values
  - FINAL_DEFAULT
```
static final String FINAL_DEFAULT
```
    See Also:
    
    Constant Field Values
  - TARGET_NAMESPACE
```
static final String TARGET_NAMESPACE
```
    See Also:
    
    Constant Field Values
  - VERSION
```
static final String VERSION
```
    See Also:
    
    Constant Field Values
  - XMLNS
```
static final String XMLNS
```
    See Also:
    
    Constant Field Values
  - ID_TAG
```
static final String ID_TAG
```
    See Also:
    
    Constant Field Values
  - NAME_TAG
```
public static final String NAME_TAG
```
    See Also:
    
    Constant Field Values
  - ABSTRACT_TAG
```
static final String ABSTRACT_TAG
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ELEMENT_TAG
```
static final String DEFAULT_ELEMENT_TAG
```
    See Also:
    
    Constant Field Values
  - FIXED_TAG
```
protected static final String FIXED_TAG
```
    See Also:
    
    Constant Field Values
  - TYPE_TAG
```
static final String TYPE_TAG
```
    See Also:
    
    Constant Field Values
  - MIXED_TAG
```
static final String MIXED_TAG
```
    See Also:
    
    Constant Field Values
  - BLOCK_TAG
```
static final String BLOCK_TAG
```
    See Also:
    
    Constant Field Values
  - FINAL_TAG
```
static final String FINAL_TAG
```
    See Also:
    
    Constant Field Values
  - USE_TAG
```
static final String USE_TAG
```
    See Also:
    
    Constant Field Values
  - SUBSTITUTION_GROUP_TAG
```
static final String SUBSTITUTION_GROUP_TAG
```
    See Also:
    
    Constant Field Values
  - DEFAULT_TAG
```
static final String DEFAULT_TAG
```
    See Also:
    
    Constant Field Values
  - FORM_TAG
```
static final String FORM_TAG
```
    See Also:
    
    Constant Field Values
  - NILLABLE_TAG
```
static final String NILLABLE_TAG
```
    See Also:
    
    Constant Field Values
  - MIN_OCCURS_TAG
```
static final String MIN_OCCURS_TAG
```
    See Also:
    
    Constant Field Values
  - MAX_OCCURS_TAG
```
static final String MAX_OCCURS_TAG
```
    See Also:
    
    Constant Field Values
  - ITEM_TYPE_TAG
```
static final String ITEM_TYPE_TAG
```
    See Also:
    
    Constant Field Values
  - BASE_TAG
```
static final String BASE_TAG
```
    See Also:
    
    Constant Field Values
  - SOURCE_TAG
```
static final String SOURCE_TAG
```
    See Also:
    
    Constant Field Values
  - XML_LANG_TAG
```
static final String XML_LANG_TAG
```
    See Also:
    
    Constant Field Values
  - MEMBER_TYPES_TAG
```
static final String MEMBER_TYPES_TAG
```
    See Also:
    
    Constant Field Values
  - SCHEMA_LOCATION
```
static final String SCHEMA_LOCATION
```
    See Also:
    
    Constant Field Values
  - NAMESPACE
```
static final String NAMESPACE
```
    See Also:
    
    Constant Field Values
  - REF_TAG
```
public static final String REF_TAG
```
    See Also:
    
    Constant Field Values
  - VALUE_TAG
```
protected static final String VALUE_TAG
```
    See Also:
    
    Constant Field Values
  - parent
```
XsdAbstractElement parent
```
    The instance which contains the present element.
  - parser
```
XsdParser parser
```
    The XsdParser instance that parsed this element.
- Constructor Detail
  - XsdAbstractElement
```
protected XsdAbstractElement(@NotNull
                             XsdParser parser,
                             @NotNull
                             Map<String,String> elementFieldsMapParam)
```
- Method Detail
  - setFields
```
public void setFields(@NotNull
                      Map<String,String> elementFieldsMapParam)
```
    This method serves as a base to all XsdAbstractElement concrete instances which need to set their class specific fields.
    
    Parameters:
    
    elementFieldsMapParam - The Map object containing the information previously contained in the Node object.
  - getElementFieldsMap
```
public Map<String,String> getElementFieldsMap()
```
  - getVisitor
```
public abstract 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 List<ReferenceBase> getElements()
```
  - getXsdElements
```
public Stream<XsdAbstractElement> getXsdElements()
```
    Returns:
    
    All the ConcreteElement objects present in the concrete implementation of the XsdAbstractElement class. It doesn't return the UnsolvedReference objects.
  - xsdParseSkeleton
```
static ReferenceBase xsdParseSkeleton(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.
  - setParser
```
private void setParser(XsdParser parser)
```
  - getParser
```
public XsdParser getParser()
```
  - convertNodeMap
```
protected static Map<String,String> convertNodeMap(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.
  - getParent
```
public XsdAbstractElement getParent()
```
    Returns:
    
    The parent of the current XsdAbstractElement object.
  - setParent
```
public void setParent(XsdAbstractElement parent)
```
  - xsdRawContentParse
```
static String xsdRawContentParse(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.

Class XsdAbstractElement

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

elementFieldsMap

ATTRIBUTE_FORM_DEFAULT

ELEMENT_FORM_DEFAULT

BLOCK_DEFAULT

FINAL_DEFAULT

TARGET_NAMESPACE

VERSION

XMLNS

ID_TAG

NAME_TAG

ABSTRACT_TAG

DEFAULT_ELEMENT_TAG

FIXED_TAG

TYPE_TAG

MIXED_TAG

BLOCK_TAG

FINAL_TAG

USE_TAG

SUBSTITUTION_GROUP_TAG

DEFAULT_TAG

FORM_TAG

NILLABLE_TAG

MIN_OCCURS_TAG

MAX_OCCURS_TAG

ITEM_TYPE_TAG

BASE_TAG

SOURCE_TAG

XML_LANG_TAG

MEMBER_TYPES_TAG

SCHEMA_LOCATION

NAMESPACE

REF_TAG

VALUE_TAG

parent

parser

Constructor Detail

XsdAbstractElement

Method Detail

setFields

getElementFieldsMap

getVisitor

validateSchemaRules

accept

getElements

getXsdElements

xsdParseSkeleton

setParser

getParser

convertNodeMap

replaceUnsolvedElements

getParent

setParent

xsdRawContentParse