Package org.xmlet.xsdparser.xsdelements

Class XsdAttribute

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

public class XsdAttribute
extends XsdNamedElements

A class representing the xsd:attribute element. It can have a ref attribute and therefore extends from XsdNamedElements, which serves as a base to every element type that can have a ref attribute. For more information check XsdNamedElements.

See Also:

xsd:attribute element description and usage at w3c

Field Summary

Fields

Modifier and Type	Field	Description
private String	defaultElement	A default value for the current XsdAttribute instance.
private String	fixed	Specifies a fixed value for the current XsdAttribute instance.
private FormEnum	form	Specifies if the current XsdAttribute attribute is "qualified" or "unqualified".
private ReferenceBase	simpleType	A XsdSimpleType instance wrapped in a ReferenceBase object which indicate any restrictions that may be present in the current XsdAttribute instance.
private String	type	Specifies either a built-in data type for the current XsdAttribute instance or serves as a reference to a XsdSimpleType instance.
private UsageEnum	use	Specifies how this XsdAttribute should be used.
private XsdAttributeVisitor	visitor	XsdAttributeVisitor instance which restricts the its children to XsdSimpleType.
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	XsdAttribute(XsdParser parser, Map<String,String> elementFieldsMapParam)
private	XsdAttribute(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.
XsdAttribute	clone(Map<String,String> placeHolderAttributes)	Performs a copy of the current object for replacing purposes.
List<XsdRestriction>	getAllRestrictions()
String	getFixed()
String	getForm()
private static String	getFormDefaultValue(XsdAbstractElement parent)
String	getType()
String	getUse()
XsdAttributeVisitor	getVisitor()	Obtains the visitor of a concrete XsdAbstractElement instance.
XsdSimpleType	getXsdSimpleType()
static ReferenceBase	parse(XsdParser parser, Node node)
void	replaceUnsolvedElements(NamedConcreteElement elementWrapper)	Receives a NamedConcreteElement that should be the one requested earlier
private void	rule2()	Asserts if the current object has the fixed and default attributes at the same time, which isn't allowed, throwing an exception in that case.
private void	rule3()	Asserts if the current object has a ref attribute at the same time as either a simpleType as children, a form attribute or a type attribute.
void	setFields(Map<String,String> elementFieldsMapParam)	Sets all the fields of the XsdAttribute 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 XsdAttributeVisitor visitor

XsdAttributeVisitor instance which restricts the its children to XsdSimpleType. Can also have xsd:annotation as children as per inheritance of XsdAnnotatedElementsVisitor.

simpleType

private ReferenceBase simpleType

A XsdSimpleType instance wrapped in a ReferenceBase object which indicate any restrictions that may be present in the current XsdAttribute instance.

defaultElement

private String defaultElement

A default value for the current XsdAttribute instance. This value and fixed shouldn't be present at the same time.

fixed

private String fixed

Specifies a fixed value for the current XsdAttribute instance. This value and defaultElement shouldn't be present at the same time.

type

private String type

Specifies either a built-in data type for the current XsdAttribute instance or serves as a reference to a XsdSimpleType instance. In the case of being used as a reference to a XsdSimpleType instance its value is used to create an UnsolvedReference using its value as ref to be resolved later in the parsing process.

form

private FormEnum form

Specifies if the current XsdAttribute attribute is "qualified" or "unqualified".

use

private UsageEnum use

Specifies how this XsdAttribute should be used. The possible values are: required, prohibited, optional.

Constructor Detail

XsdAttribute

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

XsdAttribute

private XsdAttribute(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 XsdAttribute instance. Most values don't have default values except the use field. Regarding the type field we check if the value present is a built-in type, if not we create an UnsolvedReference object to be resolved at a later time in the parsing process.

Overrides:

setFields in class XsdNamedElements

Parameters:

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

getFormDefaultValue

private static String getFormDefaultValue(XsdAbstractElement parent)

validateSchemaRules

public void validateSchemaRules()

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

Overrides:

validateSchemaRules in class XsdNamedElements

rule3

private void rule3()

Asserts if the current object has a ref attribute at the same time as either a simpleType as children, a form attribute or a type attribute. Throws an exception in that case.

rule2

private void rule2()

Asserts if the current object has the fixed and default attributes at the same time, 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 XsdAttributeVisitor 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 XsdAttribute 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 elementWrapper)

Receives a NamedConcreteElement that should be the one requested earlier. * In the setFields(java.util.Map<java.lang.String, java.lang.String>) method: this.simpleType = new UnsolvedReference(type, placeHolder); XsdParser.getInstance().addUnsolvedReference((UnsolvedReference) this.simpleType); This implies that the object being received is the object that is being referred with the type String.

Overrides:

replaceUnsolvedElements in class XsdAbstractElement

Parameters:

elementWrapper - The object that should be wrapping the requested XsdSimpleType object.

setSimpleType

public void setSimpleType(ReferenceBase simpleType)

getXsdSimpleType

public XsdSimpleType getXsdSimpleType()

getType

public String getType()

getUse

public String getUse()

getForm

public String getForm()

getFixed

public String getFixed()

getAllRestrictions

public List<XsdRestriction> getAllRestrictions()

parse

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