BuiltInAtomicType

java.lang.Object
- net.sf.saxon.type.BuiltInAtomicType

All Implemented Interfaces:

AtomicType, ItemType, ItemType.WithSequenceTypeCache, PlainType, SchemaComponent, SchemaType, SimpleType
```
public class BuiltInAtomicType
extends java.lang.Object
implements AtomicType, ItemType.WithSequenceTypeCache
```
This class represents a built-in atomic type, which may be either a primitive type (such as xs:decimal or xs:anyURI) or a derived type (such as xs:ID or xs:dayTimeDuration).

Nested Class Summary
- Nested classes/interfaces inherited from interface net.sf.saxon.type.ItemType
  ItemType.WithSequenceTypeCache

Field Summary

Fields
Modifier and Type	Field and Description
`static BuiltInAtomicType`	`ANY_ATOMIC`
`static BuiltInAtomicType`	`ANY_URI`
`static BuiltInAtomicType`	`BASE64_BINARY`
`static BuiltInAtomicType`	`BOOLEAN`
`static BuiltInAtomicType`	`BYTE`
`static BuiltInAtomicType`	`DATE`
`static BuiltInAtomicType`	`DATE_TIME`
`static BuiltInAtomicType`	`DATE_TIME_STAMP`
`static BuiltInAtomicType`	`DAY_TIME_DURATION`
`static BuiltInAtomicType`	`DECIMAL`
`static BuiltInAtomicType`	`DOUBLE`
`static BuiltInAtomicType`	`DURATION`
`static BuiltInAtomicType`	`ENTITY`
`static BuiltInAtomicType`	`FLOAT`
`static BuiltInAtomicType`	`G_DAY`
`static BuiltInAtomicType`	`G_MONTH`
`static BuiltInAtomicType`	`G_MONTH_DAY`
`static BuiltInAtomicType`	`G_YEAR`
`static BuiltInAtomicType`	`G_YEAR_MONTH`
`static BuiltInAtomicType`	`HEX_BINARY`
`static BuiltInAtomicType`	`ID`
`static BuiltInAtomicType`	`IDREF`
`static BuiltInAtomicType`	`INT`
`static BuiltInAtomicType`	`INTEGER`
`static BuiltInAtomicType`	`LANGUAGE`
`static BuiltInAtomicType`	`LONG`
`static BuiltInAtomicType`	`NAME`
`static BuiltInAtomicType`	`NCNAME`
`static BuiltInAtomicType`	`NEGATIVE_INTEGER`
`static BuiltInAtomicType`	`NMTOKEN`
`static BuiltInAtomicType`	`NON_NEGATIVE_INTEGER`
`static BuiltInAtomicType`	`NON_POSITIVE_INTEGER`
`static BuiltInAtomicType`	`NORMALIZED_STRING`
`static BuiltInAtomicType`	`NOTATION`
`static BuiltInAtomicType`	`POSITIVE_INTEGER`
`static BuiltInAtomicType`	`QNAME`
`static BuiltInAtomicType`	`SHORT`
`static BuiltInAtomicType`	`STRING`
`StringConverter`	`stringConverter`
`static BuiltInAtomicType`	`TIME`
`static BuiltInAtomicType`	`TOKEN`
`static BuiltInAtomicType`	`UNSIGNED_BYTE`
`static BuiltInAtomicType`	`UNSIGNED_INT`
`static BuiltInAtomicType`	`UNSIGNED_LONG`
`static BuiltInAtomicType`	`UNSIGNED_SHORT`
`static BuiltInAtomicType`	`UNTYPED_ATOMIC`
`static BuiltInAtomicType`	`YEAR_MONTH_DURATION`

Fields inherited from interface net.sf.saxon.type.SchemaType
DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION, DERIVE_BY_SUBSTITUTION

Fields inherited from interface net.sf.saxon.type.SchemaComponent
COMPONENT_FUNCTION_TYPE, FIXED_UP, INCOMPLETE, INVALID, UNVALIDATED, VALIDATED, VALIDATING

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`allowsDerivation(int derivation)` Determines whether derivation (of a particular kind) from this type is allowed, based on the "final" property
`void`	`analyzeContentExpression(Expression expression, int kind)` Analyze an expression to see whether the expression is capable of delivering a value of this type.
`static void`	`analyzeContentExpression(SimpleType simpleType, Expression expression, int kind)` Analyze an expression to see whether the expression is capable of delivering a value of this type.
`AtomicSequence`	`atomize(NodeInfo node)` Get the typed value of a node that is annotated with this schema type.
`void`	`checkTypeDerivationIsOK(SchemaType type, int block)` Check that this type is validly derived from a given type
`boolean`	`equals(java.lang.Object obj)` Two types are equal if they have the same fingerprint.
`java.lang.String`	`generateJavaScriptItemTypeAcceptor(java.lang.String errorCode, int targetVersion)` Generate Javascript code to convert a supplied Javascript value to this item type, if conversion is possible, or throw an error otherwise.
`java.lang.String`	`generateJavaScriptItemTypeTest(ItemType knownToBe, int targetVersion)` Generate Javascript code to test whether an item conforms to this item type
`AtomicType`	`getAtomizedItemType()` Get the item type of the atomic values that will be produced when an item of this type is atomized
`SchemaType`	`getBaseType()` Returns the base type that this type inherits from.
`int`	`getBlock()` Returns the value of the 'block' attribute for this type, as a bit-significant integer with fields such as `SchemaType.DERIVATION_LIST` and `SchemaType.DERIVATION_EXTENSION`
`SchemaType`	`getBuiltInBaseType()` Returns the built-in base type this type is derived from.
`Function`	`getComponentAsFunction()` Get the schema component in the form of a function item.
`int`	`getDerivationMethod()` Gets the integer code of the derivation method used to derive this type from its parent.
`java.lang.String`	`getDescription()` Get a description of this type for use in error messages.
`java.lang.String`	`getDisplayName()` Get the display name of the type: that is, a lexical QName with an arbitrary prefix
`java.lang.String`	`getEQName()` Get the name of this type as an EQName, that is, a string in the format Q{uri}local.
`int`	`getFinalProhibitions()` Get the types of derivation that are not permitted, by virtue of the "final" property.
`int`	`getFingerprint()` Get the fingerprint of the name of this type
`SchemaType`	`getKnownBaseType()` Returns the base type that this type inherits from.
`java.lang.String`	`getName()` Get the local name of this type
`java.util.Set<? extends PlainType>`	`getPlainMemberTypes()` Get the list of plain types that are subsumed by this type
`BuiltInAtomicType`	`getPrimitiveItemType()` Get the primitive item type corresponding to this item type.
`int`	`getPrimitiveType()` Get the primitive type corresponding to this item type.
`int`	`getRedefinitionLevel()` Get the redefinition level.
`StringConverter`	`getStringConverter(ConversionRules rules)` Get a StringConverter, an object that converts strings in the lexical space of this data type to instances (in the value space) of the data type.
`StructuredQName`	`getStructuredQName()` Get the name of the type as a QName
`java.lang.String`	`getSystemId()` Get the URI of the schema document where the type was originally defined.
`java.lang.String`	`getTargetNamespace()` Get the target namespace of this type
`AtomicSequence`	`getTypedValue(java.lang.CharSequence value, NamespaceResolver resolver, ConversionRules rules)` Get the typed value corresponding to a given string value, assuming it is valid against this type (and that the containing node is not nilled)
`StructuredQName`	`getTypeName()` Get the name of this type as a StructuredQName, unless the type is anonymous, in which case return null
`UType`	`getUType()` Get the corresponding `UType`.
`int`	`getValidationStatus()` Get the validation status - always valid
`int`	`getWhitespaceAction()` Determine the whitespace normalization required for values of this type
`int`	`hashCode()` The fingerprint can be used as a hashcode
`boolean`	`isAbstract()` Determine whether the type is abstract, that is, whether it cannot have instances that are not also instances of some concrete subtype
`boolean`	`isAllowedInXSD10()` Determine whether this type is supported when using XSD 1.0
`boolean`	`isAnonymousType()` Ask whether this is an anonymous type
`boolean`	`isAtomicType()` Test whether this Simple Type is an atomic type
`boolean`	`isAtomizable()` Ask whether values of this type are atomizable
`boolean`	`isBuiltInType()` Determine whether this is a built-in type or a user-defined type
`boolean`	`isComplexType()` Ask whether this SchemaType is a complex type
`boolean`	`isExternalType()` Return true if this is an external object type, that is, a Saxon-defined type for external Java or .NET objects
`boolean`	`isIdRefType()` Ask whether this type is an IDREF or IDREFS type.
`boolean`	`isIdType()` Ask whether this type is an ID type.
`boolean`	`isListType()` Returns true if this type is derived by list, or if it is derived by restriction from a list type, or if it is a union that contains a list as one of its members
`boolean`	`isNamespaceSensitive()` Test whether this simple type is namespace-sensitive, that is, whether it is derived from xs:QName or xs:NOTATION
`boolean`	`isNumericType()` Ask whether a built-in type is a numeric type (integer, float, double)
`boolean`	`isOrdered(boolean optimistic)` Determine whether the atomic type is ordered, that is, whether less-than and greater-than comparisons are permitted
`boolean`	`isPlainType()` Ask whether this is a plain type (a type whose instances are always atomic values)
`boolean`	`isPrimitiveNumeric()` Determine whether the atomic type is numeric
`boolean`	`isPrimitiveType()` Ask whether the atomic type is a primitive type.
`boolean`	`isSameType(SchemaType other)` Test whether this is the same type as another type.
`boolean`	`isSimpleType()` Returns true if this SchemaType is a SimpleType
`boolean`	`isUnionType()` Return true if this type is a union type (that is, if its variety is union)
`boolean`	`matches(Item item, TypeHierarchy th)` Test whether a given item conforms to this type
`SequenceType`	`one()` Get a sequence type representing exactly one instance of this atomic type
`SequenceType`	`oneOrMore()` Get a sequence type representing one or more instances of this atomic type
`java.lang.CharSequence`	`postprocess(java.lang.CharSequence input)` Reverse any pre-lexical facets, other than whitespace.
`java.lang.CharSequence`	`preprocess(java.lang.CharSequence input)` Apply any pre-lexical facets, other than whitespace.
`void`	`setBaseTypeFingerprint(int baseFingerprint)` Set the base type of this type
`java.lang.String`	`toExportString()` Return a string representation of this SequenceType suitable for use in export (SEF) files.
`java.lang.String`	`toString()`
`ValidationFailure`	`validate(AtomicValue primValue, java.lang.CharSequence lexicalValue, ConversionRules rules)` Validate that a primitive atomic value is a valid instance of a type derived from the same primitive type.
`ValidationFailure`	`validateContent(java.lang.CharSequence value, NamespaceResolver nsResolver, ConversionRules rules)` Check whether a given input string is valid according to this SimpleType
`void`	`visitNamedSchemaComponents(SchemaComponentVisitor visitor)` Visit all the schema components used in this ItemType definition
`SequenceType`	`zeroOrMore()` Get a sequence type representing one or more instances of this atomic type
`SequenceType`	`zeroOrOne()` Get a sequence type representing zero or one instances of this atomic type

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - stringConverter
```
public StringConverter stringConverter
```
  - ANY_ATOMIC
```
public static final BuiltInAtomicType ANY_ATOMIC
```
  - STRING
```
public static final BuiltInAtomicType STRING
```
  - BOOLEAN
```
public static final BuiltInAtomicType BOOLEAN
```
  - DURATION
```
public static final BuiltInAtomicType DURATION
```
  - DATE_TIME
```
public static final BuiltInAtomicType DATE_TIME
```
  - DATE
```
public static final BuiltInAtomicType DATE
```
  - TIME
```
public static final BuiltInAtomicType TIME
```
  - G_YEAR_MONTH
```
public static final BuiltInAtomicType G_YEAR_MONTH
```
  - G_MONTH
```
public static final BuiltInAtomicType G_MONTH
```
  - G_MONTH_DAY
```
public static final BuiltInAtomicType G_MONTH_DAY
```
  - G_YEAR
```
public static final BuiltInAtomicType G_YEAR
```
  - G_DAY
```
public static final BuiltInAtomicType G_DAY
```
  - HEX_BINARY
```
public static final BuiltInAtomicType HEX_BINARY
```
  - BASE64_BINARY
```
public static final BuiltInAtomicType BASE64_BINARY
```
  - ANY_URI
```
public static final BuiltInAtomicType ANY_URI
```
  - QNAME
```
public static final BuiltInAtomicType QNAME
```
  - NOTATION
```
public static final BuiltInAtomicType NOTATION
```
  - UNTYPED_ATOMIC
```
public static final BuiltInAtomicType UNTYPED_ATOMIC
```
  - DECIMAL
```
public static final BuiltInAtomicType DECIMAL
```
  - FLOAT
```
public static final BuiltInAtomicType FLOAT
```
  - DOUBLE
```
public static final BuiltInAtomicType DOUBLE
```
  - INTEGER
```
public static final BuiltInAtomicType INTEGER
```
  - NON_POSITIVE_INTEGER
```
public static final BuiltInAtomicType NON_POSITIVE_INTEGER
```
  - NEGATIVE_INTEGER
```
public static final BuiltInAtomicType NEGATIVE_INTEGER
```
  - LONG
```
public static final BuiltInAtomicType LONG
```
  - INT
```
public static final BuiltInAtomicType INT
```
  - SHORT
```
public static final BuiltInAtomicType SHORT
```
  - BYTE
```
public static final BuiltInAtomicType BYTE
```
  - NON_NEGATIVE_INTEGER
```
public static final BuiltInAtomicType NON_NEGATIVE_INTEGER
```
  - POSITIVE_INTEGER
```
public static final BuiltInAtomicType POSITIVE_INTEGER
```
  - UNSIGNED_LONG
```
public static final BuiltInAtomicType UNSIGNED_LONG
```
  - UNSIGNED_INT
```
public static final BuiltInAtomicType UNSIGNED_INT
```
  - UNSIGNED_SHORT
```
public static final BuiltInAtomicType UNSIGNED_SHORT
```
  - UNSIGNED_BYTE
```
public static final BuiltInAtomicType UNSIGNED_BYTE
```
  - YEAR_MONTH_DURATION
```
public static final BuiltInAtomicType YEAR_MONTH_DURATION
```
  - DAY_TIME_DURATION
```
public static final BuiltInAtomicType DAY_TIME_DURATION
```
  - NORMALIZED_STRING
```
public static final BuiltInAtomicType NORMALIZED_STRING
```
  - TOKEN
```
public static final BuiltInAtomicType TOKEN
```
  - LANGUAGE
```
public static final BuiltInAtomicType LANGUAGE
```
  - NAME
```
public static final BuiltInAtomicType NAME
```
  - NMTOKEN
```
public static final BuiltInAtomicType NMTOKEN
```
  - NCNAME
```
public static final BuiltInAtomicType NCNAME
```
  - ID
```
public static final BuiltInAtomicType ID
```
  - IDREF
```
public static final BuiltInAtomicType IDREF
```
  - ENTITY
```
public static final BuiltInAtomicType ENTITY
```
  - DATE_TIME_STAMP
```
public static final BuiltInAtomicType DATE_TIME_STAMP
```
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Get the local name of this type
    
    Specified by:
    
    getName in interface SchemaType
    
    Returns:
    
    the local name of this type definition, if it has one. Return null in the case of an anonymous type.
  - getUType
```
public UType getUType()
```
    Get the corresponding UType. A UType is a union of primitive item types.
    
    Specified by:
    
    getUType in interface ItemType
    
    Returns:
    
    the smallest UType that subsumes this item type
  - getTargetNamespace
```
public java.lang.String getTargetNamespace()
```
    Get the target namespace of this type
    
    Specified by:
    
    getTargetNamespace in interface SchemaType
    
    Returns:
    
    the target namespace of this type definition, if it has one. Return null in the case of an anonymous type, and in the case of a global type defined in a no-namespace schema.
  - getEQName
```
public java.lang.String getEQName()
```
    Get the name of this type as an EQName, that is, a string in the format Q{uri}local.
    
    Specified by:
    
    getEQName in interface SchemaType
    
    Returns:
    
    an EQName identifying the type.
  - isAbstract
```
public boolean isAbstract()
```
    Determine whether the type is abstract, that is, whether it cannot have instances that are not also instances of some concrete subtype
    
    Specified by:
    
    isAbstract in interface AtomicType
    
    Returns:
    
    true if the type is abstract
  - isExternalType
```
public boolean isExternalType()
```
    Return true if this is an external object type, that is, a Saxon-defined type for external Java or .NET objects
    
    Specified by:
    
    isExternalType in interface PlainType
    
    Specified by:
    
    isExternalType in interface SimpleType
    
    Returns:
    
    true if this is an external type
  - isBuiltInType
```
public boolean isBuiltInType()
```
    Determine whether this is a built-in type or a user-defined type
    
    Specified by:
    
    isBuiltInType in interface AtomicType
    
    Specified by:
    
    isBuiltInType in interface SimpleType
    
    Returns:
    
    true if this is a built-in type
  - getTypeName
```
public StructuredQName getTypeName()
```
    Get the name of this type as a StructuredQName, unless the type is anonymous, in which case return null
    
    Specified by:
    
    getTypeName in interface AtomicType
    
    Specified by:
    
    getTypeName in interface PlainType
    
    Returns:
    
    the name of the atomic type, or null if the type is anonymous.
  - one
```
public SequenceType one()
```
    Get a sequence type representing exactly one instance of this atomic type
    
    Specified by:
    
    one in interface ItemType.WithSequenceTypeCache
    
    Returns:
    
    a sequence type representing exactly one instance of this atomic type
    
    Since:
    
    9.8.0.2
  - zeroOrOne
```
public SequenceType zeroOrOne()
```
    Get a sequence type representing zero or one instances of this atomic type
    
    Specified by:
    
    zeroOrOne in interface ItemType.WithSequenceTypeCache
    
    Returns:
    
    a sequence type representing zero or one instances of this atomic type
    
    Since:
    
    9.8.0.2
  - oneOrMore
```
public SequenceType oneOrMore()
```
    Get a sequence type representing one or more instances of this atomic type
    
    Specified by:
    
    oneOrMore in interface ItemType.WithSequenceTypeCache
    
    Returns:
    
    a sequence type representing one or more instances of this atomic type
    
    Since:
    
    9.8.0.2
  - zeroOrMore
```
public SequenceType zeroOrMore()
```
    Get a sequence type representing one or more instances of this atomic type
    
    Specified by:
    
    zeroOrMore in interface ItemType.WithSequenceTypeCache
    
    Returns:
    
    a sequence type representing one or more instances of this atomic type
    
    Since:
    
    9.8.0.2
  - getRedefinitionLevel
```
public int getRedefinitionLevel()
```
    Get the redefinition level. This is zero for a component that has not been redefined; for a redefinition of a level-0 component, it is 1; for a redefinition of a level-N component, it is N+1. This concept is used to support the notion of "pervasive" redefinition: if a component is redefined at several levels, the top level wins, but it is an error to have two versions of the component at the same redefinition level.
    
    Specified by:
    
    getRedefinitionLevel in interface SchemaComponent
    
    Returns:
    
    the redefinition level
  - isOrdered
```
public boolean isOrdered(boolean optimistic)
```
    Determine whether the atomic type is ordered, that is, whether less-than and greater-than comparisons are permitted
    
    Specified by:
    
    isOrdered in interface AtomicType
    
    Parameters:
    
    optimistic - if true, the function takes an optimistic view, returning true if ordering comparisons are available for some subtype. This mainly affects xs:duration, where the function returns true if optimistic is true, false if it is false.
    
    Returns:
    
    true if ordering operations are permitted
  - getSystemId
```
public java.lang.String getSystemId()
```
    Get the URI of the schema document where the type was originally defined.
    
    Specified by:
    
    getSystemId in interface SchemaType
    
    Returns:
    
    the URI of the schema document. Returns null if the information is unknown or if this is a built-in type
  - isPrimitiveNumeric
```
public boolean isPrimitiveNumeric()
```
    Determine whether the atomic type is numeric
    
    Returns:
    
    true if the type is a built-in numeric type
  - getValidationStatus
```
public final int getValidationStatus()
```
    Get the validation status - always valid
    
    Specified by:
    
    getValidationStatus in interface SchemaComponent
    
    Returns:
    
    one of the values SchemaComponent.UNVALIDATED, SchemaComponent.VALIDATING, SchemaComponent.VALIDATED, SchemaComponent.INVALID, SchemaComponent.INCOMPLETE
  - getBlock
```
public final int getBlock()
```
    Returns the value of the 'block' attribute for this type, as a bit-significant integer with fields such as SchemaType.DERIVATION_LIST and SchemaType.DERIVATION_EXTENSION
    
    Specified by:
    
    getBlock in interface SchemaType
    
    Returns:
    
    the value of the 'block' attribute for this type
  - getDerivationMethod
```
public final int getDerivationMethod()
```
    Gets the integer code of the derivation method used to derive this type from its parent. Returns zero for primitive types.
    
    Specified by:
    
    getDerivationMethod in interface SchemaType
    
    Returns:
    
    a numeric code representing the derivation method, for example SchemaType.DERIVATION_RESTRICTION
  - allowsDerivation
```
public final boolean allowsDerivation(int derivation)
```
    Determines whether derivation (of a particular kind) from this type is allowed, based on the "final" property
    
    Specified by:
    
    allowsDerivation in interface SchemaType
    
    Parameters:
    
    derivation - the kind of derivation, for example SchemaType.DERIVATION_LIST
    
    Returns:
    
    true if this kind of derivation is allowed
  - getFinalProhibitions
```
public int getFinalProhibitions()
```
    Get the types of derivation that are not permitted, by virtue of the "final" property.
    
    Specified by:
    
    getFinalProhibitions in interface SchemaType
    
    Returns:
    
    the types of derivation that are not permitted, as a bit-significant integer containing bits such as SchemaType.DERIVATION_EXTENSION
  - setBaseTypeFingerprint
```
public final void setBaseTypeFingerprint(int baseFingerprint)
```
    Set the base type of this type
    
    Parameters:
    
    baseFingerprint - the namepool fingerprint of the name of the base type
  - getFingerprint
```
public final int getFingerprint()
```
    Get the fingerprint of the name of this type
    
    Specified by:
    
    getFingerprint in interface SchemaType
    
    Returns:
    
    the fingerprint. Returns an invented fingerprint for an anonymous type.
  - getStructuredQName
```
public final StructuredQName getStructuredQName()
```
    Get the name of the type as a QName
    
    Specified by:
    
    getStructuredQName in interface SchemaType
    
    Returns:
    
    a StructuredQName containing the name of the type. The conventional prefix "xs" is used to represent the XML Schema namespace
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Get the display name of the type: that is, a lexical QName with an arbitrary prefix
    
    Specified by:
    
    getDisplayName in interface SchemaType
    
    Returns:
    
    a lexical QName identifying the type
  - isPrimitiveType
```
public final boolean isPrimitiveType()
```
    Ask whether the atomic type is a primitive type. The primitive types are the 19 primitive types of XML Schema, plus xs:integer, xs:dayTimeDuration and xs:yearMonthDuration; xs:untypedAtomic; and all supertypes of these (xs:anyAtomicType, xs:numeric, ...)
    
    Specified by:
    
    isPrimitiveType in interface AtomicType
    
    Returns:
    
    true if the type is considered primitive under the above rules
  - isComplexType
```
public final boolean isComplexType()
```
    Ask whether this SchemaType is a complex type
    
    Specified by:
    
    isComplexType in interface SchemaType
    
    Returns:
    
    true if this SchemaType is a complex type
  - isAnonymousType
```
public final boolean isAnonymousType()
```
    Ask whether this is an anonymous type
    
    Specified by:
    
    isAnonymousType in interface SchemaType
    
    Returns:
    
    true if this SchemaType is an anonymous type
  - isPlainType
```
public boolean isPlainType()
```
    Ask whether this is a plain type (a type whose instances are always atomic values)
    
    Specified by:
    
    isPlainType in interface ItemType
    
    Returns:
    
    true
  - getBaseType
```
public final SchemaType getBaseType()
```
    Returns the base type that this type inherits from. This method can be used to get the base type of a type that is known to be valid. If this type is a Simpletype that is a built in primitive type then null is returned.
    
    Specified by:
    
    getBaseType in interface SchemaType
    
    Returns:
    
    the base type.
    
    Throws:
    
    java.lang.IllegalStateException - if this type is not valid.
  - matches
```
public boolean matches(Item item,
                       TypeHierarchy th)
```
    Test whether a given item conforms to this type
    
    Specified by:
    
    matches in interface ItemType
    
    Specified by:
    
    matches in interface PlainType
    
    Parameters:
    
    item - The item to be tested
    
    th -
    
    Returns:
    
    true if the item is an instance of this type; false otherwise
  - getPrimitiveItemType
```
public BuiltInAtomicType getPrimitiveItemType()
```
    Get the primitive item type corresponding to this item type. For item(), this is Type.ITEM. For node(), it is Type.NODE. For specific node kinds, it is the value representing the node kind, for example Type.ELEMENT. For anyAtomicValue it is Type.ATOMIC_VALUE. For numeric it is Type.NUMBER. For other atomic types it is the primitive type as defined in XML Schema, except that INTEGER is considered to be a primitive type.
    
    Specified by:
    
    getPrimitiveItemType in interface ItemType
    
    Specified by:
    
    getPrimitiveItemType in interface PlainType
    
    Returns:
    
    the corresponding primitive type (this is an instance of BuiltInAtomicType in all cases except where this type is xs:error. The class ErrorType does not inherit from BuiltInAtomicType because of multiple inheritance problems).
  - getPrimitiveType
```
public int getPrimitiveType()
```
    Get the primitive type corresponding to this item type. For item(), this is Type.ITEM. For node(), it is Type.NODE. For specific node kinds, it is the value representing the node kind, for example Type.ELEMENT. For anyAtomicValue it is Type.ATOMIC_VALUE. For numeric it is Type.NUMBER. For other atomic types it is the primitive type as defined in XML Schema, except that INTEGER is considered to be a primitive type.
    
    Specified by:
    
    getPrimitiveType in interface ItemType
    
    Returns:
    
    the integer fingerprint of the corresponding primitive type
  - isAllowedInXSD10
```
public boolean isAllowedInXSD10()
```
    Determine whether this type is supported when using XSD 1.0
    
    Returns:
    
    true if this type is permitted in XSD 1.0
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface ItemType
    
    Overrides:
    
    toString in class java.lang.Object
  - toExportString
```
public java.lang.String toExportString()
```
    Return a string representation of this SequenceType suitable for use in export (SEF) files. The difference from the toString() method is that the representation will not contain references to anonymous types.
    
    Specified by:
    
    toExportString in interface ItemType
    
    Returns:
    
    the string representation as an instance of the XPath SequenceType construct, using only names that will be in-scope if the target environment imports the same schema as the source environment
  - getAtomizedItemType
```
public AtomicType getAtomizedItemType()
```
    Get the item type of the atomic values that will be produced when an item of this type is atomized
    
    Specified by:
    
    getAtomizedItemType in interface ItemType
    
    Returns:
    
    the best available item type of the atomic values that will be produced when an item of this type is atomized, or null if it is known that atomization will throw an error.
  - isAtomizable
```
public boolean isAtomizable()
```
    Ask whether values of this type are atomizable
    
    Specified by:
    
    isAtomizable in interface ItemType
    
    Returns:
    
    true unless it is known that these items will be elements with element-only content, in which case return false
  - getKnownBaseType
```
public SchemaType getKnownBaseType()
```
    Returns the base type that this type inherits from. This method can be used to get the base type of a type that is known to be valid. If this type is a Simpletype that is a built in primitive type then null is returned.
    
    Returns:
    
    the base type.
    
    Throws:
    
    java.lang.IllegalStateException - if this type is not valid.
  - isSameType
```
public boolean isSameType(SchemaType other)
```
    Test whether this is the same type as another type. They are considered to be the same type if they are derived from the same type definition in the original XML representation (which can happen when there are multiple includes of the same file)
    
    Specified by:
    
    isSameType in interface SchemaType
    
    Parameters:
    
    other - the other type
    
    Returns:
    
    true if this is the same type as other
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from interface: SchemaType
    
    Get a description of this type for use in error messages. This is the same as the display name in the case of named types; for anonymous types it identifies the type by its position in a source schema document.
    
    Specified by:
    
    getDescription in interface SchemaType
    
    Returns:
    
    text identifing the type, for use in a phrase such as "the type XXXX".
  - checkTypeDerivationIsOK
```
public void checkTypeDerivationIsOK(SchemaType type,
                                    int block)
                             throws SchemaException
```
    Check that this type is validly derived from a given type
    
    Specified by:
    
    checkTypeDerivationIsOK in interface SchemaType
    
    Parameters:
    
    type - the type from which this type is derived
    
    block - the derivations that are blocked by the relevant element declaration
    
    Throws:
    
    SchemaException - if the derivation is not allowed
  - isSimpleType
```
public final boolean isSimpleType()
```
    Returns true if this SchemaType is a SimpleType
    
    Specified by:
    
    isSimpleType in interface SchemaType
    
    Returns:
    
    true (always)
  - isAtomicType
```
public boolean isAtomicType()
```
    Test whether this Simple Type is an atomic type
    
    Specified by:
    
    isAtomicType in interface ItemType
    
    Specified by:
    
    isAtomicType in interface SchemaType
    
    Specified by:
    
    isAtomicType in interface SimpleType
    
    Returns:
    
    true, this is an atomic type
  - isIdType
```
public boolean isIdType()
```
    Ask whether this type is an ID type. This is defined to be any simple type who typed value may contain atomic values of type xs:ID: that is, it includes types derived from ID by restriction, list, or union. Note that for a node to be treated as an ID, its typed value must be a *single* atomic value of type ID; the type of the node, however, can still allow a list.
    
    Specified by:
    
    isIdType in interface SchemaType
    
    Returns:
    
    true if this type is an ID type
  - isIdRefType
```
public boolean isIdRefType()
```
    Ask whether this type is an IDREF or IDREFS type. This is defined to be any simple type who typed value may contain atomic values of type xs:IDREF: that is, it includes types derived from IDREF or IDREFS by restriction, list, or union
    
    Specified by:
    
    isIdRefType in interface SchemaType
    
    Returns:
    
    true if this type is an IDREF type
  - isListType
```
public boolean isListType()
```
    Returns true if this type is derived by list, or if it is derived by restriction from a list type, or if it is a union that contains a list as one of its members
    
    Specified by:
    
    isListType in interface SimpleType
    
    Returns:
    
    true if this is a list type
  - isUnionType
```
public boolean isUnionType()
```
    Return true if this type is a union type (that is, if its variety is union)
    
    Specified by:
    
    isUnionType in interface SimpleType
    
    Returns:
    
    true for a union type
  - getWhitespaceAction
```
public int getWhitespaceAction()
```
    Determine the whitespace normalization required for values of this type
    
    Specified by:
    
    getWhitespaceAction in interface SimpleType
    
    Returns:
    
    one of PRESERVE, REPLACE, COLLAPSE
  - getBuiltInBaseType
```
public SchemaType getBuiltInBaseType()
```
    Returns the built-in base type this type is derived from.
    
    Specified by:
    
    getBuiltInBaseType in interface SimpleType
    
    Returns:
    
    the first built-in type found when searching up the type hierarchy
  - isNamespaceSensitive
```
public boolean isNamespaceSensitive()
```
    Test whether this simple type is namespace-sensitive, that is, whether it is derived from xs:QName or xs:NOTATION
    
    Specified by:
    
    isNamespaceSensitive in interface SimpleType
    
    Returns:
    
    true if this type is derived from xs:QName or xs:NOTATION. Note that the result for xs:anyAtomicType is false, even though an instance might be a QName.
  - validateContent
```
public ValidationFailure validateContent(java.lang.CharSequence value,
                                         NamespaceResolver nsResolver,
                                         ConversionRules rules)
```
    Check whether a given input string is valid according to this SimpleType
    
    Specified by:
    
    validateContent in interface SimpleType
    
    Parameters:
    
    value - the input string to be checked
    
    nsResolver - a namespace resolver used to resolve namespace prefixes if the type is namespace sensitive. The value supplied may be null; in this case any namespace-sensitive content will throw an UnsupportedOperationException.
    
    rules - conversion rules e.g for namespace-sensitive content
    
    Returns:
    
    XPathException if the value is invalid. Note that the exception is returned rather than being thrown. Returns null if the value is valid.
    
    Throws:
    
    java.lang.UnsupportedOperationException - if the type is namespace-sensitive and no namespace resolver is supplied
  - getStringConverter
```
public StringConverter getStringConverter(ConversionRules rules)
```
    Get a StringConverter, an object that converts strings in the lexical space of this data type to instances (in the value space) of the data type.
    
    Specified by:
    
    getStringConverter in interface AtomicType
    
    Parameters:
    
    rules - the conversion rules to be used
    
    Returns:
    
    a StringConverter to do the conversion. Note that in the case of namespace-sensitive types, the resulting converter needs to be supplied with a NamespaceResolver to handle prefix resolution.
  - atomize
```
public AtomicSequence atomize(NodeInfo node)
                       throws XPathException
```
    Get the typed value of a node that is annotated with this schema type.
    
    Specified by:
    
    atomize in interface SchemaType
    
    Parameters:
    
    node - the node whose typed value is required
    
    Returns:
    
    the typed value.
    
    Throws:
    
    XPathException - if the node cannot be atomized, for example if this is a complex type with element-only content
    
    Since:
    
    8.5
  - getTypedValue
```
public AtomicSequence getTypedValue(java.lang.CharSequence value,
                                    NamespaceResolver resolver,
                                    ConversionRules rules)
                             throws ValidationException
```
    Get the typed value corresponding to a given string value, assuming it is valid against this type (and that the containing node is not nilled)
    
    Specified by:
    
    getTypedValue in interface SimpleType
    
    Parameters:
    
    value - the string value
    
    resolver - a namespace resolver used to resolve any namespace prefixes appearing in the content of values. Can supply null, in which case any namespace-sensitive content will be rejected.
    
    rules - the conversion rules to be used
    
    Returns:
    
    an iterator over the atomic sequence comprising the typed value. The objects returned by this SequenceIterator will all be of type AtomicValue
    
    Throws:
    
    ValidationException - This method should be called only if it is known that the value is valid. If the value is not valid, there is no guarantee that this method will perform validation, but if it does detect a validity error, then it MAY throw a ValidationException.
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Two types are equal if they have the same fingerprint. Note: it is normally safe to use ==, because we always use the static constants, one instance for each built in atomic type. However, after serialization and deserialization a different instance can appear.
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    The fingerprint can be used as a hashcode
    
    Overrides:
    
    hashCode in class java.lang.Object
  - validate
```
public ValidationFailure validate(AtomicValue primValue,
                                  java.lang.CharSequence lexicalValue,
                                  ConversionRules rules)
```
    Validate that a primitive atomic value is a valid instance of a type derived from the same primitive type.
    
    Specified by:
    
    validate in interface AtomicType
    
    Parameters:
    
    primValue - the value in the value space of the primitive type.
    
    lexicalValue - the value in the lexical space. If null, the string value of primValue is used. This value is checked against the pattern facet (if any)
    
    rules - the conversion rules to be used
    
    Returns:
    
    null if the value is valid; otherwise, a ValidationFailure object indicating the nature of the error.
    
    Throws:
    
    java.lang.UnsupportedOperationException - in the case of an external object type
  - analyzeContentExpression
```
public void analyzeContentExpression(Expression expression,
                                     int kind)
                              throws XPathException
```
    Analyze an expression to see whether the expression is capable of delivering a value of this type.
    
    Specified by:
    
    analyzeContentExpression in interface SchemaType
    
    Parameters:
    
    expression - the expression that delivers the content
    
    kind - the node kind whose content is being delivered: Type.ELEMENT, Type.ATTRIBUTE, or Type.DOCUMENT
    
    Throws:
    
    XPathException - if the expression will never deliver a value of the correct type
  - analyzeContentExpression
```
public static void analyzeContentExpression(SimpleType simpleType,
                                            Expression expression,
                                            int kind)
                                     throws XPathException
```
    Analyze an expression to see whether the expression is capable of delivering a value of this type.
    
    Parameters:
    
    simpleType - the simple type against which the expression is to be checked
    
    expression - the expression that delivers the content
    
    kind - the node kind whose content is being delivered: Type.ELEMENT, Type.ATTRIBUTE, or Type.DOCUMENT
    
    Throws:
    
    XPathException - if the expression will never deliver a value of the correct type
  - preprocess
```
public java.lang.CharSequence preprocess(java.lang.CharSequence input)
```
    Apply any pre-lexical facets, other than whitespace. At the moment the only such facet is saxon:preprocess
    
    Specified by:
    
    preprocess in interface SimpleType
    
    Parameters:
    
    input - the value to be preprocessed
    
    Returns:
    
    the value after preprocessing
  - postprocess
```
public java.lang.CharSequence postprocess(java.lang.CharSequence input)
                                   throws ValidationException
```
    Reverse any pre-lexical facets, other than whitespace. At the moment the only such facet is saxon:preprocess. This is called when converting a value of this type to a string
    
    Specified by:
    
    postprocess in interface SimpleType
    
    Parameters:
    
    input - the value to be postprocessed: this is the "ordinary" result of converting the value to a string
    
    Returns:
    
    the value after postprocessing
    
    Throws:
    
    ValidationException - if postprocessing detects that the value is invalid
  - visitNamedSchemaComponents
```
public void visitNamedSchemaComponents(SchemaComponentVisitor visitor)
                                throws XPathException
```
    Visit all the schema components used in this ItemType definition
    
    Specified by:
    
    visitNamedSchemaComponents in interface ItemType
    
    Parameters:
    
    visitor - the visitor class to be called when each component is visited
    
    Throws:
    
    XPathException - if an error occurs
  - getPlainMemberTypes
```
public java.util.Set<? extends PlainType> getPlainMemberTypes()
```
    Get the list of plain types that are subsumed by this type
    
    Specified by:
    
    getPlainMemberTypes in interface PlainType
    
    Returns:
    
    for an atomic type, the type itself; for a plain union type, the list of plain types in its transitive membership, in declaration order
  - isNumericType
```
public boolean isNumericType()
```
    Ask whether a built-in type is a numeric type (integer, float, double)
    
    Returns:
    
    true if the type is numeric
  - generateJavaScriptItemTypeTest
```
public java.lang.String generateJavaScriptItemTypeTest(ItemType knownToBe,
                                                       int targetVersion)
                                                throws XPathException
```
    Generate Javascript code to test whether an item conforms to this item type
    
    Specified by:
    
    generateJavaScriptItemTypeTest in interface ItemType
    
    Parameters:
    
    knownToBe - a type that the item is known to conform to
    
    targetVersion - 1 or 2 depending on the version of Saxon-JS we are targeting
    
    Returns:
    
    a Javascript instruction or sequence of instructions, which can be used as the body of a Javascript function, and which returns a boolean indication whether the value of the variable "item" is an instance of this item type.
    
    Throws:
    
    XPathException - if JS code cannot be generated for this item type, for example because the test is schema-aware.
  - generateJavaScriptItemTypeAcceptor
```
public java.lang.String generateJavaScriptItemTypeAcceptor(java.lang.String errorCode,
                                                           int targetVersion)
                                                    throws XPathException
```
    Generate Javascript code to convert a supplied Javascript value to this item type, if conversion is possible, or throw an error otherwise.
    
    Specified by:
    
    generateJavaScriptItemTypeAcceptor in interface ItemType
    
    Parameters:
    
    errorCode - the error to be thrown if conversion is not possible
    
    targetVersion - 1 or 2 depending on the version of Saxon-JS we are targeting
    
    Returns:
    
    a Javascript instruction or sequence of instructions, which can be used as the body of a Javascript function, and which returns the result of conversion to this type, or throws an error if conversion is not possible. The variable "val" will hold the supplied Javascript value.
    
    Throws:
    
    XPathException
  - getComponentAsFunction
```
public Function getComponentAsFunction()
```
    Description copied from interface: SchemaComponent
    
    Get the schema component in the form of a function item. This allows schema information to be made visible to XSLT or XQuery code. The function makes available the contents of the schema component as defined in the XSD specification. The function takes a string as argument representing a property name, and returns the corresponding property of the schema component. There is also a property "class" which returns the kind of schema component, for example "Attribute Declaration".
    
    Specified by:
    
    getComponentAsFunction in interface SchemaComponent
    
    Returns:
    
    the schema component represented as a function from property names to property values.

Class BuiltInAtomicType

Nested Class Summary

Nested classes/interfaces inherited from interface net.sf.saxon.type.ItemType

Field Summary

Fields inherited from interface net.sf.saxon.type.SchemaType

Fields inherited from interface net.sf.saxon.type.SchemaComponent

Method Summary

Methods inherited from class java.lang.Object

Field Detail

stringConverter

ANY_ATOMIC

STRING

BOOLEAN

DURATION

DATE_TIME

DATE

TIME

G_YEAR_MONTH

G_MONTH

G_MONTH_DAY

G_YEAR

G_DAY

HEX_BINARY

BASE64_BINARY

ANY_URI

QNAME

NOTATION

UNTYPED_ATOMIC

DECIMAL

FLOAT

DOUBLE

INTEGER

NON_POSITIVE_INTEGER

NEGATIVE_INTEGER

LONG

INT

SHORT

BYTE

NON_NEGATIVE_INTEGER

POSITIVE_INTEGER

UNSIGNED_LONG

UNSIGNED_INT

UNSIGNED_SHORT

UNSIGNED_BYTE

YEAR_MONTH_DURATION

DAY_TIME_DURATION

NORMALIZED_STRING

TOKEN

LANGUAGE

NAME

NMTOKEN

NCNAME

ID

IDREF

ENTITY

DATE_TIME_STAMP

Method Detail

getName

getUType

getTargetNamespace

getEQName

isAbstract

isExternalType

isBuiltInType

getTypeName

one

zeroOrOne

oneOrMore

zeroOrMore

getRedefinitionLevel

isOrdered

getSystemId

isPrimitiveNumeric

getValidationStatus

getBlock

getDerivationMethod

allowsDerivation

getFinalProhibitions

setBaseTypeFingerprint

getFingerprint