Package net.sf.saxon.type

Class BuiltInAtomicType

  • All Implemented Interfaces:
    java.io.Serializable, AtomicType, ItemType, SchemaComponent, SchemaType, SimpleType
    public class BuiltInAtomicType
extends java.lang.Object
implements AtomicType, java.io.Serializable
    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 xdt:dayTimeDuration).
    See Also:
    Serialized Form

    • Field Detail

      • fingerprint

        int fingerprint

      • baseFingerprint

        int baseFingerprint

    • Constructor Detail

      • BuiltInAtomicType

        public BuiltInAtomicType()

      • BuiltInAtomicType

        public BuiltInAtomicType​(int fingerprint)

    • Method Detail

      • 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 SimpleType

      • getCommonAtomicType

        public AtomicType getCommonAtomicType()
        Get the most specific possible atomic type that all items in this SimpleType belong to
        Specified by:
        getCommonAtomicType in interface SimpleType
        Returns:
        the lowest common supertype of all member types

      • 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

      • setBaseTypeFingerprint

        public final void setBaseTypeFingerprint​(int baseFingerprint)

      • getFingerprint

        public 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.

      • getNameCode

        public int getNameCode()
        Get the namecode of the name of this type. This includes the prefix from the original type declaration: in the case of built-in types, there may be a conventional prefix or there may be no prefix.
        Specified by:
        getNameCode in interface SchemaType

      • 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

      • isComplexType

        public final 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

      • isAnonymousType

        public boolean isAnonymousType()
        Test whether this is an anonymous type
        Specified by:
        isAnonymousType in interface SchemaType
        Returns:
        true if this SchemaType is an anonymous type

      • 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.

      • matchesItem

        public boolean matchesItem​(Item item,
                           boolean allowURIPromotion,
                           Configuration config)
        Test whether a given item conforms to this type
        Specified by:
        matchesItem in interface ItemType
        Parameters:
        item - The item to be tested
        allowURIPromotion -
        config -
        Returns:
        true if the item is an instance of this type; false otherwise

      • getSuperType

        public ItemType getSuperType​(TypeHierarchy th)
        Get the type from which this item type is derived by restriction. This is the supertype in the XPath type heirarchy, as distinct from the Schema base type: this means that the supertype of xs:boolean is xdt:anyAtomicType, whose supertype is item() (rather than xs:anySimpleType).
        Specified by:
        getSuperType in interface ItemType
        Parameters:
        th -
        Returns:
        the supertype, or null if this type is item()

      • getPrimitiveItemType

        public ItemType 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

      • 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

      • isAllowedInBasicXSLT

        public boolean isAllowedInBasicXSLT()
        Determine whether this type is supported in a basic XSLT processor

      • toString

        public java.lang.String toString​(NamePool pool)
        Produce a representation of this type name for use in error messages. Where this is a QName, it will use conventional prefixes
        Specified by:
        toString in interface ItemType

      • 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

      • 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

      • 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".

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • isSimpleType

        public final boolean isSimpleType()
        Returns true if this SchemaType is a SimpleType
        Specified by:
        isSimpleType in interface SchemaType
        Returns:
        true (always)

      • 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​(TypeHierarchy th)
        Determine the whitespace normalization required for values of this type
        Specified by:
        getWhitespaceAction in interface SimpleType
        Parameters:
        th -
        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

      • validateContent

        public ValidationException validateContent​(java.lang.CharSequence value,
                                           NamespaceResolver nsResolver,
                                           NameChecker nameChecker)
        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.
        nameChecker -
        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

      • getTypedValue

        public final SequenceIterator getTypedValue​(NodeInfo node)
                                     throws XPathException
        Get the typed value of a node that is annotated with this schema type
        Specified by:
        getTypedValue in interface SchemaType
        Parameters:
        node - the node whose typed value is required
        Returns:
        an iterator over the items making up the typed value of this node. The objects returned by this SequenceIterator will all be of type AtomicValue
        Throws:
        XPathException

      • atomize

        public Value atomize​(NodeInfo node)
              throws XPathException
        Get the typed value of a node that is annotated with this schema type. The result of this method will always be consistent with the method getTypedValue(net.sf.saxon.om.NodeInfo). However, this method is often more convenient and may be more efficient, especially in the common case where the value is expected to be a singleton.
        Specified by:
        atomize in interface SchemaType
        Parameters:
        node - the node whose typed value is required
        Returns:
        the typed value.
        Throws:
        XPathException
        Since:
        8.5

      • getTypedValue

        public SequenceIterator getTypedValue​(java.lang.CharSequence value,
                                      NamespaceResolver resolver,
                                      NameChecker nameChecker)
                               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.
        nameChecker -
        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

      • makeDerivedValue

        public AtomicValue makeDerivedValue​(AtomicValue primValue,
                                    java.lang.CharSequence lexicalValue,
                                    boolean validate)
        Factory method to create values of a derived atomic type. This method is not used to create values of a built-in type, even one that is not primitive.
        Specified by:
        makeDerivedValue 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
        validate - true if the value is to be validated against the facets of the derived type; false if the caller knows that the value is already valid.
        Returns:
        the derived atomic value if validation succeeds, or an ErrorValue otherwise. The ErrorValue encapsulates the exception that occurred; it is the caller's responsibility to check for this.

      • analyzeContentExpression

        public static void analyzeContentExpression​(SimpleType simpleType,
                                            Expression expression,
                                            StaticContext env,
                                            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