public interface

XSSimpleTypeDefinition

implements XSTypeDefinition
org.apache.xerces.xs.XSSimpleTypeDefinition
Known Indirect Subclasses

Class Overview

This interface represents the Simple Type Definition schema component. This interface provides several query operations for facet components. Users can either retrieve the defined facets as XML Schema components, using the facets and the multiValueFacets attributes; or users can separately query a facet's properties using methods such as getLexicalFacetValue, isFixedFacet, etc.

Summary

Constants
short FACET_ENUMERATION 4.3.5 enumeration.
short FACET_FRACTIONDIGITS 4.3.12 fractionDigits.
short FACET_LENGTH 4.3.1 Length
short FACET_MAXEXCLUSIVE 4.3.9 maxExclusive.
short FACET_MAXINCLUSIVE 4.3.7 maxInclusive.
short FACET_MAXLENGTH 4.3.3 maxLength.
short FACET_MINEXCLUSIVE 4.3.9 minExclusive.
short FACET_MININCLUSIVE 4.3.10 minInclusive.
short FACET_MINLENGTH 4.3.2 minLength.
short FACET_NONE No facets defined.
short FACET_PATTERN 4.3.4 pattern.
short FACET_TOTALDIGITS 4.3.11 totalDigits .
short FACET_WHITESPACE 4.3.5 whitespace.
short ORDERED_FALSE A constant defined for the 'ordered' fundamental facet: not ordered.
short ORDERED_PARTIAL A constant defined for the 'ordered' fundamental facet: partially ordered.
short ORDERED_TOTAL A constant defined for the 'ordered' fundamental facet: total ordered.
short VARIETY_ABSENT The variety is absent for the anySimpleType definition.
short VARIETY_ATOMIC Atomic type.
short VARIETY_LIST List type.
short VARIETY_UNION Union type.
[Expand]
Inherited Constants
From interface org.apache.xerces.xs.XSTypeDefinition
Public Methods
abstract XSObjectList getAnnotations()
A sequence of [annotations] or an empty XSObjectList.
abstract boolean getBounded()
Fundamental Facet: bounded.
abstract short getBuiltInKind()
Returns the closest built-in type category this type represents or derived from.
abstract short getDefinedFacets()
[facets]: all facets defined on this type.
abstract XSObjectList getFacets()
A list of constraining facets if it exists, otherwise an empty XSObjectList.
abstract boolean getFinite()
Fundamental Facet: cardinality.
abstract short getFixedFacets()
[facets]: all defined facets for this type which are fixed.
abstract XSSimpleTypeDefinition getItemType()
If variety is list the item type definition (an atomic or union simple type definition) is available, otherwise null.
abstract StringList getLexicalEnumeration()
A list of enumeration values if it exists, otherwise an empty StringList.
abstract String getLexicalFacetValue(short facetName)
Convenience method.
abstract StringList getLexicalPattern()
A list of pattern values if it exists, otherwise an empty StringList.
abstract XSObjectList getMemberTypes()
If variety is union the list of member type definitions (a non-empty sequence of simple type definitions) is available, otherwise an empty XSObjectList.
abstract XSObjectList getMultiValueFacets()
A list of enumeration and pattern constraining facets if it exists, otherwise an empty XSObjectList.
abstract boolean getNumeric()
Fundamental Facet: numeric.
abstract short getOrdered()
Fundamental Facet: ordered.
abstract XSSimpleTypeDefinition getPrimitiveType()
If variety is atomic the primitive type definition (a built-in primitive datatype definition or the simple ur-type definition) is available, otherwise null.
abstract short getVariety()
[variety]: one of {atomic, list, union} or absent.
abstract boolean isDefinedFacet(short facetName)
Convenience method.
abstract boolean isFixedFacet(short facetName)
Convenience method.
[Expand]
Inherited Methods
From interface org.apache.xerces.xs.XSObject
From interface org.apache.xerces.xs.XSTypeDefinition

Constants

public static final short FACET_ENUMERATION

4.3.5 enumeration.

Constant Value: 2048 (0x00000800)

public static final short FACET_FRACTIONDIGITS

4.3.12 fractionDigits.

Constant Value: 1024 (0x00000400)

public static final short FACET_LENGTH

4.3.1 Length

Constant Value: 1 (0x00000001)

public static final short FACET_MAXEXCLUSIVE

4.3.9 maxExclusive.

Constant Value: 64 (0x00000040)

public static final short FACET_MAXINCLUSIVE

4.3.7 maxInclusive.

Constant Value: 32 (0x00000020)

public static final short FACET_MAXLENGTH

4.3.3 maxLength.

Constant Value: 4 (0x00000004)

public static final short FACET_MINEXCLUSIVE

4.3.9 minExclusive.

Constant Value: 128 (0x00000080)

public static final short FACET_MININCLUSIVE

4.3.10 minInclusive.

Constant Value: 256 (0x00000100)

public static final short FACET_MINLENGTH

4.3.2 minLength.

Constant Value: 2 (0x00000002)

public static final short FACET_NONE

No facets defined.

Constant Value: 0 (0x00000000)

public static final short FACET_PATTERN

4.3.4 pattern.

Constant Value: 8 (0x00000008)

public static final short FACET_TOTALDIGITS

4.3.11 totalDigits .

Constant Value: 512 (0x00000200)

public static final short FACET_WHITESPACE

4.3.5 whitespace.

Constant Value: 16 (0x00000010)

public static final short ORDERED_FALSE

A constant defined for the 'ordered' fundamental facet: not ordered.

Constant Value: 0 (0x00000000)

public static final short ORDERED_PARTIAL

A constant defined for the 'ordered' fundamental facet: partially ordered.

Constant Value: 1 (0x00000001)

public static final short ORDERED_TOTAL

A constant defined for the 'ordered' fundamental facet: total ordered.

Constant Value: 2 (0x00000002)

public static final short VARIETY_ABSENT

The variety is absent for the anySimpleType definition.

Constant Value: 0 (0x00000000)

public static final short VARIETY_ATOMIC

Atomic type.

Constant Value: 1 (0x00000001)

public static final short VARIETY_LIST

List type.

Constant Value: 2 (0x00000002)

public static final short VARIETY_UNION

Union type.

Constant Value: 3 (0x00000003)

Public Methods

public abstract XSObjectList getAnnotations ()

A sequence of [annotations] or an empty XSObjectList.

public abstract boolean getBounded ()

Fundamental Facet: bounded.

public abstract short getBuiltInKind ()

Returns the closest built-in type category this type represents or derived from. For example, if this simple type is a built-in derived type integer the INTEGER_DV is returned.

public abstract short getDefinedFacets ()

[facets]: all facets defined on this type. The value is a bit combination of FACET_XXX constants of all defined facets.

public abstract XSObjectList getFacets ()

A list of constraining facets if it exists, otherwise an empty XSObjectList. Note: This method must not be used to retrieve values for enumeration and pattern facets.

public abstract boolean getFinite ()

Fundamental Facet: cardinality.

public abstract short getFixedFacets ()

[facets]: all defined facets for this type which are fixed.

public abstract XSSimpleTypeDefinition getItemType ()

If variety is list the item type definition (an atomic or union simple type definition) is available, otherwise null.

public abstract StringList getLexicalEnumeration ()

A list of enumeration values if it exists, otherwise an empty StringList.

public abstract String getLexicalFacetValue (short facetName)

Convenience method. Returns a value of a single constraining facet for this simple type definition. This method must not be used to retrieve values for enumeration and pattern facets.

Parameters
facetName The name of the facet, i.e. FACET_LENGTH, FACET_TOTALDIGITS. To retrieve the value for a pattern or an enumeration, see enumeration and pattern.
Returns
  • A value of the facet specified in facetName for this simple type definition or null.

public abstract StringList getLexicalPattern ()

A list of pattern values if it exists, otherwise an empty StringList.

public abstract XSObjectList getMemberTypes ()

If variety is union the list of member type definitions (a non-empty sequence of simple type definitions) is available, otherwise an empty XSObjectList.

public abstract XSObjectList getMultiValueFacets ()

A list of enumeration and pattern constraining facets if it exists, otherwise an empty XSObjectList.

public abstract boolean getNumeric ()

Fundamental Facet: numeric.

public abstract short getOrdered ()

Fundamental Facet: ordered.

public abstract XSSimpleTypeDefinition getPrimitiveType ()

If variety is atomic the primitive type definition (a built-in primitive datatype definition or the simple ur-type definition) is available, otherwise null.

public abstract short getVariety ()

[variety]: one of {atomic, list, union} or absent.

public abstract boolean isDefinedFacet (short facetName)

Convenience method. [Facets]: check whether a facet is defined on this type.

Parameters
facetName The name of the facet.
Returns
  • True if the facet is defined, false otherwise.

public abstract boolean isFixedFacet (short facetName)

Convenience method. [Facets]: check whether a facet is defined and fixed on this type.

Parameters
facetName The name of the facet.
Returns
  • True if the facet is fixed, false otherwise.