Package org.apache.xerces.xs
Interface XSSimpleTypeDefinition
-
- All Superinterfaces:
XSObject,XSTypeDefinition
public interface XSSimpleTypeDefinition extends 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 thefacetsand themultiValueFacetsattributes; or users can separately query a facet's properties using methods such asgetLexicalFacetValue,isFixedFacet, etc.
-
-
Field Summary
Fields Modifier and Type Field Description static shortFACET_ENUMERATION4.3.5 enumeration.static shortFACET_FRACTIONDIGITS4.3.12 fractionDigits.static shortFACET_LENGTH4.3.1 Lengthstatic shortFACET_MAXEXCLUSIVE4.3.9 maxExclusive.static shortFACET_MAXINCLUSIVE4.3.7 maxInclusive.static shortFACET_MAXLENGTH4.3.3 maxLength.static shortFACET_MINEXCLUSIVE4.3.9 minExclusive.static shortFACET_MININCLUSIVE4.3.10 minInclusive.static shortFACET_MINLENGTH4.3.2 minLength.static shortFACET_NONENo facets defined.static shortFACET_PATTERN4.3.4 pattern.static shortFACET_TOTALDIGITS4.3.11 totalDigits .static shortFACET_WHITESPACE4.3.5 whitespace.static shortORDERED_FALSEA constant defined for the 'ordered' fundamental facet: not ordered.static shortORDERED_PARTIALA constant defined for the 'ordered' fundamental facet: partially ordered.static shortORDERED_TOTALA constant defined for the 'ordered' fundamental facet: total ordered.static shortVARIETY_ABSENTThe variety is absent for the anySimpleType definition.static shortVARIETY_ATOMICAtomictype.static shortVARIETY_LISTListtype.static shortVARIETY_UNIONUniontype.-
Fields inherited from interface org.apache.xerces.xs.XSTypeDefinition
COMPLEX_TYPE, SIMPLE_TYPE
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description XSObjectListgetAnnotations()A sequence of [annotations] or an emptyXSObjectList.booleangetBounded()Fundamental Facet: bounded.shortgetBuiltInKind()Returns the closest built-in type category this type represents or derived from.shortgetDefinedFacets()[facets]: all facets defined on this type.XSObjectgetFacet(int facetType)A constraining facet object.XSObjectListgetFacets()A list of constraining facets if it exists, otherwise an emptyXSObjectList.booleangetFinite()Fundamental Facet: cardinality.shortgetFixedFacets()[facets]: all defined facets for this type which are fixed.XSSimpleTypeDefinitiongetItemType()If variety islistthe item type definition (an atomic or union simple type definition) is available, otherwisenull.StringListgetLexicalEnumeration()A list of enumeration values if it exists, otherwise an emptyStringList.java.lang.StringgetLexicalFacetValue(short facetName)Convenience method.StringListgetLexicalPattern()A list of pattern values if it exists, otherwise an emptyStringList.XSObjectListgetMemberTypes()If variety isunionthe list of member type definitions (a non-empty sequence of simple type definitions) is available, otherwise an emptyXSObjectList.XSObjectListgetMultiValueFacets()A list of enumeration and pattern constraining facets if it exists, otherwise an emptyXSObjectList.booleangetNumeric()Fundamental Facet: numeric.shortgetOrdered()Fundamental Facet: ordered.XSSimpleTypeDefinitiongetPrimitiveType()If variety isatomicthe primitive type definition (a built-in primitive datatype definition or the simple ur-type definition) is available, otherwisenull.shortgetVariety()[variety]: one of {atomic, list, union} or absent.booleanisDefinedFacet(short facetName)Convenience method.booleanisFixedFacet(short facetName)Convenience method.-
Methods inherited from interface org.apache.xerces.xs.XSObject
getName, getNamespace, getNamespaceItem, getType
-
Methods inherited from interface org.apache.xerces.xs.XSTypeDefinition
derivedFrom, derivedFromType, getAnonymous, getBaseType, getFinal, getTypeCategory, isFinal
-
-
-
-
Field Detail
-
VARIETY_ABSENT
static final short VARIETY_ABSENT
The variety is absent for the anySimpleType definition.- See Also:
- Constant Field Values
-
VARIETY_ATOMIC
static final short VARIETY_ATOMIC
Atomictype.- See Also:
- Constant Field Values
-
VARIETY_LIST
static final short VARIETY_LIST
Listtype.- See Also:
- Constant Field Values
-
VARIETY_UNION
static final short VARIETY_UNION
Uniontype.- See Also:
- Constant Field Values
-
FACET_NONE
static final short FACET_NONE
No facets defined.- See Also:
- Constant Field Values
-
FACET_LENGTH
static final short FACET_LENGTH
4.3.1 Length- See Also:
- Constant Field Values
-
FACET_MINLENGTH
static final short FACET_MINLENGTH
4.3.2 minLength.- See Also:
- Constant Field Values
-
FACET_MAXLENGTH
static final short FACET_MAXLENGTH
4.3.3 maxLength.- See Also:
- Constant Field Values
-
FACET_PATTERN
static final short FACET_PATTERN
4.3.4 pattern.- See Also:
- Constant Field Values
-
FACET_WHITESPACE
static final short FACET_WHITESPACE
4.3.5 whitespace.- See Also:
- Constant Field Values
-
FACET_MAXINCLUSIVE
static final short FACET_MAXINCLUSIVE
4.3.7 maxInclusive.- See Also:
- Constant Field Values
-
FACET_MAXEXCLUSIVE
static final short FACET_MAXEXCLUSIVE
4.3.9 maxExclusive.- See Also:
- Constant Field Values
-
FACET_MINEXCLUSIVE
static final short FACET_MINEXCLUSIVE
4.3.9 minExclusive.- See Also:
- Constant Field Values
-
FACET_MININCLUSIVE
static final short FACET_MININCLUSIVE
4.3.10 minInclusive.- See Also:
- Constant Field Values
-
FACET_TOTALDIGITS
static final short FACET_TOTALDIGITS
4.3.11 totalDigits .- See Also:
- Constant Field Values
-
FACET_FRACTIONDIGITS
static final short FACET_FRACTIONDIGITS
4.3.12 fractionDigits.- See Also:
- Constant Field Values
-
FACET_ENUMERATION
static final short FACET_ENUMERATION
4.3.5 enumeration.- See Also:
- Constant Field Values
-
ORDERED_FALSE
static final short ORDERED_FALSE
A constant defined for the 'ordered' fundamental facet: not ordered.- See Also:
- Constant Field Values
-
ORDERED_PARTIAL
static final short ORDERED_PARTIAL
A constant defined for the 'ordered' fundamental facet: partially ordered.- See Also:
- Constant Field Values
-
ORDERED_TOTAL
static final short ORDERED_TOTAL
A constant defined for the 'ordered' fundamental facet: total ordered.- See Also:
- Constant Field Values
-
-
Method Detail
-
getVariety
short getVariety()
[variety]: one of {atomic, list, union} or absent.
-
getPrimitiveType
XSSimpleTypeDefinition getPrimitiveType()
If variety isatomicthe primitive type definition (a built-in primitive datatype definition or the simple ur-type definition) is available, otherwisenull.
-
getBuiltInKind
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 theINTEGER_DVis returned.
-
getItemType
XSSimpleTypeDefinition getItemType()
If variety islistthe item type definition (an atomic or union simple type definition) is available, otherwisenull.
-
getMemberTypes
XSObjectList getMemberTypes()
If variety isunionthe list of member type definitions (a non-empty sequence of simple type definitions) is available, otherwise an emptyXSObjectList.
-
getDefinedFacets
short getDefinedFacets()
[facets]: all facets defined on this type. The value is a bit combination of FACET_XXX constants of all defined facets.
-
isDefinedFacet
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
short getFixedFacets()
[facets]: all defined facets for this type which are fixed.
-
isFixedFacet
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
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 forenumerationandpatternfacets.- Parameters:
facetName- The name of the facet, i.e.FACET_LENGTH, FACET_TOTALDIGITS. To retrieve the value for a pattern or an enumeration, seeenumerationandpattern.- Returns:
- A value of the facet specified in
facetNamefor this simple type definition ornull.
-
getLexicalEnumeration
StringList getLexicalEnumeration()
A list of enumeration values if it exists, otherwise an emptyStringList.
-
getLexicalPattern
StringList getLexicalPattern()
A list of pattern values if it exists, otherwise an emptyStringList.
-
getOrdered
short getOrdered()
Fundamental Facet: ordered.
-
getFinite
boolean getFinite()
Fundamental Facet: cardinality.
-
getBounded
boolean getBounded()
Fundamental Facet: bounded.
-
getNumeric
boolean getNumeric()
Fundamental Facet: numeric.
-
getFacets
XSObjectList getFacets()
A list of constraining facets if it exists, otherwise an emptyXSObjectList. Note: This method must not be used to retrieve values forenumerationandpatternfacets.
-
getMultiValueFacets
XSObjectList getMultiValueFacets()
A list of enumeration and pattern constraining facets if it exists, otherwise an emptyXSObjectList.
-
getFacet
XSObject getFacet(int facetType)
A constraining facet object. An instance of XSFacet or XSMultiValueFacet.
-
getAnnotations
XSObjectList getAnnotations()
A sequence of [annotations] or an emptyXSObjectList.
-
-