org.apache.xerces.impl.dv.xs
Class XSSimpleTypeDecl

java.lang.Object
  extended byorg.apache.xerces.impl.dv.xs.XSSimpleTypeDecl
All Implemented Interfaces:
org.w3c.dom.TypeInfo, org.apache.xerces.xs.XSObject, XSSimpleType, org.apache.xerces.xs.XSSimpleTypeDefinition, org.apache.xerces.xs.XSTypeDefinition

public class XSSimpleTypeDecl
extends java.lang.Object
implements XSSimpleType, org.w3c.dom.TypeInfo

Version:
$Id: XSSimpleTypeDecl.java 1231153 2012-01-13 16:14:39Z mukulg $
Author:
Sandy Gao, IBM, Neeraj Bajaj, Sun Microsystems, inc.

INTERNAL:

Usage of this class is not supported. It may be altered or removed at any time.

Field Summary
static short ANYATOMICTYPE_DT
           
static short DATETIMESTAMP_DT
           
static short DAYTIMEDURATION_DT
           
protected static short DV_ANYATOMICTYPE
           
protected static short DV_ANYSIMPLETYPE
           
protected static short DV_ANYURI
           
protected static short DV_BASE64BINARY
           
protected static short DV_BOOLEAN
           
protected static short DV_DATE
           
protected static short DV_DATETIME
           
protected static short DV_DATETIMESTAMP
           
protected static short DV_DAYTIMEDURATION
           
protected static short DV_DECIMAL
           
protected static short DV_DOUBLE
           
protected static short DV_DURATION
           
protected static short DV_ENTITY
           
protected static short DV_ERROR
           
protected static short DV_FLOAT
           
protected static short DV_GDAY
           
protected static short DV_GMONTH
           
protected static short DV_GMONTHDAY
           
protected static short DV_GYEAR
           
protected static short DV_GYEARMONTH
           
protected static short DV_HEXBINARY
           
protected static short DV_ID
           
protected static short DV_IDREF
           
protected static short DV_INTEGER
           
protected static short DV_LIST
           
protected static short DV_NOTATION
           
protected static short DV_PRECISIONDECIMAL
           
protected static short DV_QNAME
           
protected static short DV_STRING
           
protected static short DV_TIME
           
protected static short DV_UNION
           
protected static short DV_YEARMONTHDURATION
           
 org.apache.xerces.xs.XSObjectList enumerationAnnotations
           
static short ERROR_DT
           
 org.apache.xerces.xs.XSAnnotation explicitTimezoneAnnotation
           
 org.apache.xerces.xs.XSAnnotation fractionDigitsAnnotation
           
 org.apache.xerces.xs.XSAnnotation lengthAnnotation
           
 org.apache.xerces.xs.XSAnnotation maxExclusiveAnnotation
           
 org.apache.xerces.xs.XSAnnotation maxInclusiveAnnotation
           
 org.apache.xerces.xs.XSAnnotation maxLengthAnnotation
           
 org.apache.xerces.xs.XSAnnotation maxScaleAnnotation
           
 org.apache.xerces.xs.XSAnnotation minExclusiveAnnotation
           
 org.apache.xerces.xs.XSAnnotation minInclusiveAnnotation
           
 org.apache.xerces.xs.XSAnnotation minLengthAnnotation
           
 org.apache.xerces.xs.XSAnnotation minScaleAnnotation
           
 XSObjectListImpl patternAnnotations
           
static short PRECISIONDECIMAL_DT
           
 org.apache.xerces.xs.XSAnnotation totalDigitsAnnotation
           
 org.apache.xerces.xs.XSAnnotation whiteSpaceAnnotation
           
static short YEARMONTHDURATION_DT
           
 
Fields inherited from interface org.apache.xerces.impl.dv.XSSimpleType
ET_OPTIONAL, ET_PROHIBITED, ET_REQUIRED, 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_REPLACE
 
Fields inherited from interface org.apache.xerces.xs.XSSimpleTypeDefinition
FACET_ASSERT, FACET_ENUMERATION, FACET_EXPLICITTIMEZONE, FACET_FRACTIONDIGITS, FACET_LENGTH, FACET_MAXEXCLUSIVE, FACET_MAXINCLUSIVE, FACET_MAXLENGTH, FACET_MAXSCALE, FACET_MINEXCLUSIVE, FACET_MININCLUSIVE, FACET_MINLENGTH, FACET_MINSCALE, FACET_NONE, FACET_PATTERN, FACET_TOTALDIGITS, FACET_WHITESPACE, ORDERED_FALSE, ORDERED_PARTIAL, ORDERED_TOTAL, VARIETY_ABSENT, VARIETY_ATOMIC, VARIETY_LIST, VARIETY_UNION
 
Fields inherited from interface org.apache.xerces.xs.XSTypeDefinition
COMPLEX_TYPE, SIMPLE_TYPE
 
Constructor Summary
  XSSimpleTypeDecl()
           
protected XSSimpleTypeDecl(java.lang.String name, java.lang.String uri, short finalSet, XSSimpleTypeDecl[] memberTypes, org.apache.xerces.xs.XSObjectList annotations)
           
protected XSSimpleTypeDecl(java.lang.String name, java.lang.String uri, short finalSet, XSSimpleTypeDecl itemType, boolean isImmutable, org.apache.xerces.xs.XSObjectList annotations)
           
protected XSSimpleTypeDecl(XSSimpleTypeDecl base, java.lang.String name, short validateDV, short ordered, boolean bounded, boolean finite, boolean numeric, boolean isImmutable, short builtInKind)
           
protected XSSimpleTypeDecl(XSSimpleTypeDecl base, java.lang.String name, java.lang.String uri, short finalSet, boolean isImmutable, org.apache.xerces.xs.XSObjectList annotations)
           
protected XSSimpleTypeDecl(XSSimpleTypeDecl base, java.lang.String name, java.lang.String uri, short finalSet, boolean isImmutable, org.apache.xerces.xs.XSObjectList annotations, short builtInKind)
           
 
Method Summary
 void applyFacets(XSFacets facets, int presentFacet, int fixedFacet, ValidationContext context)
          If is chosen
 boolean derivedFrom(java.lang.String ancestorNS, java.lang.String ancestorName, short derivation)
          Convenience method which checks if this type is derived from the given ancestor type.
 boolean derivedFromType(org.apache.xerces.xs.XSTypeDefinition ancestor, short derivation)
          Convenience method which checks if this type is derived from the given ancestorType.
 org.apache.xerces.xs.datatypes.ObjectList getActualEnumeration()
          A list of actual enumeration values if it exists, otherwise an empty ObjectList.
protected  ValidatedInfo getActualEnumValue(java.lang.String lexical, ValidationContext ctx, ValidatedInfo info)
           
 org.apache.xerces.xs.XSObjectList getAnnotations()
          [annotations]: a set of annotations for this simple type component if it exists, otherwise an empty XSObjectList.
 boolean getAnonymous()
          Convenience attribute.
 org.apache.xerces.xs.XSTypeDefinition getBaseType()
          {base type definition}: either a simple type definition or a complex type definition.
 boolean getBounded()
          Fundamental Facet: bounded.
 short getBuiltInKind()
          Returns the closest built-in type category this type represents or derived from.
 org.apache.xerces.xs.XSObject getContext()
          A property that simplifies testing for the identity of anonymous type definitions.
 short getDefinedFacets()
          [facets]: all facets defined on this type.
 org.apache.xerces.xs.datatypes.ObjectList getEnumerationItemTypeList()
          A list of enumeration type values (as a list of ShortList objects) if it exists, otherwise returns null
 org.apache.xerces.xs.ShortList getEnumerationTypeList()
           
 org.apache.xerces.xs.XSObject getFacet(int facetType)
          A constraining facet object.
 org.apache.xerces.xs.XSObjectList getFacets()
          A list of constraining facets if it exists, otherwise an empty XSObjectList.
 short getFinal()
          For complex types the returned value is a bit combination of the subset of {DERIVATION_EXTENSION, DERIVATION_RESTRICTION} corresponding to final set of this type or DERIVATION_NONE.
 boolean getFinite()
          Fundamental Facet: cardinality.
 short getFixedFacets()
          [facets]: all defined facets for this type which are fixed.
protected static TypeValidator[] getGDVs()
           
 org.apache.xerces.xs.XSSimpleTypeDefinition getItemType()
          If variety is list the item type definition (an atomic or union simple type definition) if available, otherwise null.
 org.apache.xerces.xs.StringList getLexicalEnumeration()
          A list of enumeration values if it exists, otherwise an empty StringList.
 java.lang.String getLexicalFacetValue(short facetName)
          Convenience method.
 org.apache.xerces.xs.StringList getLexicalPattern()
          A list of pattern values if it exists, otherwise an empty StringList.
 java.lang.Object getMaxExclusiveValue()
           
 java.lang.Object getMaxInclusiveValue()
           
 org.apache.xerces.xs.XSObjectList getMemberTypes()
          If variety is union the list of member type definitions (a non-empty sequence of simple type definitions) if available, otherwise an empty XSObjectList.
 java.lang.Object getMinExclusiveValue()
           
 java.lang.Object getMinInclusiveValue()
           
 org.apache.xerces.xs.XSObjectList getMultiValueFacets()
          A list of enumeration and pattern constraining facets if it exists, otherwise an empty XSObjectList.
 java.lang.String getName()
          The name of type NCName, as defined in XML Namespaces, of this declaration specified in the {name} property of the component or null if the definition of this component does not have a {name} property.
 java.lang.String getNamespace()
          The [target namespace] of this object, or null if it is unspecified.
 org.apache.xerces.xs.XSNamespaceItem getNamespaceItem()
          A namespace schema information item corresponding to the target namespace of the component, if it is globally declared; or null otherwise.
 boolean getNumeric()
          Fundamental Facet: numeric.
 short getOrdered()
          Fundamental Facet: ordered.
 short getPrimitiveKind()
          return an ID representing the built-in primitive base type.
 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) if available, otherwise null.
 short getType()
          The type of this object, i.e.
 short getTypeCategory()
          Return whether this type definition is a simple type or complex type.
 java.lang.String getTypeName()
          The name of a type declared for the associated element or attribute, or null if unknown.
 java.lang.String getTypeNamespace()
          The namespace of the type declared for the associated element or attribute or null if the element does not have declaration or if no namespace information is available.
 TypeValidator getTypeValidator()
           
 short getVariety()
          [variety]: one of {atomic, list, union} or absent.
 short getWhitespace()
          Return the whitespace corresponding to this datatype.
 boolean isDefinedFacet(short facetName)
          Convenience method.
 boolean isDerivedFrom(java.lang.String typeNamespaceArg, java.lang.String typeNameArg, int derivationMethod)
          This method returns if there is a derivation between the reference type definition, i.e.
 boolean isDOMDerivedFrom(java.lang.String ancestorNS, java.lang.String ancestorName, int derivationMethod)
          Checks if a type is derived from another by restriction, given the name and namespace.
 boolean isEqual(java.lang.Object value1, java.lang.Object value2)
          Check whether two actual values are equal.
 boolean isFinal(short derivation)
          {final}.
 boolean isFixedFacet(short facetName)
          Convenience method.
 boolean isIdentical(java.lang.Object value1, java.lang.Object value2)
           
 boolean isIDType()
          Check whether this type is or is derived from ID.
protected  java.lang.String normalize(java.lang.Object content, short ws)
           
static java.lang.String normalize(java.lang.String content, short ws)
           
 void reset()
           
 void setAnonymous(boolean anon)
           
 void setContext(org.apache.xerces.xs.XSObject context)
           
protected  void setDVs(TypeValidator[] dvs)
           
protected  XSSimpleTypeDecl setListValues(java.lang.String name, java.lang.String uri, short finalSet, XSSimpleTypeDecl itemType, org.apache.xerces.xs.XSObjectList annotations)
           
 void setNamespaceItem(org.apache.xerces.xs.XSNamespaceItem namespaceItem)
           
protected  XSSimpleTypeDecl setRestrictionValues(XSSimpleTypeDecl base, java.lang.String name, java.lang.String uri, short finalSet, org.apache.xerces.xs.XSObjectList annotations)
           
protected  XSSimpleTypeDecl setUnionValues(java.lang.String name, java.lang.String uri, short finalSet, XSSimpleTypeDecl[] memberTypes, org.apache.xerces.xs.XSObjectList annotations)
           
 java.lang.String toString()
           
 java.lang.Object validate(java.lang.Object content, ValidationContext context, ValidatedInfo validatedInfo)
          validate a value, and return the compiled form
 java.lang.Object validate(java.lang.String content, ValidationContext context, ValidatedInfo validatedInfo)
          validate a value, and return the compiled form
 void validate(ValidationContext context, ValidatedInfo validatedInfo)
          validate an actual value against this DV
 ValidatedInfo validateWithInfo(java.lang.String content, ValidationContext context, ValidatedInfo validatedInfo)
          validate a value, and return the compiled form
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DV_STRING

protected static final short DV_STRING
See Also:
Constant Field Values

DV_BOOLEAN

protected static final short DV_BOOLEAN
See Also:
Constant Field Values

DV_DECIMAL

protected static final short DV_DECIMAL
See Also:
Constant Field Values

DV_FLOAT

protected static final short DV_FLOAT
See Also:
Constant Field Values

DV_DOUBLE

protected static final short DV_DOUBLE
See Also:
Constant Field Values

DV_DURATION

protected static final short DV_DURATION
See Also:
Constant Field Values

DV_DATETIME

protected static final short DV_DATETIME
See Also:
Constant Field Values

DV_TIME

protected static final short DV_TIME
See Also:
Constant Field Values

DV_DATE

protected static final short DV_DATE
See Also:
Constant Field Values

DV_GYEARMONTH

protected static final short DV_GYEARMONTH
See Also:
Constant Field Values

DV_GYEAR

protected static final short DV_GYEAR
See Also:
Constant Field Values

DV_GMONTHDAY

protected static final short DV_GMONTHDAY
See Also:
Constant Field Values

DV_GDAY

protected static final short DV_GDAY
See Also:
Constant Field Values

DV_GMONTH

protected static final short DV_GMONTH
See Also:
Constant Field Values

DV_HEXBINARY

protected static final short DV_HEXBINARY
See Also:
Constant Field Values

DV_BASE64BINARY

protected static final short DV_BASE64BINARY
See Also:
Constant Field Values

DV_ANYURI

protected static final short DV_ANYURI
See Also:
Constant Field Values

DV_QNAME

protected static final short DV_QNAME
See Also:
Constant Field Values

DV_PRECISIONDECIMAL

protected static final short DV_PRECISIONDECIMAL
See Also:
Constant Field Values

DV_NOTATION

protected static final short DV_NOTATION
See Also:
Constant Field Values

DV_ANYSIMPLETYPE

protected static final short DV_ANYSIMPLETYPE
See Also:
Constant Field Values

DV_ID

protected static final short DV_ID
See Also:
Constant Field Values

DV_IDREF

protected static final short DV_IDREF
See Also:
Constant Field Values

DV_ENTITY

protected static final short DV_ENTITY
See Also:
Constant Field Values

DV_INTEGER

protected static final short DV_INTEGER
See Also:
Constant Field Values

DV_LIST

protected static final short DV_LIST
See Also:
Constant Field Values

DV_UNION

protected static final short DV_UNION
See Also:
Constant Field Values

DV_YEARMONTHDURATION

protected static final short DV_YEARMONTHDURATION
See Also:
Constant Field Values

DV_DAYTIMEDURATION

protected static final short DV_DAYTIMEDURATION
See Also:
Constant Field Values

DV_ANYATOMICTYPE

protected static final short DV_ANYATOMICTYPE
See Also:
Constant Field Values

DV_ERROR

protected static final short DV_ERROR
See Also:
Constant Field Values

DV_DATETIMESTAMP

protected static final short DV_DATETIMESTAMP
See Also:
Constant Field Values

YEARMONTHDURATION_DT

public static final short YEARMONTHDURATION_DT
See Also:
Constant Field Values

DAYTIMEDURATION_DT

public static final short DAYTIMEDURATION_DT
See Also:
Constant Field Values

PRECISIONDECIMAL_DT

public static final short PRECISIONDECIMAL_DT
See Also:
Constant Field Values

ANYATOMICTYPE_DT

public static final short ANYATOMICTYPE_DT
See Also:
Constant Field Values

ERROR_DT

public static final short ERROR_DT
See Also:
Constant Field Values

DATETIMESTAMP_DT

public static final short DATETIMESTAMP_DT
See Also:
Constant Field Values

lengthAnnotation

public org.apache.xerces.xs.XSAnnotation lengthAnnotation

minLengthAnnotation

public org.apache.xerces.xs.XSAnnotation minLengthAnnotation

maxLengthAnnotation

public org.apache.xerces.xs.XSAnnotation maxLengthAnnotation

whiteSpaceAnnotation

public org.apache.xerces.xs.XSAnnotation whiteSpaceAnnotation

totalDigitsAnnotation

public org.apache.xerces.xs.XSAnnotation totalDigitsAnnotation

fractionDigitsAnnotation

public org.apache.xerces.xs.XSAnnotation fractionDigitsAnnotation

patternAnnotations

public XSObjectListImpl patternAnnotations

enumerationAnnotations

public org.apache.xerces.xs.XSObjectList enumerationAnnotations

maxInclusiveAnnotation

public org.apache.xerces.xs.XSAnnotation maxInclusiveAnnotation

maxExclusiveAnnotation

public org.apache.xerces.xs.XSAnnotation maxExclusiveAnnotation

minInclusiveAnnotation

public org.apache.xerces.xs.XSAnnotation minInclusiveAnnotation

minExclusiveAnnotation

public org.apache.xerces.xs.XSAnnotation minExclusiveAnnotation

maxScaleAnnotation

public org.apache.xerces.xs.XSAnnotation maxScaleAnnotation

minScaleAnnotation

public org.apache.xerces.xs.XSAnnotation minScaleAnnotation

explicitTimezoneAnnotation

public org.apache.xerces.xs.XSAnnotation explicitTimezoneAnnotation
Constructor Detail

XSSimpleTypeDecl

public XSSimpleTypeDecl()

XSSimpleTypeDecl

protected XSSimpleTypeDecl(XSSimpleTypeDecl base,
                           java.lang.String name,
                           short validateDV,
                           short ordered,
                           boolean bounded,
                           boolean finite,
                           boolean numeric,
                           boolean isImmutable,
                           short builtInKind)

XSSimpleTypeDecl

protected XSSimpleTypeDecl(XSSimpleTypeDecl base,
                           java.lang.String name,
                           java.lang.String uri,
                           short finalSet,
                           boolean isImmutable,
                           org.apache.xerces.xs.XSObjectList annotations,
                           short builtInKind)

XSSimpleTypeDecl

protected XSSimpleTypeDecl(XSSimpleTypeDecl base,
                           java.lang.String name,
                           java.lang.String uri,
                           short finalSet,
                           boolean isImmutable,
                           org.apache.xerces.xs.XSObjectList annotations)

XSSimpleTypeDecl

protected XSSimpleTypeDecl(java.lang.String name,
                           java.lang.String uri,
                           short finalSet,
                           XSSimpleTypeDecl itemType,
                           boolean isImmutable,
                           org.apache.xerces.xs.XSObjectList annotations)

XSSimpleTypeDecl

protected XSSimpleTypeDecl(java.lang.String name,
                           java.lang.String uri,
                           short finalSet,
                           XSSimpleTypeDecl[] memberTypes,
                           org.apache.xerces.xs.XSObjectList annotations)
Method Detail

getGDVs

protected static TypeValidator[] getGDVs()

setDVs

protected void setDVs(TypeValidator[] dvs)

setRestrictionValues

protected XSSimpleTypeDecl setRestrictionValues(XSSimpleTypeDecl base,
                                                java.lang.String name,
                                                java.lang.String uri,
                                                short finalSet,
                                                org.apache.xerces.xs.XSObjectList annotations)

setListValues

protected XSSimpleTypeDecl setListValues(java.lang.String name,
                                         java.lang.String uri,
                                         short finalSet,
                                         XSSimpleTypeDecl itemType,
                                         org.apache.xerces.xs.XSObjectList annotations)

setUnionValues

protected XSSimpleTypeDecl setUnionValues(java.lang.String name,
                                          java.lang.String uri,
                                          short finalSet,
                                          XSSimpleTypeDecl[] memberTypes,
                                          org.apache.xerces.xs.XSObjectList annotations)

getType

public short getType()
Description copied from interface: org.apache.xerces.xs.XSObject
The type of this object, i.e. ELEMENT_DECLARATION.

Specified by:
getType in interface org.apache.xerces.xs.XSObject

getTypeCategory

public short getTypeCategory()
Description copied from interface: org.apache.xerces.xs.XSTypeDefinition
Return whether this type definition is a simple type or complex type.

Specified by:
getTypeCategory in interface org.apache.xerces.xs.XSTypeDefinition

getName

public java.lang.String getName()
Description copied from interface: org.apache.xerces.xs.XSObject
The name of type NCName, as defined in XML Namespaces, of this declaration specified in the {name} property of the component or null if 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:
getName in interface org.apache.xerces.xs.XSObject

getTypeName

public java.lang.String getTypeName()
Description copied from interface: org.w3c.dom.TypeInfo
The name of a type declared for the associated element or attribute, or null if unknown.

Specified by:
getTypeName in interface org.w3c.dom.TypeInfo

getNamespace

public java.lang.String getNamespace()
Description copied from interface: org.apache.xerces.xs.XSObject
The [target namespace] of this object, or null if it is unspecified.

Specified by:
getNamespace in interface org.apache.xerces.xs.XSObject

getFinal

public short getFinal()
Description copied from interface: org.apache.xerces.xs.XSTypeDefinition
For complex types the returned value is a bit combination of the subset of {DERIVATION_EXTENSION, DERIVATION_RESTRICTION} corresponding to final set of this type or DERIVATION_NONE. For simple types the returned value is a bit combination of the subset of { DERIVATION_RESTRICTION, DERIVATION_EXTENSION, DERIVATION_UNION, DERIVATION_LIST } corresponding to final set of this type or DERIVATION_NONE.

Specified by:
getFinal in interface org.apache.xerces.xs.XSTypeDefinition

getTypeValidator

public TypeValidator getTypeValidator()

isFinal

public boolean isFinal(short derivation)
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:
isFinal in interface org.apache.xerces.xs.XSTypeDefinition
Parameters:
derivation - Extension, restriction, list, union constants (defined in XSConstants).
Returns:
True if restriction is in the final set, otherwise false.

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:
getBaseType in interface org.apache.xerces.xs.XSTypeDefinition

getAnonymous

public boolean getAnonymous()
Description copied from interface: org.apache.xerces.xs.XSTypeDefinition
Convenience attribute. A boolean that specifies if the type definition is anonymous.

Specified by:
getAnonymous in interface org.apache.xerces.xs.XSTypeDefinition

getVariety

public short getVariety()
Description copied from interface: org.apache.xerces.xs.XSSimpleTypeDefinition
[variety]: one of {atomic, list, union} or absent.

Specified by:
getVariety in interface org.apache.xerces.xs.XSSimpleTypeDefinition

isIDType

public boolean isIDType()
Description copied from interface: XSSimpleType
Check 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:
isIDType in interface XSSimpleType
Returns:
whether this simple type is or is derived from ID.

getWhitespace

public short getWhitespace()
                    throws DatatypeException
Description copied from interface: XSSimpleType
Return the whitespace corresponding to this datatype.

Specified by:
getWhitespace in interface XSSimpleType
Returns:
valid values are WS_PRESERVE, WS_REPLACE, WS_COLLAPSE.
Throws:
DatatypeException - union datatypes don't have whitespace facet associated with them

getPrimitiveKind

public short getPrimitiveKind()
Description copied from interface: XSSimpleType
return 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:
getPrimitiveKind in interface XSSimpleType
Returns:
an ID representing the built-in primitive base type

getBuiltInKind

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.

Specified by:
getBuiltInKind in interface org.apache.xerces.xs.XSSimpleTypeDefinition

getPrimitiveType

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) if available, otherwise null.

Specified by:
getPrimitiveType in interface org.apache.xerces.xs.XSSimpleTypeDefinition

getItemType

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

Specified by:
getItemType in interface org.apache.xerces.xs.XSSimpleTypeDefinition

getMemberTypes

public org.apache.xerces.xs.XSObjectList getMemberTypes()
If variety is union the list of member type definitions (a non-empty sequence of simple type definitions) if available, otherwise an empty XSObjectList.

Specified by:
getMemberTypes in interface org.apache.xerces.xs.XSSimpleTypeDefinition

applyFacets

public void applyFacets(XSFacets facets,
                        int presentFacet,
                        int fixedFacet,
                        ValidationContext context)
                 throws InvalidDatatypeFacetException
If is chosen

Specified by:
applyFacets in interface XSSimpleType
Parameters:
facets - the value of all the facets
presentFacet - 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.

validate

public java.lang.Object validate(java.lang.String content,
                                 ValidationContext context,
                                 ValidatedInfo validatedInfo)
                          throws InvalidDatatypeValueException
validate a value, and return the compiled form

Specified by:
validate in interface XSSimpleType
Parameters:
content - the string value that needs to be validated
context - the validation context
validatedInfo - used to store validation result
Returns:
the actual value (QName, Boolean) of the string value
Throws:
InvalidDatatypeValueException

getActualEnumValue

protected ValidatedInfo getActualEnumValue(java.lang.String lexical,
                                           ValidationContext ctx,
                                           ValidatedInfo info)
                                    throws InvalidDatatypeValueException
Throws:
InvalidDatatypeValueException

validateWithInfo

public ValidatedInfo validateWithInfo(java.lang.String content,
                                      ValidationContext context,
                                      ValidatedInfo validatedInfo)
                               throws InvalidDatatypeValueException
validate a value, and return the compiled form

Throws:
InvalidDatatypeValueException

validate

public java.lang.Object validate(java.lang.Object content,
                                 ValidationContext context,
                                 ValidatedInfo validatedInfo)
                          throws InvalidDatatypeValueException
validate a value, and return the compiled form

Specified by:
validate in interface XSSimpleType
Parameters:
content - the string value that needs to be validated
context - the validation context
validatedInfo - used to store validation result
Returns:
the actual value (QName, Boolean) of the string value
Throws:
InvalidDatatypeValueException

validate

public void validate(ValidationContext context,
                     ValidatedInfo validatedInfo)
              throws InvalidDatatypeValueException
validate an actual value against this DV

Specified by:
validate in interface XSSimpleType
Parameters:
context - the validation context
validatedInfo - used to provide the actual value and member types
Throws:
InvalidDatatypeValueException - exception for invalid values.

isEqual

public boolean isEqual(java.lang.Object value1,
                       java.lang.Object value2)
Description copied from interface: XSSimpleType
Check whether two actual values are equal.

Specified by:
isEqual in interface XSSimpleType
Parameters:
value1 - the first value
value2 - the second value
Returns:
true if the two value are equal

isIdentical

public boolean isIdentical(java.lang.Object value1,
                           java.lang.Object value2)

normalize

public static java.lang.String normalize(java.lang.String content,
                                         short ws)

normalize

protected java.lang.String normalize(java.lang.Object content,
                                     short ws)

getOrdered

public short getOrdered()
Fundamental Facet: ordered.

Specified by:
getOrdered in interface org.apache.xerces.xs.XSSimpleTypeDefinition

getBounded

public boolean getBounded()
Fundamental Facet: bounded.

Specified by:
getBounded in interface org.apache.xerces.xs.XSSimpleTypeDefinition

getFinite

public boolean getFinite()
Fundamental Facet: cardinality.

Specified by:
getFinite in interface org.apache.xerces.xs.XSSimpleTypeDefinition

getNumeric

public boolean getNumeric()
Fundamental Facet: numeric.

Specified by:
getNumeric in interface org.apache.xerces.xs.XSSimpleTypeDefinition

isDefinedFacet

public boolean isDefinedFacet(short facetName)
Convenience method. [Facets]: check whether a facet is defined on this type.

Specified by:
isDefinedFacet in interface org.apache.xerces.xs.XSSimpleTypeDefinition
Parameters:
facetName - The name of the facet.
Returns:
True if the facet is defined, false otherwise.

getDefinedFacets

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

Specified by:
getDefinedFacets in interface org.apache.xerces.xs.XSSimpleTypeDefinition

isFixedFacet

public boolean isFixedFacet(short facetName)
Convenience method. [Facets]: check whether a facet is defined and fixed on this type.

Specified by:
isFixedFacet in interface org.apache.xerces.xs.XSSimpleTypeDefinition
Parameters:
facetName - The name of the facet.
Returns:
True if the facet is fixed, false otherwise.

getFixedFacets

public short getFixedFacets()
[facets]: all defined facets for this type which are fixed.

Specified by:
getFixedFacets in interface org.apache.xerces.xs.XSSimpleTypeDefinition

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.

Specified by:
getLexicalFacetValue in interface org.apache.xerces.xs.XSSimpleTypeDefinition
Parameters:
facetName - The name of the facet, i.e. FACET_LENGTH, FACET_TOTALDIGITS (see XSConstants). To retrieve the value for a pattern or an enumeration, see enumeration and pattern.
Returns:
A value of the facet specified in facetName for this simple type definition or null.

getLexicalEnumeration

public org.apache.xerces.xs.StringList getLexicalEnumeration()
A list of enumeration values if it exists, otherwise an empty StringList.

Specified by:
getLexicalEnumeration in interface org.apache.xerces.xs.XSSimpleTypeDefinition

getActualEnumeration

public org.apache.xerces.xs.datatypes.ObjectList getActualEnumeration()
A list of actual enumeration values if it exists, otherwise an empty ObjectList.


getEnumerationItemTypeList

public org.apache.xerces.xs.datatypes.ObjectList getEnumerationItemTypeList()
A list of enumeration type values (as a list of ShortList objects) if it exists, otherwise returns null


getEnumerationTypeList

public org.apache.xerces.xs.ShortList getEnumerationTypeList()

getLexicalPattern

public org.apache.xerces.xs.StringList getLexicalPattern()
A list of pattern values if it exists, otherwise an empty StringList.

Specified by:
getLexicalPattern in interface org.apache.xerces.xs.XSSimpleTypeDefinition

getAnnotations

public org.apache.xerces.xs.XSObjectList getAnnotations()
[annotations]: a set of annotations for this simple type component if it exists, otherwise an empty XSObjectList.

Specified by:
getAnnotations in interface org.apache.xerces.xs.XSSimpleTypeDefinition

derivedFromType

public boolean derivedFromType(org.apache.xerces.xs.XSTypeDefinition ancestor,
                               short derivation)
Description copied from interface: org.apache.xerces.xs.XSTypeDefinition
Convenience method which checks if this type is derived from the given ancestorType.

Specified by:
derivedFromType in interface org.apache.xerces.xs.XSTypeDefinition
Parameters:
ancestor - An ancestor type definition.
derivation - A bit combination representing a subset of { DERIVATION_RESTRICTION, DERIVATION_EXTENSION, DERIVATION_UNION, DERIVATION_LIST }.
Returns:
True if this type is derived from ancestorType using only derivation methods from the derivationMethod .

derivedFrom

public boolean derivedFrom(java.lang.String ancestorNS,
                           java.lang.String ancestorName,
                           short derivation)
Description copied from interface: org.apache.xerces.xs.XSTypeDefinition
Convenience method which checks if this type is derived from the given ancestor type.

Specified by:
derivedFrom in interface org.apache.xerces.xs.XSTypeDefinition
Parameters:
ancestorNS - An ancestor type namespace.
ancestorName - An ancestor type name.
derivation - A bit combination representing a subset of { DERIVATION_RESTRICTION, DERIVATION_EXTENSION, DERIVATION_UNION, DERIVATION_LIST }.
Returns:
True if this type is derived from ancestorType using only derivation methods from the derivationMethod .

isDOMDerivedFrom

public boolean isDOMDerivedFrom(java.lang.String ancestorNS,
                                java.lang.String ancestorName,
                                int derivationMethod)
Checks if a type is derived from another by restriction, given the name and namespace. See: http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/core.html#TypeInfo-isDerivedFrom

Parameters:
ancestorNS - The namspace of the ancestor type declaration
ancestorName - The name of the ancestor type declaration
derivationMethod - The derivation method
Returns:
boolean True if the ancestor type is derived from the reference type by the specifiied derivation method.

reset

public void reset()

getNamespaceItem

public org.apache.xerces.xs.XSNamespaceItem getNamespaceItem()
Description copied from interface: org.apache.xerces.xs.XSObject
A namespace schema information item corresponding to the target namespace of the component, if it is globally declared; or null otherwise.

Specified by:
getNamespaceItem in interface org.apache.xerces.xs.XSObject
See Also:
XSObject.getNamespaceItem()

setNamespaceItem

public void setNamespaceItem(org.apache.xerces.xs.XSNamespaceItem namespaceItem)

setContext

public void setContext(org.apache.xerces.xs.XSObject context)

getContext

public org.apache.xerces.xs.XSObject getContext()
Description copied from interface: org.apache.xerces.xs.XSTypeDefinition
A property that simplifies testing for the identity of anonymous type definitions. For complex type definition: 1. If the name [attribute] is present (with the exception of the type being redefined, number 2 below), then absent, otherwise the Element Declaration corresponding to that parent information item 2. In the case of redefine, the context of the redefined complex type is the redefining complex type definition For simple type definition, 1. If the name [attribute] is present (with the exception of the type being redefined, number 3 below), then absent 2. otherwise the appropriate case among the following: 2.1 If the parent element information item is attribute, then the corresponding Attribute Declaration 2.2 If the parent element information item is element, then the corresponding Element Declaration 2.3 If the parent element information item is list or union, then the Simple Type Definition corresponding to the grandparent simpleType element information item 2.4 otherwise (the parent element information item is restriction), the appropriate case among the following: 2.4.1 If the grandparent element information item is simpleType, then the Simple Type Definition corresponding to the grandparent 2.4.2 otherwise (the grandparent element information item is simpleContent), the Simple Type Definition which is the {content type} of the Complex Type Definition corresponding to the great-grandparent complexType element information item. 3. In the case of redefine, the context of the redefined simple type is the redefining simple type definition

Specified by:
getContext in interface org.apache.xerces.xs.XSTypeDefinition

toString

public java.lang.String toString()
See Also:
Object.toString()

getFacets

public org.apache.xerces.xs.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.

Specified by:
getFacets in interface org.apache.xerces.xs.XSSimpleTypeDefinition

getFacet

public org.apache.xerces.xs.XSObject getFacet(int facetType)
Description copied from interface: org.apache.xerces.xs.XSSimpleTypeDefinition
A constraining facet object. An instance of XSFacet or XSMultiValueFacet.

Specified by:
getFacet in interface org.apache.xerces.xs.XSSimpleTypeDefinition

getMultiValueFacets

public org.apache.xerces.xs.XSObjectList getMultiValueFacets()
A list of enumeration and pattern constraining facets if it exists, otherwise an empty XSObjectList.

Specified by:
getMultiValueFacets in interface org.apache.xerces.xs.XSSimpleTypeDefinition

getMinInclusiveValue

public java.lang.Object getMinInclusiveValue()

getMinExclusiveValue

public java.lang.Object getMinExclusiveValue()

getMaxInclusiveValue

public java.lang.Object getMaxInclusiveValue()

getMaxExclusiveValue

public java.lang.Object getMaxExclusiveValue()

setAnonymous

public void setAnonymous(boolean anon)

getTypeNamespace

public java.lang.String getTypeNamespace()
Description copied from interface: org.w3c.dom.TypeInfo
The namespace of the type declared for the associated element or attribute or null if the element does not have declaration or if no namespace information is available.

Specified by:
getTypeNamespace in interface org.w3c.dom.TypeInfo

isDerivedFrom

public boolean isDerivedFrom(java.lang.String typeNamespaceArg,
                             java.lang.String typeNameArg,
                             int derivationMethod)
Description copied from interface: org.w3c.dom.TypeInfo
This method returns if there is a derivation between the reference type definition, i.e. the TypeInfo on which the method is being called, and the other type definition, i.e. the one passed as parameters.

Specified by:
isDerivedFrom in interface org.w3c.dom.TypeInfo
Parameters:
typeNamespaceArg - the namespace of the other type definition.
typeNameArg - the name of the other type definition.
derivationMethod - the type of derivation and conditions applied between two types, as described in the list of constants provided in this interface.
Returns:
If the document's schema is a DTD or no schema is associated with the document, this method will always return false . If the document's schema is an XML Schema, the method will true if the reference type definition is derived from the other type definition according to the derivation parameter. If the value of the parameter is 0 (no bit is set to 1 for the derivationMethod parameter), the method will return true if the other type definition can be reached by recursing any combination of {base type definition}, {item type definition}, or {member type definitions} from the reference type definition.


Copyright © 1999-2020 The Apache Software Foundation. All Rights Reserved.