Package net.sf.saxon.s9api
Class ItemType
- java.lang.Object
-
- net.sf.saxon.s9api.ItemType
-
public abstract class ItemType extends java.lang.ObjectAn item type, as defined in the XPath/XQuery specifications.This class contains a number of static constant fields referring to instances that represent simple item types, such as
item(),node(), andxs:anyAtomicType. These named types are currently based on the definitions in XSD 1.0 and XML 1.0. They may be changed in a future version to be based on a later version.More complicated item types, especially those that are dependent on information in a schema, are available using factory methods on the
ItemTypeFactoryobject. The factory methods can also be used to create variants of the types that use the rules given in the XML 1.1 and/or XSD 1.1 specifications.
-
-
Field Summary
Fields Modifier and Type Field Description static ItemTypeANY_ARRAYItemType representing the type array(*), that is, any arraystatic ItemTypeANY_ATOMIC_VALUEItemType representing the type xs:anyAtomicType, that is, any atomic valuestatic ItemTypeANY_FUNCTIONItemType representing the type function(*), that is, any functionstatic ItemTypeANY_ITEMItemType representing the type item(), that is, any item at allstatic ItemTypeANY_MAPItemType representing the type map(*), that is, any mapstatic ItemTypeANY_NODEItemType representing the type node(), that is, any nodestatic ItemTypeANY_URIItemType representing the primitive type xs:anyURIstatic ItemTypeATTRIBUTE_NODEItemType representing the ATTRIBUTE node() typestatic ItemTypeBASE64_BINARYItemType representing the primitive type xs:base64Binarystatic ItemTypeBOOLEANItemType representing the primitive type xs:booleanstatic ItemTypeBYTEItemType representing the built-in (but non-primitive) type xs:bytestatic ItemTypeCOMMENT_NODEItemType representing the COMMENT node() typestatic ItemTypeDATEItemType representing the primitive type xs:datestatic ItemTypeDATE_TIMEItemType representing the primitive type xs:dateTimestatic ItemTypeDATE_TIME_STAMPItemType representing the built-in (but non-primitive) type xs:dateTimeStamp (introduced in XSD 1.1)static ItemTypeDAY_TIME_DURATIONItemType representing the built-in (but non-primitive) type xs:dayTimeDurationstatic ItemTypeDECIMALItemType representing the primitive type xs:decimalstatic ItemTypeDOCUMENT_NODEItemType representing the DOCUMENT node() typestatic ItemTypeDOUBLEItemType representing the primitive type xs:doublestatic ItemTypeDURATIONItemType representing the primitive type xs:durationstatic ItemTypeELEMENT_NODEItemType representing the ELEMENT node() typestatic ItemTypeENTITYItemType representing the built-in (but non-primitive) type xs:ENTITYstatic ItemTypeERRORItemType representing the type xs:error: a type with no instancesstatic ItemTypeFLOATItemType representing the primitive type xs:floatstatic ItemTypeG_DAYItemType representing the primitive type xs:gDaystatic ItemTypeG_MONTHItemType representing the primitive type xs:gMonthstatic ItemTypeG_MONTH_DAYItemType representing the primitive type xs:gMonthDaystatic ItemTypeG_YEARItemType representing the primitive type xs:gYearstatic ItemTypeG_YEAR_MONTHItemType representing the primitive type xs:gYearMonthstatic ItemTypeHEX_BINARYItemType representing the primitive type xs:hexBinarystatic ItemTypeIDItemType representing the built-in (but non-primitive) type xs:IDstatic ItemTypeIDREFItemType representing the built-in (but non-primitive) type xs:IDREFstatic ItemTypeINTItemType representing the built-in (but non-primitive) type xs:intstatic ItemTypeINTEGERItemType representing the built-in (but non-primitive) type xs:integerstatic ItemTypeLANGUAGEItemType representing the built-in (but non-primitive) type xs:languagestatic ItemTypeLONGItemType representing the built-in (but non-primitive) type xs:longstatic ItemTypeNAMEItemType representing the built-in (but non-primitive) type xs:Namestatic ItemTypeNAMESPACE_NODEItemType representing the NAMESPACE node() typestatic ItemTypeNCNAMEItemType representing the built-in (but non-primitive) type xs:NCNamestatic ItemTypeNEGATIVE_INTEGERItemType representing the built-in (but non-primitive) type xs:negativeIntegerstatic ItemTypeNMTOKENItemType representing the built-in (but non-primitive) type xs:NMTOKENstatic ItemTypeNON_NEGATIVE_INTEGERItemType representing the built-in (but non-primitive) type xs:nonNegativeIntegerstatic ItemTypeNON_POSITIVE_INTEGERItemType representing the built-in (but non-primitive) type xs:nonPositiveIntegerstatic ItemTypeNORMALIZED_STRINGItemType representing the built-in (but non-primitive) type xs:normalizedStringstatic ItemTypeNOTATIONItemType representing the primitive type xs:NOTATIONstatic ItemTypeNUMERICItemType representing the built-in union type xs:numeric defined in XDM 3.1static ItemTypePOSITIVE_INTEGERItemType representing the built-in (but non-primitive) type xs:positiveIntegerstatic ItemTypePROCESSING_INSTRUCTION_NODEItemType representing the PROCESSING_INSTRUCTION node() typestatic ItemTypeQNAMEItemType representing the primitive type xs:QNamestatic ItemTypeSHORTItemType representing the built-in (but non-primitive) type xs:shortstatic ItemTypeSTRINGItemType representing the primitive type xs:stringstatic ItemTypeTEXT_NODEItemType representing the TEXT node() typestatic ItemTypeTIMEItemType representing the primitive type xs:timestatic ItemTypeTOKENItemType representing the built-in (but non-primitive) type xs:tokenstatic ItemTypeUNSIGNED_BYTEItemType representing the built-in (but non-primitive) type xs:unsignedBytestatic ItemTypeUNSIGNED_INTItemType representing the built-in (but non-primitive) type xs:unsignedIntstatic ItemTypeUNSIGNED_LONGItemType representing the built-in (but non-primitive) type xs:unsignedLongstatic ItemTypeUNSIGNED_SHORTItemType representing the built-in (but non-primitive) type xs:unsignedShortstatic ItemTypeUNTYPED_ATOMICItemType representing the XPath-defined type xs:untypedAtomicstatic ItemTypeYEAR_MONTH_DURATIONItemType representing the built-in (but non-primitive) type xs:yearMonthDuration
-
Constructor Summary
Constructors Constructor Description ItemType()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object other)Test whether two ItemType objects represent the same typeConversionRulesgetConversionRules()Get the conversion rules implemented by this type.QNamegetTypeName()Get the name of the type, if it has oneabstract ItemTypegetUnderlyingItemType()Method to get the underlying Saxon implementation objectinthashCode()Get a hash code with semantics corresponding to the equals() methodabstract booleanmatches(XdmItem item)Determine whether this item type matches a given item.abstract booleansubsumes(ItemType other)Determine whether this ItemType subsumes another ItemType.java.lang.StringtoString()Get a string representation of the type.
-
-
-
Field Detail
-
ANY_ITEM
public static ItemType ANY_ITEM
ItemType representing the type item(), that is, any item at all
-
ANY_FUNCTION
public static ItemType ANY_FUNCTION
ItemType representing the type function(*), that is, any function
-
ANY_NODE
public static final ItemType ANY_NODE
ItemType representing the type node(), that is, any node
-
ATTRIBUTE_NODE
public static final ItemType ATTRIBUTE_NODE
ItemType representing the ATTRIBUTE node() type
-
COMMENT_NODE
public static final ItemType COMMENT_NODE
ItemType representing the COMMENT node() type
-
TEXT_NODE
public static final ItemType TEXT_NODE
ItemType representing the TEXT node() type
-
ELEMENT_NODE
public static final ItemType ELEMENT_NODE
ItemType representing the ELEMENT node() type
-
DOCUMENT_NODE
public static final ItemType DOCUMENT_NODE
ItemType representing the DOCUMENT node() type
-
NAMESPACE_NODE
public static final ItemType NAMESPACE_NODE
ItemType representing the NAMESPACE node() type
-
PROCESSING_INSTRUCTION_NODE
public static final ItemType PROCESSING_INSTRUCTION_NODE
ItemType representing the PROCESSING_INSTRUCTION node() type
-
ANY_MAP
public static final ItemType ANY_MAP
ItemType representing the type map(*), that is, any map
-
ANY_ARRAY
public static final ItemType ANY_ARRAY
ItemType representing the type array(*), that is, any array
-
ANY_ATOMIC_VALUE
public static final ItemType ANY_ATOMIC_VALUE
ItemType representing the type xs:anyAtomicType, that is, any atomic value
-
ERROR
public static final ItemType ERROR
ItemType representing the type xs:error: a type with no instances
-
STRING
public static final ItemType STRING
ItemType representing the primitive type xs:string
-
BOOLEAN
public static final ItemType BOOLEAN
ItemType representing the primitive type xs:boolean
-
DURATION
public static final ItemType DURATION
ItemType representing the primitive type xs:duration
-
DATE_TIME
public static final ItemType DATE_TIME
ItemType representing the primitive type xs:dateTime
-
DATE
public static final ItemType DATE
ItemType representing the primitive type xs:date
-
TIME
public static final ItemType TIME
ItemType representing the primitive type xs:time
-
G_YEAR_MONTH
public static final ItemType G_YEAR_MONTH
ItemType representing the primitive type xs:gYearMonth
-
G_MONTH
public static final ItemType G_MONTH
ItemType representing the primitive type xs:gMonth
-
G_MONTH_DAY
public static final ItemType G_MONTH_DAY
ItemType representing the primitive type xs:gMonthDay
-
G_YEAR
public static final ItemType G_YEAR
ItemType representing the primitive type xs:gYear
-
G_DAY
public static final ItemType G_DAY
ItemType representing the primitive type xs:gDay
-
HEX_BINARY
public static final ItemType HEX_BINARY
ItemType representing the primitive type xs:hexBinary
-
BASE64_BINARY
public static final ItemType BASE64_BINARY
ItemType representing the primitive type xs:base64Binary
-
ANY_URI
public static final ItemType ANY_URI
ItemType representing the primitive type xs:anyURI
-
QNAME
public static final ItemType QNAME
ItemType representing the primitive type xs:QName
-
NOTATION
public static final ItemType NOTATION
ItemType representing the primitive type xs:NOTATION
-
UNTYPED_ATOMIC
public static final ItemType UNTYPED_ATOMIC
ItemType representing the XPath-defined type xs:untypedAtomic
-
DECIMAL
public static final ItemType DECIMAL
ItemType representing the primitive type xs:decimal
-
FLOAT
public static final ItemType FLOAT
ItemType representing the primitive type xs:float
-
DOUBLE
public static final ItemType DOUBLE
ItemType representing the primitive type xs:double
-
INTEGER
public static final ItemType INTEGER
ItemType representing the built-in (but non-primitive) type xs:integer
-
NON_POSITIVE_INTEGER
public static final ItemType NON_POSITIVE_INTEGER
ItemType representing the built-in (but non-primitive) type xs:nonPositiveInteger
-
NEGATIVE_INTEGER
public static final ItemType NEGATIVE_INTEGER
ItemType representing the built-in (but non-primitive) type xs:negativeInteger
-
LONG
public static final ItemType LONG
ItemType representing the built-in (but non-primitive) type xs:long
-
INT
public static final ItemType INT
ItemType representing the built-in (but non-primitive) type xs:int
-
SHORT
public static final ItemType SHORT
ItemType representing the built-in (but non-primitive) type xs:short
-
BYTE
public static final ItemType BYTE
ItemType representing the built-in (but non-primitive) type xs:byte
-
NON_NEGATIVE_INTEGER
public static final ItemType NON_NEGATIVE_INTEGER
ItemType representing the built-in (but non-primitive) type xs:nonNegativeInteger
-
POSITIVE_INTEGER
public static final ItemType POSITIVE_INTEGER
ItemType representing the built-in (but non-primitive) type xs:positiveInteger
-
UNSIGNED_LONG
public static final ItemType UNSIGNED_LONG
ItemType representing the built-in (but non-primitive) type xs:unsignedLong
-
UNSIGNED_INT
public static final ItemType UNSIGNED_INT
ItemType representing the built-in (but non-primitive) type xs:unsignedInt
-
UNSIGNED_SHORT
public static final ItemType UNSIGNED_SHORT
ItemType representing the built-in (but non-primitive) type xs:unsignedShort
-
UNSIGNED_BYTE
public static final ItemType UNSIGNED_BYTE
ItemType representing the built-in (but non-primitive) type xs:unsignedByte
-
YEAR_MONTH_DURATION
public static final ItemType YEAR_MONTH_DURATION
ItemType representing the built-in (but non-primitive) type xs:yearMonthDuration
-
DAY_TIME_DURATION
public static final ItemType DAY_TIME_DURATION
ItemType representing the built-in (but non-primitive) type xs:dayTimeDuration
-
NORMALIZED_STRING
public static final ItemType NORMALIZED_STRING
ItemType representing the built-in (but non-primitive) type xs:normalizedString
-
TOKEN
public static final ItemType TOKEN
ItemType representing the built-in (but non-primitive) type xs:token
-
LANGUAGE
public static final ItemType LANGUAGE
ItemType representing the built-in (but non-primitive) type xs:language
-
NAME
public static final ItemType NAME
ItemType representing the built-in (but non-primitive) type xs:Name
-
NMTOKEN
public static final ItemType NMTOKEN
ItemType representing the built-in (but non-primitive) type xs:NMTOKEN
-
NCNAME
public static final ItemType NCNAME
ItemType representing the built-in (but non-primitive) type xs:NCName
-
ID
public static final ItemType ID
ItemType representing the built-in (but non-primitive) type xs:ID
-
IDREF
public static final ItemType IDREF
ItemType representing the built-in (but non-primitive) type xs:IDREF
-
ENTITY
public static final ItemType ENTITY
ItemType representing the built-in (but non-primitive) type xs:ENTITY
-
DATE_TIME_STAMP
public static final ItemType DATE_TIME_STAMP
ItemType representing the built-in (but non-primitive) type xs:dateTimeStamp (introduced in XSD 1.1)
-
NUMERIC
public static final ItemType NUMERIC
ItemType representing the built-in union type xs:numeric defined in XDM 3.1
-
-
Method Detail
-
getConversionRules
public ConversionRules getConversionRules()
Get the conversion rules implemented by this type. The conversion rules reflect variations between different versions of the W3C specifications, for example XSD 1.1 allows "+INF" as a lexical representation of xs:double, while XSD 1.0 does not.- Returns:
- the conversion rules
-
matches
public abstract boolean matches(XdmItem item)
Determine whether this item type matches a given item.- Parameters:
item- the item to be tested against this item type- Returns:
- true if the item matches this item type, false if it does not match.
-
subsumes
public abstract boolean subsumes(ItemType other)
Determine whether this ItemType subsumes another ItemType. Specifically,A.subsumes(B)is true if every value that matches the ItemType B also matches the ItemType A.- Parameters:
other- the other ItemType- Returns:
- true if this ItemType subsumes the other ItemType. This includes the case where A and B represent the same ItemType.
- Since:
- 9.1
-
getUnderlyingItemType
public abstract ItemType getUnderlyingItemType()
Method to get the underlying Saxon implementation objectThis gives access to Saxon methods that may change from one release to another.
- Returns:
- the underlying Saxon implementation object
-
getTypeName
public QName getTypeName()
Get the name of the type, if it has one- Returns:
- the name of the type, or null if it is either an anonymous schema-defined type, or an XDM-defined type such as node() or map().
- Since:
- 9.7
-
equals
public final boolean equals(java.lang.Object other)
Test whether two ItemType objects represent the same type- Overrides:
equalsin classjava.lang.Object- Parameters:
other- the other ItemType object- Returns:
- true if the other object is an ItemType representing the same type
- Since:
- 9.5
-
hashCode
public final int hashCode()
Get a hash code with semantics corresponding to the equals() method- Overrides:
hashCodein classjava.lang.Object- Returns:
- the hash code
- Since:
- 9.5
-
toString
public java.lang.String toString()
Get a string representation of the type. This will be a string that conforms to the XPath ItemType production, for example a QName (always in "Q{uri}local" format, or a construct such as "node()" or "map(*)". If the type is an anonymous schema type, the name of the nearest named base type will be given, preceded by the character "<".- Overrides:
toStringin classjava.lang.Object- Returns:
- a string representation of the type
- Since:
- 9.7
-
-