File Doc Category Size Date Package
XSSimpleTypeDefinition.java API Doc Apache Xerces 3.0.1 7939 Fri Sep 14 20:33:52 BST 2007 org.apache.xerces.xs

XSSimpleTypeDefinition

public interface XSSimpleTypeDefinition implements XSTypeDefinition

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.

Fields Summary
public static final short
VARIETY_ABSENT
The variety is absent for the anySimpleType definition.
public static final short
VARIETY_ATOMIC
Atomic type.
public static final short
VARIETY_LIST
List type.
public static final short
VARIETY_UNION
Union type.
public static final short
FACET_NONE
No facets defined.
public static final short
FACET_LENGTH
4.3.1 Length
public static final short
FACET_MINLENGTH
4.3.2 minLength.
public static final short
FACET_MAXLENGTH
4.3.3 maxLength.
public static final short
FACET_PATTERN
4.3.4 pattern.
public static final short
FACET_WHITESPACE
4.3.5 whitespace.
public static final short
FACET_MAXINCLUSIVE
4.3.7 maxInclusive.
public static final short
FACET_MAXEXCLUSIVE
4.3.9 maxExclusive.
public static final short
FACET_MINEXCLUSIVE
4.3.9 minExclusive.
public static final short
FACET_MININCLUSIVE
4.3.10 minInclusive.
public static final short
FACET_TOTALDIGITS
4.3.11 totalDigits .
public static final short
FACET_FRACTIONDIGITS
4.3.12 fractionDigits.
public static final short
FACET_ENUMERATION
4.3.5 enumeration.
public static final short
ORDERED_FALSE
A constant defined for the 'ordered' fundamental facet: not ordered.
public static final short
ORDERED_PARTIAL
A constant defined for the 'ordered' fundamental facet: partially ordered.
public static final short
ORDERED_TOTAL
A constant defined for the 'ordered' fundamental facet: total ordered.
Constructors Summary
Methods Summary
public XSObjectList getAnnotations()
A sequence of [annotations] or an empty XSObjectList.
public boolean getBounded()
Fundamental Facet: bounded.
public 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 short getDefinedFacets()
[facets]: all facets defined on this type. The value is a bit combination of FACET_XXX constants of all defined facets.
public 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 boolean getFinite()
Fundamental Facet: cardinality.
public short getFixedFacets()
[facets]: all defined facets for this type which are fixed.
public org.apache.xerces.xs.XSSimpleTypeDefinition getItemType()
If variety is list the item type definition (an atomic or union simple type definition) is available, otherwise null.
public StringList getLexicalEnumeration()
A list of enumeration values if it exists, otherwise an empty StringList.
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.
param
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.
return
A value of the facet specified in facetName for this simple type definition or null.
public StringList getLexicalPattern()
A list of pattern values if it exists, otherwise an empty StringList.
public 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 XSObjectList getMultiValueFacets()
A list of enumeration and pattern constraining facets if it exists, otherwise an empty XSObjectList.
public boolean getNumeric()
Fundamental Facet: numeric.
public short getOrdered()
Fundamental Facet: ordered.
public org.apache.xerces.xs.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 short getVariety()
[variety]: one of {atomic, list, union} or absent.
public boolean isDefinedFacet(short facetName)
Convenience method. [Facets]: check whether a facet is defined on this type.
param
facetName The name of the facet.
return
True if the facet is defined, false otherwise.
public boolean isFixedFacet(short facetName)
Convenience method. [Facets]: check whether a facet is defined and fixed on this type.
param
facetName The name of the facet.
return
True if the facet is fixed, false otherwise.