org.apache.xerces.impl.xs.psvi
Interface XSSimpleTypeDefinition

All Superinterfaces:
XSObject, XSTypeDefinition
All Known Subinterfaces:
XSSimpleType
All Known Implementing Classes:
XSSimpleTypeDecl

public interface XSSimpleTypeDefinition
extends XSTypeDefinition

This interface represents the Simple Type Definition schema component. The interface may be updated or replaced.


Field Summary
static short FACET_ENUMERATION
          4.3.5 enumeration.
static short FACET_FRACTIONDIGITS
          4.3.12 fractionDigits.
static short FACET_LENGTH
          4.3.1 Length
static short FACET_MAXEXCLUSIVE
          4.3.9 maxExclusive.
static short FACET_MAXINCLUSIVE
          4.3.7 maxInclusive.
static short FACET_MAXLENGTH
          4.3.3 maxLength.
static short FACET_MINEXCLUSIVE
          4.3.9 minExclusive.
static short FACET_MININCLUSIVE
          4.3.10 minInclusive.
static short FACET_MINLENGTH
          4.3.2 minLength.
static short FACET_NONE
          No facets defined.
static short FACET_PATTERN
          4.3.4 pattern.
static short FACET_TOTALDIGITS
          4.3.11 totalDigits .
static short FACET_WHITESPACE
          4.3.5 whitespace.
static short ORDERED_FALSE
          A constant defined for the 'ordered' fundamental facet: Not ordered.
static short ORDERED_PARTIAL
          A constant defined for the 'ordered' fundamental facet: partially ordered.
static short ORDERED_TOTAL
          A constant defined for the 'ordered' fundamental facet: total ordered.
static short VARIETY_ABSENT
          The variety is absent for the anySimpleType definition.
static short VARIETY_ATOMIC
          Atomic type.
static short VARIETY_LIST
          List type.
static short VARIETY_UNION
          Union type.
 
Fields inherited from interface org.apache.xerces.impl.xs.psvi.XSTypeDefinition
COMPLEX_TYPE, SIMPLE_TYPE
 
Method Summary
 XSAnnotation getAnnotation()
          Optional.
 boolean getBounded()
          Fundamental Facet: bounded.
 short getDefinedFacets()
          [facets]: get all facets defined on this type.
 boolean getFinite()
          Fundamental Facet: cardinality.
 short getFixedFacets()
          [facets]: get all facets defined and fixed on this type.
 XSSimpleTypeDefinition getItemType()
          If variety is list the item type definition (an atomic or union simple type definition) is available, otherwise null.
 StringList getLexicalEnumeration()
          Returns a list of enumeration values.
 java.lang.String getLexicalFacetValue(short facetName)
          Convenience method.
 StringList getLexicalPattern()
          Returns a list of pattern values.
 XSObjectList getMemberTypes()
          If variety is union the list of member type definitions (a non-empty sequence of simple type definitions) is available, otherwise null.
 boolean getNumeric()
          Fundamental Facet: numeric.
 short getOrdered()
          Fundamental Facet: ordered
 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.
 short getVariety()
          [variety]: one of {atomic, list, union} or absent
 boolean isDefinedFacet(short facetName)
          Convenience method.
 boolean isFixedFacet(short facetName)
          Convenience method.
 
Methods inherited from interface org.apache.xerces.impl.xs.psvi.XSTypeDefinition
derivedFrom, derivedFromType, getAnonymous, getBaseType, getFinal, getTypeCategory, isFinal
 
Methods inherited from interface org.apache.xerces.impl.xs.psvi.XSObject
getName, getNamespace, getNamespaceItem, getType
 

Field Detail

VARIETY_ABSENT

public static final short VARIETY_ABSENT
The variety is absent for the anySimpleType definition.

See Also:
Constant Field Values

VARIETY_ATOMIC

public static final short VARIETY_ATOMIC
Atomic type.

See Also:
Constant Field Values

VARIETY_LIST

public static final short VARIETY_LIST
List type.

See Also:
Constant Field Values

VARIETY_UNION

public static final short VARIETY_UNION
Union type.

See Also:
Constant Field Values

FACET_NONE

public static final short FACET_NONE
No facets defined.

See Also:
Constant Field Values

FACET_LENGTH

public static final short FACET_LENGTH
4.3.1 Length

See Also:
Constant Field Values

FACET_MINLENGTH

public static final short FACET_MINLENGTH
4.3.2 minLength.

See Also:
Constant Field Values

FACET_MAXLENGTH

public static final short FACET_MAXLENGTH
4.3.3 maxLength.

See Also:
Constant Field Values

FACET_PATTERN

public static final short FACET_PATTERN
4.3.4 pattern.

See Also:
Constant Field Values

FACET_WHITESPACE

public static final short FACET_WHITESPACE
4.3.5 whitespace.

See Also:
Constant Field Values

FACET_MAXINCLUSIVE

public static final short FACET_MAXINCLUSIVE
4.3.7 maxInclusive.

See Also:
Constant Field Values

FACET_MAXEXCLUSIVE

public static final short FACET_MAXEXCLUSIVE
4.3.9 maxExclusive.

See Also:
Constant Field Values

FACET_MINEXCLUSIVE

public static final short FACET_MINEXCLUSIVE
4.3.9 minExclusive.

See Also:
Constant Field Values

FACET_MININCLUSIVE

public static final short FACET_MININCLUSIVE
4.3.10 minInclusive.

See Also:
Constant Field Values

FACET_TOTALDIGITS

public static final short FACET_TOTALDIGITS
4.3.11 totalDigits .

See Also:
Constant Field Values

FACET_FRACTIONDIGITS

public static final short FACET_FRACTIONDIGITS
4.3.12 fractionDigits.

See Also:
Constant Field Values

FACET_ENUMERATION

public static final short FACET_ENUMERATION
4.3.5 enumeration.

See Also:
Constant Field Values

ORDERED_FALSE

public static final short ORDERED_FALSE
A constant defined for the 'ordered' fundamental facet: Not ordered.

See Also:
Constant Field Values

ORDERED_PARTIAL

public static final short ORDERED_PARTIAL
A constant defined for the 'ordered' fundamental facet: partially ordered.

See Also:
Constant Field Values

ORDERED_TOTAL

public static final short ORDERED_TOTAL
A constant defined for the 'ordered' fundamental facet: total ordered.

See Also:
Constant Field Values
Method Detail

getVariety

public short getVariety()
[variety]: one of {atomic, list, union} or absent


getPrimitiveType

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


getItemType

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


getMemberTypes

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


getDefinedFacets

public short getDefinedFacets()
[facets]: get all facets defined on this type. The value is a bit combination of FACET_XXX constants of all defined facets.


isDefinedFacet

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

getFixedFacets

public short getFixedFacets()
[facets]: get all facets defined and fixed on this type.


isFixedFacet

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

getLexicalFacetValue

public java.lang.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 (see XSConstants).To retrieve value for pattern or enumeration, see enumeration and pattern.
Returns:
A value of the facet specified in facetName for this simple type definition or null.

getLexicalEnumeration

public StringList getLexicalEnumeration()
Returns a list of enumeration values.


getLexicalPattern

public StringList getLexicalPattern()
Returns a list of pattern values.


getOrdered

public short getOrdered()
Fundamental Facet: ordered


getFinite

public boolean getFinite()
Fundamental Facet: cardinality.


getBounded

public boolean getBounded()
Fundamental Facet: bounded.


getNumeric

public boolean getNumeric()
Fundamental Facet: numeric.


getAnnotation

public XSAnnotation getAnnotation()
Optional. An [annotation].



Copyright ? 1999-2003 Apache XML Project. All Rights Reserved.