net.sourceforge.nrl.parser.model.xsd
Interface IXSDUserData

All Known Implementing Classes:
XSDModelLoader

public interface IXSDUserData

Additional user data keys that will be attached to the model elements, packages or attributes by the XSD loader. See the constants below for definitions. See IModelElement.getUserData(String) for information on user data.

Author:
Christian Nentwich

Field Summary
static String ATTRIBUTE_KIND
          Will be set on elements or attributes to show of which kind they are.
static String CONTAINING_TYPE
          If a model element is directly contained in another one, this will be set.
static String JAXB_CATCH_ALL
          Where duplicate element names are present in a type, JAXB attaches a "catch-all" list instead of actual named fields.
static String JAXB_FLATTENED_PROPERTY
          Where elements are involved in repeating sequence or choices, for example (A,B,C)*, JAXB generates a flatten list, e.g.
static String MODEL_FILE_LOCATION
          An attribute for XSDPackage elements: contains the location (a URL) that a model was loaded from.
static String NAMESPACE
          Will be set on elements or attributes that are in a namespace - the namespace URI.
static String RENAMED_AMBIGUOUS_ATTRIBUTE
          A boolean property that is set to true for NRL attributes that had to be renamed.
static String SUBSTITUTABLE
          On elements that define a substitution group, i.e.
static String SUBSTITUTION_FOR
          On elements that participate in a substitution group, this will point to the "root" element that this is a substitution for.
static String XSD_ATTRIBUTE_KIND
           
static String XSD_COMPLEX_TYPE_KIND
           
static String XSD_ELEMENT_KIND
           
static String XSD_GLOBAL_ELEMENT
          If present and set to true, the type is declared as a global element.
static String XSD_PATH
          An XPath to an IAttribute or IModelElement inside an XML Schema.
static String XSD_SIMPLE_TYPE_KIND
           
static String XSD_TYPE_KIND
          Will be set on elements or attributes to show of which kind they are.
 

Field Detail

CONTAINING_TYPE

static final String CONTAINING_TYPE
If a model element is directly contained in another one, this will be set. The value of the data will be an object of type IModelElement.

This value is set on all anonymous subtypes, which according to JAXB modeling conventions are contained within the types in which they are used.

See Also:
Constant Field Values

MODEL_FILE_LOCATION

static final String MODEL_FILE_LOCATION
An attribute for XSDPackage elements: contains the location (a URL) that a model was loaded from.

See Also:
Constant Field Values

NAMESPACE

static final String NAMESPACE
Will be set on elements or attributes that are in a namespace - the namespace URI. The value is a string.

See Also:
Constant Field Values

SUBSTITUTABLE

static final String SUBSTITUTABLE
On elements that define a substitution group, i.e. represent the element that may be substituted, this will be Boolean(true). On the substituting elements SUBSTITUTION_FOR will be set.

See Also:
Constant Field Values

SUBSTITUTION_FOR

static final String SUBSTITUTION_FOR
On elements that participate in a substitution group, this will point to the "root" element that this is a substitution for. The value will be an XSDAttribute.

See Also:
Constant Field Values

ATTRIBUTE_KIND

static final String ATTRIBUTE_KIND
Will be set on elements or attributes to show of which kind they are.

See Also:
Constant Field Values

XSD_ELEMENT_KIND

static final String XSD_ELEMENT_KIND
See Also:
Constant Field Values

XSD_ATTRIBUTE_KIND

static final String XSD_ATTRIBUTE_KIND
See Also:
Constant Field Values

XSD_TYPE_KIND

static final String XSD_TYPE_KIND
Will be set on elements or attributes to show of which kind they are.

See Also:
Constant Field Values

XSD_SIMPLE_TYPE_KIND

static final String XSD_SIMPLE_TYPE_KIND
See Also:
Constant Field Values

XSD_COMPLEX_TYPE_KIND

static final String XSD_COMPLEX_TYPE_KIND
See Also:
Constant Field Values

XSD_GLOBAL_ELEMENT

static final String XSD_GLOBAL_ELEMENT
If present and set to true, the type is declared as a global element.

See Also:
Constant Field Values

XSD_PATH

static final String XSD_PATH
An XPath to an IAttribute or IModelElement inside an XML Schema. This is attached to elements if they were renamed by the model loader, i.e. RENAMED_AMBIGUOUS_ATTRIBUTE is also true.

See Also:
Constant Field Values

JAXB_FLATTENED_PROPERTY

static final String JAXB_FLATTENED_PROPERTY
Where elements are involved in repeating sequence or choices, for example (A,B,C)*, JAXB generates a flatten list, e.g. List<Object> getAAndBAndC. This property is attached to attributes to identify the name of the flattened method the attribute will be stored in at runtime.

See Also:
Constant Field Values

JAXB_CATCH_ALL

static final String JAXB_CATCH_ALL
Where duplicate element names are present in a type, JAXB attaches a "catch-all" list instead of actual named fields. This attribute is attached to identify the name of the catch-all list.

See Also:
Constant Field Values

RENAMED_AMBIGUOUS_ATTRIBUTE

static final String RENAMED_AMBIGUOUS_ATTRIBUTE
A boolean property that is set to true for NRL attributes that had to be renamed. These cases can happen in schemas where two elements / attributes of the same name are present in a complex type. See the duplicate elements test in the schema package for more.

See Also:
Constant Field Values


Copyright © 2006-2013. All Rights Reserved.