ErrorType

java.lang.Object
- net.sf.saxon.pattern.NodeTest
- - net.sf.saxon.type.ErrorType

All Implemented Interfaces:

AtomicType, ItemType, ItemType.WithSequenceTypeCache, PlainType, SchemaComponent, SchemaType, SimpleType, UnionType
```
public final class ErrorType
extends NodeTest
implements AtomicType, UnionType, PlainType
```
This class has a singleton instance which represents the XML Schema 1.1 built-in type xs:error.

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

Field Summary
- 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.
`AtomicSequence`	`atomize(NodeInfo node)` Get the typed value of a node that is annotated with this schema type.
`ValidationFailure`	`checkAgainstFacets(AtomicValue value, ConversionRules rules)` Validate an atomic value, which is known to be an instance of one of the member types of the union, against any facets (pattern facets or enumeration facets) defined at the level of the union itself.
`void`	`checkTypeDerivationIsOK(SchemaType type, int block)` Check that this type is validly derived from a given type
`boolean`	`containsListType()` Ask whether the union contains a list type among its member types
`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 (assuming that atomization succeeds)
`SchemaType`	`getBaseType()` Get the base type
`int`	`getBlock()` Returns the value of the 'block' attribute for this type, as a bit-signnificant integer with fields such as `SchemaType.DERIVATION_LIST` and `SchemaType.DERIVATION_EXTENSION`
`SchemaType`	`getBuiltInBaseType()` Get the built-in ancestor of this type in the type hierarchy
`Function`	`getComponentAsFunction()` Get the schema component in the form of a function item.
`double`	`getDefaultPriority()` Determine the default priority to use if this node-test appears as a match pattern for a template with no explicit priority attribute.
`int`	`getDerivationMethod()` Gets the integer code of the derivation method used to derive this type from its parent.
`String`	`getDescription()` Get a description of this type for use in diagnostics
`String`	`getDisplayName()` Get the display name of the type: that is, a lexical QName with an arbitrary prefix
`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
`static ErrorType`	`getInstance()` Get the singular instance of this class
`SchemaType`	`getKnownBaseType()` Returns the base type that this type inherits from.
`StructuredQName`	`getMatchingNodeName()` Get the name of the nodes matched by this nodetest, if it matches a specific name.
`String`	`getName()` Get the local name of this type
`Iterable<PlainType>`	`getPlainMemberTypes()` Get the list of plain types that are subsumed by this type
`AtomicType`	`getPrimitiveItemType()` Get the primitive item type corresponding to this item type.
`int`	`getPrimitiveType()` Get the basic kind of object that this ItemType matches: for a NodeTest, this is the kind of node, or Type.Node if it matches different kinds of nodes.
`int`	`getRedefinitionLevel()` Get the redefinition level.
`SequenceType`	`getResultTypeOfCast()` Get the result type of a cast operation to this union type, as a sequence type.
`StringConverter`	`getStringConverter(ConversionRules rules)` Get a StringConverter, an object which 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 StructuredQName
`String`	`getSystemId()` Get the URI of the schema document containing the definition of this type
`String`	`getTargetNamespace()` Get the target namespace of this type
`AtomicSequence`	`getTypedValue(CharSequence value, NamespaceResolver resolver, ConversionRules rules)` Get the typed value corresponding to a given string value, assuming it is valid against this type
`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 how values of this simple type are whitespace-normalized.
`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`	`isAnonymousType()` Test 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()` Test 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()` Determine whether this is a list type
`boolean`	`isNamespaceSensitive()` Test whether this type represents namespace-sensitive content
`boolean`	`isOrdered(boolean optimistic)` Determine whether the atomic type is ordered, that is, whether less-than and greater-than comparisons are permitted
`boolean`	`isPlainType()` Determine whether this item type is atomic (that is, whether it can ONLY match atomic values)
`boolean`	`isPrimitiveType()` Determine whether the atomic type is a primitive type.
`boolean`	`isSameType(SchemaType other)` Test whether this is the same type as another type.
`boolean`	`isSimpleType()` Test whether this SchemaType is a simple type
`boolean`	`isUnionType()` Determin whether this is a union type
`boolean`	`matches(int nodeKind, NodeName name, SchemaType annotation)` Test whether this node test is satisfied by a given node.
`boolean`	`matches(Item item, TypeHierarchy th)` Test whether a given item conforms to this type
`CharSequence`	`postprocess(CharSequence input)` Reverse any pre-lexical facets, other than whitespace.
`CharSequence`	`preprocess(CharSequence input)` Apply any pre-lexical facets, other than whitespace.
`String`	`toString()`
`ValidationFailure`	`validate(AtomicValue primValue, 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(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

Methods inherited from class net.sf.saxon.pattern.NodeTest
copy, generateJavaScriptItemTypeAcceptor, getContentType, getMatcher, getNodeKindMask, getRequiredNodeNames, isNillable, matchesNode, one, oneOrMore, zeroOrMore, zeroOrOne

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

Methods inherited from interface net.sf.saxon.type.ItemType
generateJavaScriptItemTypeAcceptor

- Method Detail
  - 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
  - getName
```
public 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.
  - getTargetNamespace
```
public 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 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. In the case of an anonymous type, an internally-generated name is returned
  - containsListType
```
public boolean containsListType()
```
    Description copied from interface: UnionType
    
    Ask whether the union contains a list type among its member types
    
    Specified by:
    
    containsListType in interface UnionType
    
    Returns:
    
    true of one of the member types is a list type
  - getPlainMemberTypes
```
public Iterable<PlainType> getPlainMemberTypes()
```
    Description copied from interface: PlainType
    
    Get the list of plain types that are subsumed by this type
    
    Specified by:
    
    getPlainMemberTypes in interface PlainType
    
    Specified by:
    
    getPlainMemberTypes in interface UnionType
    
    Returns:
    
    for an atomic type, the type itself; for a plain union type, the list of plain types in its transitive membership
  - 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
  - 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
  - getSystemId
```
public String getSystemId()
```
    Get the URI of the schema document containing the definition of this type
    
    Specified by:
    
    getSystemId in interface SchemaType
    
    Returns:
    
    null for a built-in type
  - getInstance
```
public static ErrorType getInstance()
```
    Get the singular instance of this class
    
    Returns:
    
    the singular object representing xs:anyType
  - getValidationStatus
```
public 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
  - getBaseType
```
public SchemaType getBaseType()
```
    Get the base type
    
    Specified by:
    
    getBaseType in interface SchemaType
    
    Returns:
    
    AnyType
  - 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.
    
    Returns:
    
    the base type.
  - isComplexType
```
public boolean isComplexType()
```
    Test whether this SchemaType is a complex type
    
    Specified by:
    
    isComplexType in interface SchemaType
    
    Returns:
    
    true if this SchemaType is a complex type
  - isSimpleType
```
public boolean isSimpleType()
```
    Test whether this SchemaType is a simple type
    
    Specified by:
    
    isSimpleType in interface SchemaType
    
    Returns:
    
    true if this SchemaType is a simple type
  - getFingerprint
```
public int getFingerprint()
```
    Get the fingerprint of the name of this type
    
    Specified by:
    
    getFingerprint in interface SchemaType
    
    Overrides:
    
    getFingerprint in class NodeTest
    
    Returns:
    
    the fingerprint.
  - getMatchingNodeName
```
public StructuredQName getMatchingNodeName()
```
    Get the name of the nodes matched by this nodetest, if it matches a specific name. Return null if the node test matches nodes of more than one name
    
    Overrides:
    
    getMatchingNodeName in class NodeTest
  - getStructuredQName
```
public StructuredQName getStructuredQName()
```
    Get the name of the type as a StructuredQName
    
    Specified by:
    
    getStructuredQName in interface SchemaType
    
    Returns:
    
    a StructuredQName identifying the type. In the case of an anonymous type, an internally-generated name is returned
  - getDescription
```
public String getDescription()
```
    Get a description of this type for use in diagnostics
    
    Specified by:
    
    getDescription in interface SchemaType
    
    Returns:
    
    the string "xs:anyType"
  - getDisplayName
```
public 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
  - 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
  - atomize
```
public AtomicSequence atomize(NodeInfo node)
```
    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.
    
    Since:
    
    8.5
  - 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
  - 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
    
    Overrides:
    
    isAtomicType in class NodeTest
    
    Returns:
    
    false, this is not (necessarily) 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
  - isAnonymousType
```
public boolean isAnonymousType()
```
    Description copied from interface: SchemaType
    
    Test whether this is an anonymous type
    
    Specified by:
    
    isAnonymousType in interface SchemaType
    
    Returns:
    
    true if this SchemaType is an anonymous type
  - isListType
```
public boolean isListType()
```
    Determine whether this is a list type
    
    Specified by:
    
    isListType in interface SimpleType
    
    Returns:
    
    false (it isn't a list type)
  - isUnionType
```
public boolean isUnionType()
```
    Determin whether this is a union type
    
    Specified by:
    
    isUnionType in interface SimpleType
    
    Returns:
    
    true (this is a union type with no members)
  - getBuiltInBaseType
```
public SchemaType getBuiltInBaseType()
```
    Get the built-in ancestor of this type in the type hierarchy
    
    Specified by:
    
    getBuiltInBaseType in interface SimpleType
    
    Returns:
    
    xs:anySimpleType
  - getTypedValue
```
public AtomicSequence getTypedValue(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
    
    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
    
    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 - if the supplied value is not in the lexical space of the data type (which is always true for this type)
  - getStringConverter
```
public StringConverter getStringConverter(ConversionRules rules)
```
    Get a StringConverter, an object which 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, or null if no built-in converter is available.
  - validateContent
```
public ValidationFailure validateContent(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 - the conversion rules
    
    Returns:
    
    null if validation succeeds (which it never does for this implementation)
    
    Throws:
    
    UnsupportedOperationException - if the type is namespace-sensitive and no namespace resolver is supplied
  - isNamespaceSensitive
```
public boolean isNamespaceSensitive()
```
    Test whether this type represents namespace-sensitive content
    
    Specified by:
    
    isNamespaceSensitive in interface SimpleType
    
    Returns:
    
    false
  - getBlock
```
public int getBlock()
```
    Returns the value of the 'block' attribute for this type, as a bit-signnificant 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 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 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
  - getWhitespaceAction
```
public int getWhitespaceAction()
```
    Determine how values of this simple type are whitespace-normalized.
    
    Specified by:
    
    getWhitespaceAction in interface SimpleType
    
    Returns:
    
    one of Whitespace.PRESERVE, Whitespace.COLLAPSE, Whitespace.REPLACE.
  - 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
  - preprocess
```
public CharSequence preprocess(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 CharSequence postprocess(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
  - isPlainType
```
public boolean isPlainType()
```
    Description copied from class: NodeTest
    
    Determine whether this item type is atomic (that is, whether it can ONLY match atomic values)
    
    Specified by:
    
    isPlainType in interface ItemType
    
    Overrides:
    
    isPlainType in class NodeTest
    
    Returns:
    
    false: this is not ANY_ATOMIC_TYPE or a subtype thereof
  - matches
```
public boolean matches(Item item,
                       TypeHierarchy th)
```
    Description copied from interface: ItemType
    
    Test whether a given item conforms to this type
    
    Specified by:
    
    matches in interface ItemType
    
    Specified by:
    
    matches in interface PlainType
    
    Overrides:
    
    matches in class NodeTest
    
    Parameters:
    
    item - The item to be tested
    
    th - The type hierarchy cache. Currently used only when matching function items.
    
    Returns:
    
    true if the item is an instance of this type; false otherwise
  - matches
```
public boolean matches(int nodeKind,
                       NodeName name,
                       SchemaType annotation)
```
    Description copied from class: NodeTest
    
    Test whether this node test is satisfied by a given node. This method is only fully supported for a subset of NodeTests, because it doesn't provide all the information needed to evaluate all node tests. In particular (a) it can't be used to evaluate a node test of the form element(N,T) or schema-element(E) where it is necessary to know whether the node is nilled, and (b) it can't be used to evaluate a node test of the form document-node(element(X)). This in practice means that it is used (a) to evaluate the simple node tests found in the XPath 1.0 subset used in XML Schema, and (b) to evaluate node tests where the node kind is known to be an attribute.
    
    Specified by:
    
    matches in class NodeTest
    
    Parameters:
    
    nodeKind - The kind of node to be matched
    
    name - identifies the expanded name of the node to be matched. The value should be null for a node with no name.
    
    annotation - The actual content type of the node. Null means no constraint.
    
    Returns:
    
    true if the node matches this node test
  - getPrimitiveItemType
```
public AtomicType getPrimitiveItemType()
```
    Description copied from class: NodeTest
    
    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
    
    Overrides:
    
    getPrimitiveItemType in class NodeTest
    
    Returns:
    
    the corresponding primitive type
  - getPrimitiveType
```
public int getPrimitiveType()
```
    Description copied from class: NodeTest
    
    Get the basic kind of object that this ItemType matches: for a NodeTest, this is the kind of node, or Type.Node if it matches different kinds of nodes.
    
    Specified by:
    
    getPrimitiveType in interface ItemType
    
    Overrides:
    
    getPrimitiveType in class NodeTest
    
    Returns:
    
    the node kind matched by this node test
  - getDefaultPriority
```
public double getDefaultPriority()
```
    Description copied from class: NodeTest
    
    Determine the default priority to use if this node-test appears as a match pattern for a template with no explicit priority attribute.
    
    Specified by:
    
    getDefaultPriority in class NodeTest
    
    Returns:
    
    the default priority for the pattern
  - getAtomizedItemType
```
public AtomicType getAtomizedItemType()
```
    Description copied from class: NodeTest
    
    Get the item type of the atomic values that will be produced when an item of this type is atomized (assuming that atomization succeeds)
    
    Specified by:
    
    getAtomizedItemType in interface ItemType
    
    Overrides:
    
    getAtomizedItemType in class NodeTest
    
    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()
```
    Description copied from class: NodeTest
    
    Ask whether values of this type are atomizable
    
    Specified by:
    
    isAtomizable in interface ItemType
    
    Overrides:
    
    isAtomizable in class NodeTest
    
    Returns:
    
    true unless it is known that these items will be elements with element-only content, in which case return false
  - visitNamedSchemaComponents
```
public void visitNamedSchemaComponents(SchemaComponentVisitor visitor)
                                throws XPathException
```
    Description copied from class: NodeTest
    
    Visit all the schema components used in this ItemType definition
    
    Specified by:
    
    visitNamedSchemaComponents in interface ItemType
    
    Overrides:
    
    visitNamedSchemaComponents in class NodeTest
    
    Parameters:
    
    visitor - the visitor class to be called when each component is visited
    
    Throws:
    
    XPathException - if an error occurs
  - getResultTypeOfCast
```
public SequenceType getResultTypeOfCast()
```
    Description copied from interface: UnionType
    
    Get the result type of a cast operation to this union type, as a sequence type.
    
    Specified by:
    
    getResultTypeOfCast in interface UnionType
    
    Returns:
    
    the result type of casting, as precisely as possible. For example, if all the member types of the union are derived from the same primitive type, this will return that primitive type.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - validate
```
public ValidationFailure validate(AtomicValue primValue,
                                  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
    
    Returns:
    
    null if the value is valid; otherwise, a ValidationFailure object indicating the nature of the error.
    
    Throws:
    
    UnsupportedOperationException - in the case of an external object type
  - 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
  - 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
  - isPrimitiveType
```
public boolean isPrimitiveType()
```
    Determine 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
  - 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.
  - checkAgainstFacets
```
public ValidationFailure checkAgainstFacets(AtomicValue value,
                                            ConversionRules rules)
```
    Validate an atomic value, which is known to be an instance of one of the member types of the union, against any facets (pattern facets or enumeration facets) defined at the level of the union itself.
    
    Specified by:
    
    checkAgainstFacets in interface UnionType
    
    Parameters:
    
    value - the Atomic Value to be checked. This must be an instance of a member type of the union
    
    rules - the ConversionRules for the Configuration
    
    Returns:
    
    a ValidationFailure if the value is not valid; null if it is valid.
  - generateJavaScriptItemTypeTest
```
public 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 -
    
    targetVersion -
    
    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.
  - getComponentAsFunction
```
public Function getComponentAsFunction()
```
    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 ErrorType

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 net.sf.saxon.pattern.NodeTest

Methods inherited from class java.lang.Object

Methods inherited from interface net.sf.saxon.type.ItemType

Method Detail

getUType

getName

getTargetNamespace

getEQName

containsListType

getPlainMemberTypes

isExternalType

isBuiltInType

getRedefinitionLevel

getSystemId

getInstance

getValidationStatus

getBaseType

getKnownBaseType

isComplexType

isSimpleType

getFingerprint

getMatchingNodeName

getStructuredQName

getDescription

getDisplayName

isSameType

atomize

checkTypeDerivationIsOK

isAtomicType

isIdType

isIdRefType

isAnonymousType

isListType

isUnionType

getBuiltInBaseType

getTypedValue

getStringConverter

validateContent

isNamespaceSensitive

getBlock

getDerivationMethod

allowsDerivation

getFinalProhibitions

getWhitespaceAction

analyzeContentExpression

preprocess

postprocess

isPlainType

matches

matches

getPrimitiveItemType

getPrimitiveType

getDefaultPriority

getAtomizedItemType

isAtomizable

visitNamedSchemaComponents

getResultTypeOfCast

toString

validate

isOrdered

isAbstract

isPrimitiveType

getTypeName

checkAgainstFacets

generateJavaScriptItemTypeTest

getComponentAsFunction