Top Description Fields Methods
org.apache.xerces.xs

public Interface XSSimpleTypeDefinition

extends XSTypeDefinition
Known Direct Subinterfaces
org.apache.xerces.impl.dv.XSSimpleType
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.

Field Summary

Modifier and TypeField and Description
public static final short
FACET_ENUMERATION

4.3.5 enumeration.

public static final short
FACET_FRACTIONDIGITS

4.3.12 fractionDigits.

public static final short
FACET_LENGTH

4.3.1 Length

public static final short
FACET_MAXEXCLUSIVE

4.3.9 maxExclusive.

public static final short
FACET_MAXINCLUSIVE

4.3.7 maxInclusive.

public static final short
FACET_MAXLENGTH

4.3.3 maxLength.

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_MINLENGTH

4.3.2 minLength.

public static final short
FACET_NONE

No facets defined.

public static final short
FACET_PATTERN

4.3.4 pattern.

public static final short
FACET_TOTALDIGITS

4.3.11 totalDigits .

public static final short
FACET_WHITESPACE

4.3.5 whitespace.

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.

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.

Inherited from org.apache.xerces.xs.XSTypeDefinition:
COMPLEX_TYPESIMPLE_TYPE

Method Summary

Modifier and TypeMethod and Description
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.

public short
getDefinedFacets()

[facets]: all facets defined on this type.

public XSObject
getFacet(int facetType)

A constraining facet object.

public XSObjectList
getFacets()

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

public boolean
getFinite()

Fundamental Facet: cardinality.

public short
getFixedFacets()

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

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

Returns:

A value of the facet specified in facetName for this simple type definition or null.
getLexicalFacetValue(short
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.
facetName)

Convenience method.

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

Returns:

True if the facet is defined, false otherwise.
isDefinedFacet(short
The name of the facet.
facetName)

Convenience method.

public boolean

Returns:

True if the facet is fixed, false otherwise.
isFixedFacet(short
The name of the facet.
facetName)

Convenience method.

Inherited from org.apache.xerces.xs.XSTypeDefinition:
derivedFromderivedFromTypegetAnonymousgetBaseTypegetFinalgetTypeCategoryisFinal

Field Detail

FACET_ENUMERATIONback to summary
public static final short FACET_ENUMERATION

4.3.5 enumeration.

FACET_FRACTIONDIGITSback to summary
public static final short FACET_FRACTIONDIGITS

4.3.12 fractionDigits.

FACET_LENGTHback to summary
public static final short FACET_LENGTH

4.3.1 Length

FACET_MAXEXCLUSIVEback to summary
public static final short FACET_MAXEXCLUSIVE

4.3.9 maxExclusive.

FACET_MAXINCLUSIVEback to summary
public static final short FACET_MAXINCLUSIVE

4.3.7 maxInclusive.

FACET_MAXLENGTHback to summary
public static final short FACET_MAXLENGTH

4.3.3 maxLength.

FACET_MINEXCLUSIVEback to summary
public static final short FACET_MINEXCLUSIVE

4.3.9 minExclusive.

FACET_MININCLUSIVEback to summary
public static final short FACET_MININCLUSIVE

4.3.10 minInclusive.

FACET_MINLENGTHback to summary
public static final short FACET_MINLENGTH

4.3.2 minLength.

FACET_NONEback to summary
public static final short FACET_NONE

No facets defined.

FACET_PATTERNback to summary
public static final short FACET_PATTERN

4.3.4 pattern.

FACET_TOTALDIGITSback to summary
public static final short FACET_TOTALDIGITS

4.3.11 totalDigits .

FACET_WHITESPACEback to summary
public static final short FACET_WHITESPACE

4.3.5 whitespace.

ORDERED_FALSEback to summary
public static final short ORDERED_FALSE

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

ORDERED_PARTIALback to summary
public static final short ORDERED_PARTIAL

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

ORDERED_TOTALback to summary
public static final short ORDERED_TOTAL

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

VARIETY_ABSENTback to summary
public static final short VARIETY_ABSENT

The variety is absent for the anySimpleType definition.

VARIETY_ATOMICback to summary
public static final short VARIETY_ATOMIC

Atomic type.

VARIETY_LISTback to summary
public static final short VARIETY_LIST

List type.

VARIETY_UNIONback to summary
public static final short VARIETY_UNION

Union type.

Method Detail

getAnnotationsback to summary
public XSObjectList getAnnotations()

A sequence of [annotations] or an empty XSObjectList.

getBoundedback to summary
public boolean getBounded()

Fundamental Facet: bounded.

getBuiltInKindback to summary
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.

getDefinedFacetsback to summary
public short getDefinedFacets()

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

getFacetback to summary
public XSObject getFacet(int facetType)

A constraining facet object. An instance of XSFacet or XSMultiValueFacet.

getFacetsback to summary
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.

getFiniteback to summary
public boolean getFinite()

Fundamental Facet: cardinality.

getFixedFacetsback to summary
public short getFixedFacets()

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

getItemTypeback to summary
public XSSimpleTypeDefinition getItemType()

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

getLexicalEnumerationback to summary
public StringList getLexicalEnumeration()

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

getLexicalFacetValueback to summary
public 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:short

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:String

A value of the facet specified in facetName for this simple type definition or null.

getLexicalPatternback to summary
public StringList getLexicalPattern()

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

getMemberTypesback to summary
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.

getMultiValueFacetsback to summary
public XSObjectList getMultiValueFacets()

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

getNumericback to summary
public boolean getNumeric()

Fundamental Facet: numeric.

getOrderedback to summary
public short getOrdered()

Fundamental Facet: ordered.

getPrimitiveTypeback to summary
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.

getVarietyback to summary
public short getVariety()

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

isDefinedFacetback to summary
public boolean isDefinedFacet(short facetName)

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

Parameters
facetName:short

The name of the facet.

Returns:boolean

True if the facet is defined, false otherwise.

isFixedFacetback to summary
public boolean isFixedFacet(short facetName)

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

Parameters
facetName:short

The name of the facet.

Returns:boolean

True if the facet is fixed, false otherwise.