Package net.sf.saxon.type

Enum Class AnyItemType

java.lang.Object
java.lang.Enum<AnyItemType>
net.sf.saxon.type.AnyItemType
All Implemented Interfaces:
Serializable, Comparable<AnyItemType>, Constable, ItemType, ItemTypeWithSequenceTypeCache
public enum AnyItemType extends Enum<AnyItemType> implements ItemTypeWithSequenceTypeCache
An implementation of ItemType that matches any item (node or atomic value)

  • Enum Constant Details

  • Method Details

    • values

      public static AnyItemType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static AnyItemType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getInstance

      public static AnyItemType getInstance()
      Factory method to get the singleton instance
      Returns:
      the singleton instance

    • getGenre

      public Genre getGenre()
      Determine the Genre (top-level classification) of this type
      Specified by:
      getGenre in interface ItemType
      Returns:
      the Genre to which this type belongs, specifically Genre.ANY

    • 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

    • asChoiceItemType

      public ChoiceItemType asChoiceItemType()
      Description copied from interface: ItemType
      Expand this item type to a choice item type. The default delivers a choice with this type as its only member. Implementations for abstract types return a choice of the corresponding concrete types, for example node() expands to a choice of the seven node kinds. The implementation for a choice type that includes abstract member types should expand these recursively.
      Specified by:
      asChoiceItemType in interface ItemType

    • isAtomicType

      public boolean isAtomicType()
      Determine whether this item type is an atomic type
      Specified by:
      isAtomicType in interface ItemType
      Returns:
      true if this is ANY_ATOMIC_TYPE or a subtype thereof

    • getBasicAlphaCode

      public String getBasicAlphaCode()
      Get an alphabetic code representing the type, or at any rate, the nearest built-in type from which this type is derived. The codes are designed so that for any two built-in types A and B, alphaCode(A) is a prefix of alphaCode(B) if and only if A is a supertype of B.
      Specified by:
      getBasicAlphaCode in interface ItemType
      Returns:
      the alphacode for the nearest containing built-in type

    • toExportString

      public String toExportString()
      Description copied from interface: ItemType
      Return a string representation of this ItemType suitable for use in stylesheet export files. This differs from the result of toString() in that it will not contain any references to anonymous types. Note that it may also use the Saxon extended syntax for union types and tuple types. The default implementation returns the result of calling toString().
      Specified by:
      toExportString in interface ItemType
      Returns:
      the string representation as an instance of the XPath SequenceType construct

    • normalizeItemType

      public ItemType normalizeItemType()
      Normalize this item type, returning a potentially different item type that matches the same items. For example, record(*) and map(*) match the same items. The default implementation returns the item type unchanged. This method does NOT expand item types to an equivalent choice item type.

      Item types should be normalized before comparison using equals().

      Specified by:
      normalizeItemType in interface ItemType
      Returns:
      the normalized item type.

    • isPlainType

      public boolean isPlainType()
      Determine whether this item type is atomic (that is, whether it can ONLY match atomic values)
      Specified by:
      isPlainType in interface ItemType
      Returns:
      false: this type can match nodes or atomic values

    • matches

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

    • 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 xs: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
      Returns:
      the corresponding primitive type

    • getPrimitiveType

      public int getPrimitiveType()
      Description copied from interface: ItemType
      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 BuiltInAtomicType.ANY_ATOMIC. 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

    • getAtomizedItemType

      public PlainType getAtomizedItemType()
      Description copied from interface: ItemType
      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(TypeHierarchy th)
      Ask whether values of this type are atomizable
      Specified by:
      isAtomizable in interface ItemType
      Parameters:
      th - The type hierarchy cache
      Returns:
      true unless it is known that these items will be elements with element-only content, in which case return false

    • getDefaultPriority

      public double getDefaultPriority()
      Description copied from interface: ItemType
      Get the default priority when this ItemType is used as an XSLT pattern
      Specified by:
      getDefaultPriority in interface ItemType
      Returns:
      the default priority

    • getNormalizedDefaultPriority

      public double getNormalizedDefaultPriority()
      Description copied from interface: ItemType
      Get the default priority normalized into the range 0 to 1
      Specified by:
      getNormalizedDefaultPriority in interface ItemType
      Returns:
      the default priority plus one divided by two

    • toString

      public String toString()
      Overrides:
      toString in class Enum<AnyItemType>

    • one

      public SequenceType one()
      Get a sequence type representing exactly one instance of this atomic type
      Specified by:
      one in interface ItemTypeWithSequenceTypeCache
      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 ItemTypeWithSequenceTypeCache
      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 ItemTypeWithSequenceTypeCache
      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 ItemTypeWithSequenceTypeCache
      Returns:
      a sequence type representing one or more instances of this atomic type
      Since:
      9.8.0.2

    • getCoercionPlan

      public CoercionPlan getCoercionPlan(int version)
      Get the coercion plan for use when this type is the required type for (say) coercion of arguments in a function call
      Specified by:
      getCoercionPlan in interface ItemType
      Parameters:
      version - the XPath language version (40 or 31)

    • explainMismatch

      public Optional<String> explainMismatch(Item item, TypeHierarchy th)
      Description copied from interface: ItemType
      Get extra diagnostic information about why a supplied item does not conform to this item type, if available. If extra information is returned, it should be in the form of a complete sentence, minus the closing full stop. No information should be returned for obvious cases.
      Specified by:
      explainMismatch in interface ItemType
      Parameters:
      item - the item that doesn't match this type
      th - the type hierarchy cache
      Returns:
      optionally, a message explaining why the item does not match the type