Package org.apache.xerces.impl.dv.xs
Class XSSimpleTypeDelegate
java.lang.Object
org.apache.xerces.impl.dv.xs.XSSimpleTypeDelegate
- All Implemented Interfaces:
XSSimpleType,org.apache.xerces.xs.XSObject,org.apache.xerces.xs.XSSimpleTypeDefinition,org.apache.xerces.xs.XSTypeDefinition
Base class for XSSimpleType wrapper implementations.
INTERNAL:
- Usage of this class is not supported. It may be altered or removed at any time.
- Version:
- $Id: XSSimpleTypeDelegate.java 1024038 2010-10-18 22:06:35Z sandygao $
-
Field Summary
FieldsFields inherited from interface org.apache.xerces.impl.dv.XSSimpleType
PRIMITIVE_ANYURI, PRIMITIVE_BASE64BINARY, PRIMITIVE_BOOLEAN, PRIMITIVE_DATE, PRIMITIVE_DATETIME, PRIMITIVE_DECIMAL, PRIMITIVE_DOUBLE, PRIMITIVE_DURATION, PRIMITIVE_FLOAT, PRIMITIVE_GDAY, PRIMITIVE_GMONTH, PRIMITIVE_GMONTHDAY, PRIMITIVE_GYEAR, PRIMITIVE_GYEARMONTH, PRIMITIVE_HEXBINARY, PRIMITIVE_NOTATION, PRIMITIVE_PRECISIONDECIMAL, PRIMITIVE_QNAME, PRIMITIVE_STRING, PRIMITIVE_TIME, WS_COLLAPSE, WS_PRESERVE, WS_REPLACEFields inherited from interface org.apache.xerces.xs.XSSimpleTypeDefinition
FACET_ENUMERATION, FACET_FRACTIONDIGITS, FACET_LENGTH, FACET_MAXEXCLUSIVE, FACET_MAXINCLUSIVE, FACET_MAXLENGTH, FACET_MINEXCLUSIVE, FACET_MININCLUSIVE, FACET_MINLENGTH, FACET_NONE, FACET_PATTERN, FACET_TOTALDIGITS, FACET_WHITESPACE, ORDERED_FALSE, ORDERED_PARTIAL, ORDERED_TOTAL, VARIETY_ABSENT, VARIETY_ATOMIC, VARIETY_LIST, VARIETY_UNIONFields inherited from interface org.apache.xerces.xs.XSTypeDefinition
COMPLEX_TYPE, SIMPLE_TYPE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidapplyFacets(XSFacets facets, short presentFacet, short fixedFacet, ValidationContext context) If this type is created from restriction, then some facets can be applied to the simple type.booleanderivedFrom(String namespace, String name, short derivationMethod) Convenience method which checks if this type is derived from the given ancestor type.booleanderivedFromType(org.apache.xerces.xs.XSTypeDefinition ancestorType, short derivationMethod) Convenience method which checks if this type is derived from the givenancestorType.org.apache.xerces.xs.XSObjectListA sequence of [annotations] or an emptyXSObjectList.booleanConvenience attribute.org.apache.xerces.xs.XSTypeDefinition{base type definition}: either a simple type definition or a complex type definition.booleanFundamental Facet: bounded.shortReturns the closest built-in type category this type represents or derived from.short[facets]: all facets defined on this type.org.apache.xerces.xs.XSObjectgetFacet(int facetType) A constraining facet object.org.apache.xerces.xs.XSObjectListA list of constraining facets if it exists, otherwise an emptyXSObjectList.shortgetFinal()For complex types the returned value is a bit combination of the subset of {DERIVATION_EXTENSION, DERIVATION_RESTRICTION} corresponding tofinalset of this type orDERIVATION_NONE.booleanFundamental Facet: cardinality.short[facets]: all defined facets for this type which are fixed.org.apache.xerces.xs.XSSimpleTypeDefinitionIf variety islistthe item type definition (an atomic or union simple type definition) is available, otherwisenull.org.apache.xerces.xs.StringListA list of enumeration values if it exists, otherwise an emptyStringList.getLexicalFacetValue(short facetName) Convenience method.org.apache.xerces.xs.StringListA list of pattern values if it exists, otherwise an emptyStringList.org.apache.xerces.xs.XSObjectListIf variety isunionthe list of member type definitions (a non-empty sequence of simple type definitions) is available, otherwise an emptyXSObjectList.org.apache.xerces.xs.XSObjectListA list of enumeration and pattern constraining facets if it exists, otherwise an emptyXSObjectList.getName()The name of typeNCName, as defined in XML Namespaces, of this declaration specified in the{name}property of the component ornullif the definition of this component does not have a{name}property.The [target namespace] of this object, ornullif it is unspecified.org.apache.xerces.xs.XSNamespaceItemA namespace schema information item corresponding to the target namespace of the component, if it is globally declared; ornullotherwise.booleanFundamental Facet: numeric.shortFundamental Facet: ordered.shortreturn an ID representing the built-in primitive base type.org.apache.xerces.xs.XSSimpleTypeDefinitionIf variety isatomicthe primitive type definition (a built-in primitive datatype definition or the simple ur-type definition) is available, otherwisenull.shortgetType()Thetypeof this object, i.e.shortReturn whether this type definition is a simple type or complex type.short[variety]: one of {atomic, list, union} or absent.shortReturn the whitespace corresponding to this datatype.booleanisDefinedFacet(short facetName) Convenience method.booleanCheck whether two actual values are equal.booleanisFinal(short restriction) {final}.booleanisFixedFacet(short facetName) Convenience method.booleanisIDType()Check whether this type is or is derived from ID.toString()validate(Object content, ValidationContext context, ValidatedInfo validatedInfo) validate a given string value, represented by content.toString().validate(String content, ValidationContext context, ValidatedInfo validatedInfo) validate a given string against this simple type.voidvalidate(ValidationContext context, ValidatedInfo validatedInfo) Validate an actual value against this simple type.
-
Field Details
-
type
-
-
Constructor Details
-
XSSimpleTypeDelegate
-
-
Method Details
-
getWrappedXSSimpleType
-
getAnnotations
public org.apache.xerces.xs.XSObjectList getAnnotations()Description copied from interface:org.apache.xerces.xs.XSSimpleTypeDefinitionA sequence of [annotations] or an emptyXSObjectList.- Specified by:
getAnnotationsin interfaceorg.apache.xerces.xs.XSSimpleTypeDefinition
-
getBounded
public boolean getBounded()Description copied from interface:org.apache.xerces.xs.XSSimpleTypeDefinitionFundamental Facet: bounded.- Specified by:
getBoundedin interfaceorg.apache.xerces.xs.XSSimpleTypeDefinition
-
getBuiltInKind
public short getBuiltInKind()Description copied from interface:org.apache.xerces.xs.XSSimpleTypeDefinitionReturns 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.- Specified by:
getBuiltInKindin interfaceorg.apache.xerces.xs.XSSimpleTypeDefinition
-
getDefinedFacets
public short getDefinedFacets()Description copied from interface:org.apache.xerces.xs.XSSimpleTypeDefinition[facets]: all facets defined on this type. The value is a bit combination of FACET_XXX constants of all defined facets.- Specified by:
getDefinedFacetsin interfaceorg.apache.xerces.xs.XSSimpleTypeDefinition
-
getFacets
public org.apache.xerces.xs.XSObjectList getFacets()Description copied from interface:org.apache.xerces.xs.XSSimpleTypeDefinitionA list of constraining facets if it exists, otherwise an emptyXSObjectList. Note: This method must not be used to retrieve values forenumerationandpatternfacets.- Specified by:
getFacetsin interfaceorg.apache.xerces.xs.XSSimpleTypeDefinition
-
getFacet
public org.apache.xerces.xs.XSObject getFacet(int facetType) Description copied from interface:org.apache.xerces.xs.XSSimpleTypeDefinitionA constraining facet object. An instance of XSFacet or XSMultiValueFacet.- Specified by:
getFacetin interfaceorg.apache.xerces.xs.XSSimpleTypeDefinition
-
getFinite
public boolean getFinite()Description copied from interface:org.apache.xerces.xs.XSSimpleTypeDefinitionFundamental Facet: cardinality.- Specified by:
getFinitein interfaceorg.apache.xerces.xs.XSSimpleTypeDefinition
-
getFixedFacets
public short getFixedFacets()Description copied from interface:org.apache.xerces.xs.XSSimpleTypeDefinition[facets]: all defined facets for this type which are fixed.- Specified by:
getFixedFacetsin interfaceorg.apache.xerces.xs.XSSimpleTypeDefinition
-
getItemType
public org.apache.xerces.xs.XSSimpleTypeDefinition getItemType()Description copied from interface:org.apache.xerces.xs.XSSimpleTypeDefinitionIf variety islistthe item type definition (an atomic or union simple type definition) is available, otherwisenull.- Specified by:
getItemTypein interfaceorg.apache.xerces.xs.XSSimpleTypeDefinition
-
getLexicalEnumeration
public org.apache.xerces.xs.StringList getLexicalEnumeration()Description copied from interface:org.apache.xerces.xs.XSSimpleTypeDefinitionA list of enumeration values if it exists, otherwise an emptyStringList.- Specified by:
getLexicalEnumerationin interfaceorg.apache.xerces.xs.XSSimpleTypeDefinition
-
getLexicalFacetValue
Description copied from interface:org.apache.xerces.xs.XSSimpleTypeDefinitionConvenience method. Returns a value of a single constraining facet for this simple type definition. This method must not be used to retrieve values forenumerationandpatternfacets.- Specified by:
getLexicalFacetValuein interfaceorg.apache.xerces.xs.XSSimpleTypeDefinition- 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.
-
getLexicalPattern
public org.apache.xerces.xs.StringList getLexicalPattern()Description copied from interface:org.apache.xerces.xs.XSSimpleTypeDefinitionA list of pattern values if it exists, otherwise an emptyStringList.- Specified by:
getLexicalPatternin interfaceorg.apache.xerces.xs.XSSimpleTypeDefinition
-
getMemberTypes
public org.apache.xerces.xs.XSObjectList getMemberTypes()Description copied from interface:org.apache.xerces.xs.XSSimpleTypeDefinitionIf variety isunionthe list of member type definitions (a non-empty sequence of simple type definitions) is available, otherwise an emptyXSObjectList.- Specified by:
getMemberTypesin interfaceorg.apache.xerces.xs.XSSimpleTypeDefinition
-
getMultiValueFacets
public org.apache.xerces.xs.XSObjectList getMultiValueFacets()Description copied from interface:org.apache.xerces.xs.XSSimpleTypeDefinitionA list of enumeration and pattern constraining facets if it exists, otherwise an emptyXSObjectList.- Specified by:
getMultiValueFacetsin interfaceorg.apache.xerces.xs.XSSimpleTypeDefinition
-
getNumeric
public boolean getNumeric()Description copied from interface:org.apache.xerces.xs.XSSimpleTypeDefinitionFundamental Facet: numeric.- Specified by:
getNumericin interfaceorg.apache.xerces.xs.XSSimpleTypeDefinition
-
getOrdered
public short getOrdered()Description copied from interface:org.apache.xerces.xs.XSSimpleTypeDefinitionFundamental Facet: ordered.- Specified by:
getOrderedin interfaceorg.apache.xerces.xs.XSSimpleTypeDefinition
-
getPrimitiveType
public org.apache.xerces.xs.XSSimpleTypeDefinition getPrimitiveType()Description copied from interface:org.apache.xerces.xs.XSSimpleTypeDefinitionIf variety isatomicthe primitive type definition (a built-in primitive datatype definition or the simple ur-type definition) is available, otherwisenull.- Specified by:
getPrimitiveTypein interfaceorg.apache.xerces.xs.XSSimpleTypeDefinition
-
getVariety
public short getVariety()Description copied from interface:org.apache.xerces.xs.XSSimpleTypeDefinition[variety]: one of {atomic, list, union} or absent.- Specified by:
getVarietyin interfaceorg.apache.xerces.xs.XSSimpleTypeDefinition
-
isDefinedFacet
public boolean isDefinedFacet(short facetName) Description copied from interface:org.apache.xerces.xs.XSSimpleTypeDefinitionConvenience method. [Facets]: check whether a facet is defined on this type.- Specified by:
isDefinedFacetin interfaceorg.apache.xerces.xs.XSSimpleTypeDefinition- Parameters:
facetName- The name of the facet.- Returns:
- True if the facet is defined, false otherwise.
-
isFixedFacet
public boolean isFixedFacet(short facetName) Description copied from interface:org.apache.xerces.xs.XSSimpleTypeDefinitionConvenience method. [Facets]: check whether a facet is defined and fixed on this type.- Specified by:
isFixedFacetin interfaceorg.apache.xerces.xs.XSSimpleTypeDefinition- Parameters:
facetName- The name of the facet.- Returns:
- True if the facet is fixed, false otherwise.
-
derivedFrom
Description copied from interface:org.apache.xerces.xs.XSTypeDefinitionConvenience method which checks if this type is derived from the given ancestor type.- Specified by:
derivedFromin interfaceorg.apache.xerces.xs.XSTypeDefinition- Parameters:
namespace- An ancestor type namespace.name- An ancestor type name.derivationMethod- A bit combination representing a subset of {DERIVATION_RESTRICTION, DERIVATION_EXTENSION, DERIVATION_UNION, DERIVATION_LIST}.- Returns:
- True if this type is derived from
ancestorTypeusing only derivation methods from thederivationMethod.
-
derivedFromType
public boolean derivedFromType(org.apache.xerces.xs.XSTypeDefinition ancestorType, short derivationMethod) Description copied from interface:org.apache.xerces.xs.XSTypeDefinitionConvenience method which checks if this type is derived from the givenancestorType.- Specified by:
derivedFromTypein interfaceorg.apache.xerces.xs.XSTypeDefinition- Parameters:
ancestorType- An ancestor type definition.derivationMethod- A bit combination representing a subset of {DERIVATION_RESTRICTION, DERIVATION_EXTENSION, DERIVATION_UNION, DERIVATION_LIST}.- Returns:
- True if this type is derived from
ancestorTypeusing only derivation methods from thederivationMethod.
-
getAnonymous
public boolean getAnonymous()Description copied from interface:org.apache.xerces.xs.XSTypeDefinitionConvenience attribute. A boolean that specifies if the type definition is anonymous.- Specified by:
getAnonymousin interfaceorg.apache.xerces.xs.XSTypeDefinition
-
getBaseType
public org.apache.xerces.xs.XSTypeDefinition getBaseType()Description copied from interface:org.apache.xerces.xs.XSTypeDefinition{base type definition}: either a simple type definition or a complex type definition.- Specified by:
getBaseTypein interfaceorg.apache.xerces.xs.XSTypeDefinition
-
getFinal
public short getFinal()Description copied from interface:org.apache.xerces.xs.XSTypeDefinitionFor complex types the returned value is a bit combination of the subset of {DERIVATION_EXTENSION, DERIVATION_RESTRICTION} corresponding tofinalset of this type orDERIVATION_NONE. For simple types the returned value is a bit combination of the subset of {DERIVATION_RESTRICTION, DERIVATION_EXTENSION, DERIVATION_UNION, DERIVATION_LIST} corresponding tofinalset of this type orDERIVATION_NONE.- Specified by:
getFinalin interfaceorg.apache.xerces.xs.XSTypeDefinition
-
getTypeCategory
public short getTypeCategory()Description copied from interface:org.apache.xerces.xs.XSTypeDefinitionReturn whether this type definition is a simple type or complex type.- Specified by:
getTypeCategoryin interfaceorg.apache.xerces.xs.XSTypeDefinition
-
isFinal
public boolean isFinal(short restriction) Description copied from interface:org.apache.xerces.xs.XSTypeDefinition{final}. For a complex type definition it is a subset of {extension, restriction}. For a simple type definition it is a subset of {extension, list, restriction, union}.- Specified by:
isFinalin interfaceorg.apache.xerces.xs.XSTypeDefinition- Parameters:
restriction- Extension, restriction, list, union constants (defined inXSConstants).- Returns:
- True if
restrictionis in the final set, otherwise false.
-
getName
Description copied from interface:org.apache.xerces.xs.XSObjectThe name of typeNCName, as defined in XML Namespaces, of this declaration specified in the{name}property of the component ornullif the definition of this component does not have a{name}property. For anonymous types, the processor must construct and expose an anonymous type name that is distinct from the name of every named type and the name of every other anonymous type.- Specified by:
getNamein interfaceorg.apache.xerces.xs.XSObject
-
getNamespace
Description copied from interface:org.apache.xerces.xs.XSObjectThe [target namespace] of this object, ornullif it is unspecified.- Specified by:
getNamespacein interfaceorg.apache.xerces.xs.XSObject
-
getNamespaceItem
public org.apache.xerces.xs.XSNamespaceItem getNamespaceItem()Description copied from interface:org.apache.xerces.xs.XSObjectA namespace schema information item corresponding to the target namespace of the component, if it is globally declared; ornullotherwise.- Specified by:
getNamespaceItemin interfaceorg.apache.xerces.xs.XSObject
-
getType
public short getType()Description copied from interface:org.apache.xerces.xs.XSObjectThetypeof this object, i.e.ELEMENT_DECLARATION.- Specified by:
getTypein interfaceorg.apache.xerces.xs.XSObject
-
applyFacets
public void applyFacets(XSFacets facets, short presentFacet, short fixedFacet, ValidationContext context) throws InvalidDatatypeFacetException Description copied from interface:XSSimpleTypeIf this type is created from restriction, then some facets can be applied to the simple type.XSFacetsis used to pass the value of different facets.- Specified by:
applyFacetsin interfaceXSSimpleType- Parameters:
facets- the value of all the facetspresentFacet- bit combination value of the costraining facet constants which are present.fixedFacet- bit combination value of the costraining facet constants which are fixed.context- the validation context- Throws:
InvalidDatatypeFacetException- exception for invalid facet values.
-
getPrimitiveKind
public short getPrimitiveKind()Description copied from interface:XSSimpleTypereturn an ID representing the built-in primitive base type. REVISIT: This method is (currently) for internal use only. the constants returned from this method are not finalized yet. the names and values might change in the further.- Specified by:
getPrimitiveKindin interfaceXSSimpleType- Returns:
- an ID representing the built-in primitive base type
-
getWhitespace
Description copied from interface:XSSimpleTypeReturn the whitespace corresponding to this datatype.- Specified by:
getWhitespacein interfaceXSSimpleType- Returns:
- valid values are WS_PRESERVE, WS_REPLACE, WS_COLLAPSE.
- Throws:
DatatypeException- union datatypes don't have whitespace facet associated with them
-
isEqual
Description copied from interface:XSSimpleTypeCheck whether two actual values are equal.- Specified by:
isEqualin interfaceXSSimpleType- Parameters:
value1- the first valuevalue2- the second value- Returns:
- true if the two value are equal
-
isIDType
public boolean isIDType()Description copied from interface:XSSimpleTypeCheck whether this type is or is derived from ID. REVISIT: this method makes ID special, which is not a good design. but since ID is not a primitive, there doesn't seem to be a clean way of doing it except to define special method like this.- Specified by:
isIDTypein interfaceXSSimpleType- Returns:
- whether this simple type is or is derived from ID.
-
validate
public void validate(ValidationContext context, ValidatedInfo validatedInfo) throws InvalidDatatypeValueException Description copied from interface:XSSimpleTypeValidate an actual value against this simple type.- Specified by:
validatein interfaceXSSimpleType- Parameters:
context- the validation contextvalidatedInfo- used to provide the actual value and member types- Throws:
InvalidDatatypeValueException- exception for invalid values.
-
validate
public Object validate(String content, ValidationContext context, ValidatedInfo validatedInfo) throws InvalidDatatypeValueException Description copied from interface:XSSimpleTypevalidate a given string against this simple type.- Specified by:
validatein interfaceXSSimpleType- Parameters:
content- the string value that needs to be validatedcontext- the validation contextvalidatedInfo- used to store validation result- Returns:
- the actual value (QName, Boolean) of the string value
- Throws:
InvalidDatatypeValueException
-
validate
public Object validate(Object content, ValidationContext context, ValidatedInfo validatedInfo) throws InvalidDatatypeValueException Description copied from interface:XSSimpleTypevalidate a given string value, represented by content.toString(). note that if content is a StringBuffer, for performance reasons, it's possible that the content of the string buffer is modified.- Specified by:
validatein interfaceXSSimpleType- Parameters:
content- the string value that needs to be validatedcontext- the validation contextvalidatedInfo- used to store validation result- Returns:
- the actual value (QName, Boolean) of the string value
- Throws:
InvalidDatatypeValueException
-
toString
-