Package net.sf.saxon.ma.map
Class TupleItemType
- java.lang.Object
-
- net.sf.saxon.type.AnyFunctionType
-
- net.sf.saxon.ma.map.TupleItemType
-
- All Implemented Interfaces:
TupleType,FunctionItemType,ItemType
public class TupleItemType extends AnyFunctionType implements TupleType
An instance of this class represents a specific tuple item type, for example tuple(x as xs:double, y as element(employee)). Tuple types are a Saxon extension introduced in Saxon 9.8. The syntax for constructing a tuple type requires Saxon-PE or higher, but the supporting code is included in Saxon-HE for convenience. Extended in 10.0 to distinguish extensible vs non-extensible tuple types. Extensible tuple types permit fields other than those listed to appear; non-extensible tuple types do not. An extensible tuple type is denoted by tuple(... ,*).
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface net.sf.saxon.type.ItemType
ItemType.WithSequenceTypeCache
-
-
Field Summary
-
Fields inherited from class net.sf.saxon.type.AnyFunctionType
ANY_FUNCTION
-
-
Constructor Summary
Constructors Constructor Description TupleItemType(java.util.List<java.lang.String> names, java.util.List<SequenceType> types, boolean extensible)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object other)Test whether this function type equals another function typejava.util.Optional<java.lang.String>explainMismatch(Item item, TypeHierarchy th)Get extra diagnostic information about why a supplied item does not conform to this item type, if available.SequenceType[]getArgumentTypes()Get the argument types of this map, viewed as a functionintgetArity()Get the arity (number of arguments) of this function typejava.lang.StringgetBasicAlphaCode()Get an alphabetic code representing the type, or at any rate, the nearest built-in type from which this type is derived.doublegetDefaultPriority()Get the default priority when this ItemType is used as an XSLT patternjava.lang.Iterable<java.lang.String>getFieldNames()Get the names of all the fieldsSequenceTypegetFieldType(java.lang.String field)Get the type of a given fieldGenregetGenre()Determine the Genre (top-level classification) of this typeSequenceTypegetResultType()Get the result type of this tuple type, viewed as a functioninthashCode()Returns a hash code value for the object.booleanisArrayType()Ask whether this function item type is an array type.booleanisExtensible()Ask whether the tuple type is extensible, that is, whether fields other than those named are permittedbooleanisMapType()Ask whether this function item type is a map type.ExpressionmakeFunctionSequenceCoercer(Expression exp, RoleDiagnostic role)Create an expression whose effect is to apply function coercion to coerce a function from this type to another typebooleanmatches(Item item, TypeHierarchy th)Test whether a given item conforms to this typeAffinityrelationship(FunctionItemType other, TypeHierarchy th)Determine the relationship of one function item type to anotherjava.lang.StringtoExportString()Return a string representation of this ItemType suitable for use in stylesheet export files.java.lang.StringtoString()Produce a representation of this type name for use in error messages.-
Methods inherited from class net.sf.saxon.type.AnyFunctionType
getAnnotationAssertions, getAtomizedItemType, getInstance, getPrimitiveItemType, getPrimitiveType, getUType, isAtomicType, isAtomizable, isPlainType
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface net.sf.saxon.type.FunctionItemType
getAnnotationAssertions
-
Methods inherited from interface net.sf.saxon.type.ItemType
getAtomizedItemType, getFullAlphaCode, getNormalizedDefaultPriority, getPrimitiveItemType, getPrimitiveType, getUType, isAtomicType, isAtomizable, isPlainType, isTrueItemType
-
-
-
-
Constructor Detail
-
TupleItemType
public TupleItemType(java.util.List<java.lang.String> names, java.util.List<SequenceType> types, boolean extensible)
-
-
Method Detail
-
getGenre
public Genre getGenre()
Determine the Genre (top-level classification) of this type- Specified by:
getGenrein interfaceFunctionItemType- Specified by:
getGenrein interfaceItemType- Returns:
- the Genre to which this type belongs, specifically
Genre.MAP
-
isMapType
public boolean isMapType()
Ask whether this function item type is a map type. In this case function coercion (to the map type) will never succeed.- Specified by:
isMapTypein interfaceFunctionItemType- Overrides:
isMapTypein classAnyFunctionType- Returns:
- true if this FunctionItemType is a map type
-
isArrayType
public boolean isArrayType()
Ask whether this function item type is an array type. In this case function coercion (to the array type) will never succeed.- Specified by:
isArrayTypein interfaceFunctionItemType- Overrides:
isArrayTypein classAnyFunctionType- Returns:
- true if this FunctionItemType is an array type
-
getFieldNames
public java.lang.Iterable<java.lang.String> getFieldNames()
Get the names of all the fields- Specified by:
getFieldNamesin interfaceTupleType- Returns:
- the names of the fields (in arbitrary order)
-
getFieldType
public SequenceType getFieldType(java.lang.String field)
Get the type of a given field- Specified by:
getFieldTypein interfaceTupleType- Parameters:
field- the name of the field- Returns:
- the type of the field if it is defined, or null otherwise
-
isExtensible
public boolean isExtensible()
Ask whether the tuple type is extensible, that is, whether fields other than those named are permitted- Specified by:
isExtensiblein interfaceTupleType- Returns:
- true if fields other than the named fields are permitted to appear
-
matches
public boolean matches(Item item, TypeHierarchy th) throws XPathException
Test whether a given item conforms to this type- Specified by:
matchesin interfaceItemType- Overrides:
matchesin classAnyFunctionType- Parameters:
item- The item to be testedth- type hierarchy data- Returns:
- true if the item is an instance of this type; false otherwise
- Throws:
XPathException
-
getArity
public int getArity()
Get the arity (number of arguments) of this function type- Returns:
- the number of argument types in the function signature
-
getArgumentTypes
public SequenceType[] getArgumentTypes()
Get the argument types of this map, viewed as a function- Specified by:
getArgumentTypesin interfaceFunctionItemType- Overrides:
getArgumentTypesin classAnyFunctionType- Returns:
- the list of argument types of this map, viewed as a function
-
getResultType
public SequenceType getResultType()
Get the result type of this tuple type, viewed as a function- Specified by:
getResultTypein interfaceFunctionItemType- Overrides:
getResultTypein classAnyFunctionType- Returns:
- the result type of this tuple type, viewed as a function
-
getDefaultPriority
public double getDefaultPriority()
Get the default priority when this ItemType is used as an XSLT pattern- Specified by:
getDefaultPriorityin interfaceItemType- Overrides:
getDefaultPriorityin classAnyFunctionType- Returns:
- the default priority
-
toString
public java.lang.String toString()
Produce a representation of this type name for use in error messages.- Specified by:
toStringin interfaceItemType- Overrides:
toStringin classAnyFunctionType- Returns:
- a string representation of the type, in notation resembling but not necessarily identical to XPath syntax
-
toExportString
public java.lang.String toExportString()
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.- Specified by:
toExportStringin interfaceItemType- Returns:
- the string representation as an instance of the XPath ItemType construct
-
getBasicAlphaCode
public java.lang.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:
getBasicAlphaCodein interfaceItemType- Overrides:
getBasicAlphaCodein classAnyFunctionType- Returns:
- the alphacode for the nearest containing built-in type
-
equals
public boolean equals(java.lang.Object other)
Test whether this function type equals another function type- Overrides:
equalsin classjava.lang.Object
-
hashCode
public int hashCode()
Returns a hash code value for the object.- Overrides:
hashCodein classjava.lang.Object
-
relationship
public Affinity relationship(FunctionItemType other, TypeHierarchy th)
Determine the relationship of one function item type to another- Specified by:
relationshipin interfaceFunctionItemType- Overrides:
relationshipin classAnyFunctionType- Returns:
- for example
Affinity.SUBSUMES,Affinity.SAME_TYPE
-
explainMismatch
public java.util.Optional<java.lang.String> explainMismatch(Item item, TypeHierarchy th)
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:
explainMismatchin interfaceItemType- Parameters:
item- the item being matchedth- the type hierarchy cache- Returns:
- optionally, a message explaining why the item does not match the type
-
makeFunctionSequenceCoercer
public Expression makeFunctionSequenceCoercer(Expression exp, RoleDiagnostic role) throws XPathException
Description copied from class:AnyFunctionTypeCreate an expression whose effect is to apply function coercion to coerce a function from this type to another type- Specified by:
makeFunctionSequenceCoercerin interfaceFunctionItemType- Overrides:
makeFunctionSequenceCoercerin classAnyFunctionType- Parameters:
exp- the expression that delivers the supplied sequence of function items (the ones in need of coercion)role- information for use in diagnostics- Returns:
- the sequence of coerced functions, each on a function that calls the corresponding original function after checking the parameters
- Throws:
XPathException
-
-