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

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

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

See Also:

xsd:element description and usage at w3c

Field Summary

Fields
Modifier and Type	Field	Description
`private boolean`	`abstractObj`	Specifies whether the element can be used in an instance document.
`private BlockEnum`	`block`	Prevents an element with a specified type of derivation from being used in place of this `XsdElement` element.
`private ReferenceBase`	`complexType`	The `XsdComplexType` instance wrapped in a `ReferenceBase` object.
`private String`	`defaultObj`	Specifies a default value for the element.
`private FinalEnum`	`finalObj`	Prevents other elements to derive depending on its value.
`private String`	`fixed`	Specifies a fixed value for the element.
`private FormEnum`	`form`	Specifies if the current `XsdElement` attribute is "qualified" or "unqualified".
`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 boolean`	`nillable`	Specifies if the this `XsdElement` support a null value.
`private ReferenceBase`	`simpleType`	The `XsdSimpleType` instance wrapped in a `ReferenceBase` object.
`private String`	`substitutionGroup`	Specifies the name of an element that can be substituted with this element.
`private ReferenceBase`	`type`	The type of the current element.
`private XsdElementVisitor`	`visitor`	`XsdElementVisitor` which restricts its children to `XsdComplexType` and `XsdSimpleType` instances.
`static String`	`XS_TAG`
`static String`	`XSD_TAG`
`private static String`	`xsdElementIsXsdSchema`

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
`XsdElement(XsdParser parser, Map<String,String> elementFieldsMapParam)`
`XsdElement(XsdAbstractElement parent, XsdParser parser, Map<String,String> elementFieldsMapParam)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`accept(XsdAbstractElementVisitor visitorParam)`	Base method for all accept methods.
`XsdElement`	`clone(Map<String,String> placeHolderAttributes)`	Performs a copy of the current object for replacing purposes.
`String`	`getBlock()`
`String`	`getFinal()`
`String`	`getForm()`
`String`	`getMaxOccurs()`
`Integer`	`getMinOccurs()`
`String`	`getType()`
`XsdElementVisitor`	`getVisitor()`	Obtains the visitor of a concrete `XsdAbstractElement` instance.
`XsdComplexType`	`getXsdComplexType()`
`XsdSimpleType`	`getXsdSimpleType()`
`private XsdComplexType`	`getXsdType()`
`boolean`	`isAbstractObj()`
`boolean`	`isNillable()`
`static ReferenceBase`	`parse(XsdParser parser, Node node)`
`void`	`replaceUnsolvedElements(NamedConcreteElement element)`	This method aims to replace the previously created `UnsolvedReference` in case that the type of the current `XsdElement` instance is not a built-in type.
`private void`	`rule2()`	Asserts if the current object is a direct child of the top level XsdSchema element and doesn't have a name, which isn't allowed, throwing an exception in that case.
`private void`	`rule3()`	Asserts if the current object has a ref attribute while being a direct child of the top level XsdSchema element, which isn't allowed, throwing an exception in that case.
`private void`	`rule4()`	Asserts if the current object isn't a direct child of the top level XsdSchema and has a value for the substitutionGroup, which isn't allowed, throwing an exception in that case.
`private void`	`rule5()`
`private void`	`rule6()`
`private void`	`rule7()`	Asserts if the current object has a form attribute while being a direct child of the top level XsdSchema element, which isn't allowed, throwing an exception in that case.
`void`	`setComplexType(ReferenceBase complexType)`
`void`	`setFields(Map<String,String> elementFieldsMapParam)`	Sets all the fields of the `XsdElement` instance.
`void`	`setSimpleType(ReferenceBase simpleType)`
`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, getElements, 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 XsdElementVisitor visitor
```
    XsdElementVisitor which restricts its children to XsdComplexType and XsdSimpleType instances. Can also have XsdAnnotation as children as per inheritance of XsdAnnotatedElementsVisitor.
  - complexType
```
private ReferenceBase complexType
```
    The XsdComplexType instance wrapped in a ReferenceBase object.
  - simpleType
```
private ReferenceBase simpleType
```
    The XsdSimpleType instance wrapped in a ReferenceBase object.
  - type
```
private ReferenceBase type
```
    The type of the current element. Either specified a built in data type or is a reference to a existent XsdComplexType or a XsdSimpleType instances.
  - substitutionGroup
```
private String substitutionGroup
```
    Specifies the name of an element that can be substituted with this element. Only should be present if this XsdElement is a top level element, i.e. his parent is a XsdSchema element.
  - defaultObj
```
private String defaultObj
```
    Specifies a default value for the element. It's only available if the type contents are text only type defined by a simpleType.
  - fixed
```
private String fixed
```
    Specifies a fixed value for the element. It's only available if the type contents are text only type defined by a simpleType.
  - form
```
private FormEnum form
```
    Specifies if the current XsdElement attribute is "qualified" or "unqualified".
  - nillable
```
private boolean nillable
```
    Specifies if the this XsdElement support a null value.
  - abstractObj
```
private boolean abstractObj
```
    Specifies whether the element can be used in an instance document.
  - block
```
private BlockEnum block
```
    Prevents an element with a specified type of derivation from being used in place of this XsdElement element. Possible values are: extension - prevents elements derived by extension; restriction - prevents elements derived by restriction; substitution - prevents elements derived by substitution; #all - all of the above.
  - finalObj
```
private FinalEnum finalObj
```
    Prevents other elements to derive depending on its value. This attribute cannot be present unless this XsdElement is a top level element, i.e. his parent is a XsdSchema element. extension - prevents elements derived by extension; restriction - prevents elements derived by restriction; #all - all of the above.
  - 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.
  - xsdElementIsXsdSchema
```
private static String xsdElementIsXsdSchema
```
- Constructor Detail
  - XsdElement
```
public XsdElement(@NotNull
                  XsdParser parser,
                  @NotNull
                  Map<String,String> elementFieldsMapParam)
```
  - XsdElement
```
public XsdElement(XsdAbstractElement parent,
                  @NotNull
                  XsdParser parser,
                  @NotNull
                  Map<String,String> elementFieldsMapParam)
```
- Method Detail
  - setFields
```
public void setFields(@NotNull
                      Map<String,String> elementFieldsMapParam)
```
    Sets all the fields of the XsdElement instance. Applies default values whenever they exist. The type is treated in a special way. His value is received as a String, which is inspected and if the value is a built-in type we create a XsdComplexType to reflect that built-in type. If the value is a declared XsdSimpleType or XsdComplexType we add it as a UnsolvedReference to be resolved later in the parsing process.
    
    Overrides:
    
    setFields in class XsdNamedElements
    
    Parameters:
    
    elementFieldsMapParam - The Map object that contains the information previously present in 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
  - rule7
```
private void rule7()
```
    Asserts if the current object has a form attribute while being a direct child of the top level XsdSchema element, which isn't allowed, throwing an exception in that case.
  - rule6
```
private void rule6()
```
  - rule5
```
private void rule5()
```
  - rule4
```
private void rule4()
```
    Asserts if the current object isn't a direct child of the top level XsdSchema and has a value for the substitutionGroup, which isn't allowed, throwing an exception in that case.
  - rule3
```
private void rule3()
```
    Asserts if the current object has a ref attribute while being a direct child of the top level XsdSchema element, which isn't allowed, throwing an exception in that case.
  - rule2
```
private void rule2()
```
    Asserts if the current object is a direct child of the top level XsdSchema element and doesn't have a name, 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 XsdElementVisitor 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.
  - clone
```
public XsdElement 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)
```
    This method aims to replace the previously created UnsolvedReference in case that the type of the current XsdElement instance is not a built-in type.
    
    Overrides:
    
    replaceUnsolvedElements in class XsdAbstractElement
    
    Parameters:
    
    element - A concrete element with a name that will replace the UnsolvedReference object created in the setFields(Map) method. The UnsolvedReference is only replaced if there is a match between the UnsolvedReference.ref and the NamedConcreteElement.name.
  - getXsdComplexType
```
public XsdComplexType getXsdComplexType()
```
  - getXsdSimpleType
```
public XsdSimpleType getXsdSimpleType()
```
  - getXsdType
```
private XsdComplexType getXsdType()
```
  - parse
```
public static ReferenceBase parse(@NotNull
                                  XsdParser parser,
                                  Node node)
```
  - getFinal
```
public String getFinal()
```
  - isNillable
```
public boolean isNillable()
```
  - getMinOccurs
```
public Integer getMinOccurs()
```
  - getMaxOccurs
```
public String getMaxOccurs()
```
  - isAbstractObj
```
public boolean isAbstractObj()
```
  - setComplexType
```
public void setComplexType(ReferenceBase complexType)
```
  - setSimpleType
```
public void setSimpleType(ReferenceBase simpleType)
```
  - getBlock
```
public String getBlock()
```
  - getForm
```
public String getForm()
```
  - getType
```
public String getType()
```

Class XsdElement

Field Summary

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

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

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

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

Field Detail

XSD_TAG

XS_TAG

visitor

complexType

simpleType

type

substitutionGroup

defaultObj

fixed

form

nillable

abstractObj

block

finalObj

minOccurs

maxOccurs

xsdElementIsXsdSchema

Constructor Detail

XsdElement

XsdElement

Method Detail

setFields

validateSchemaRules

rule7

rule6

rule5

rule4

rule3

rule2

accept

getVisitor

clone

replaceUnsolvedElements

getXsdComplexType

getXsdSimpleType

getXsdType

parse

getFinal

isNillable

getMinOccurs

getMaxOccurs

isAbstractObj

setComplexType

setSimpleType

getBlock

getForm

getType