net.sf.saxon.type

Class SpecificFunctionType

java.lang.Object

net.sf.saxon.type.AnyFunctionType

net.sf.saxon.type.SpecificFunctionType

All Implemented Interfaces:

FunctionItemType, ItemType

public class SpecificFunctionType
extends AnyFunctionType

An instance of this class represents a specific function item type, for example function(xs:int) as xs:boolean

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 and Description
SpecificFunctionType(SequenceType[] argTypes, SequenceType resultType)
SpecificFunctionType(SequenceType[] argTypes, SequenceType resultType, AnnotationList annotations)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Test whether this function type equals another function type
Optional<String>	explainMismatch(Item item, TypeHierarchy th) Get extra diagnostic information about why a supplied item does not conform to this item type, if available.
String	generateJavaScriptItemTypeTest(ItemType knownToBe, int targetVersion) Generate Javascript code to test whether an item conforms to this item type
AnnotationList	getAnnotationAssertions() Get the list of annotation assertions defined on this function item type.
SequenceType[]	getArgumentTypes() Get the argument types
int	getArity() Get the arity (number of arguments) of this function type
SequenceType	getResultType() Get the result type
int	hashCode() Returns a hash code value for the object.
boolean	isAtomizable(TypeHierarchy th) Ask whether values of this type are atomizable
Expression	makeFunctionSequenceCoercer(Expression exp, RoleDiagnostic role) Create an expression whose effect is to apply function coercion to coerce a function from this type to another type
boolean	matches(Item item, TypeHierarchy th) Test whether a given item conforms to this type
int	relationship(FunctionItemType other, TypeHierarchy th) Determine the relationship of one function item type to another.
String	toExportString() Return a string representation of this ItemType suitable for use in stylesheet export files.
String	toString() Produce a representation of this type name for use in error messages.

Methods inherited from class net.sf.saxon.type.AnyFunctionType

generateJavaScriptItemTypeAcceptor, getAlphaCode, getAtomizedItemType, getInstance, getPrimitiveItemType, getPrimitiveType, getUType, isArrayType, isAtomicType, isMapType, 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

getGenre

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

isTrueItemType

Constructor Detail

SpecificFunctionType

public SpecificFunctionType(SequenceType[] argTypes,
                            SequenceType resultType)

SpecificFunctionType

public SpecificFunctionType(SequenceType[] argTypes,
                            SequenceType resultType,
                            AnnotationList annotations)

Method Detail

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

Specified by:

getArgumentTypes in interface FunctionItemType

Overrides:

getArgumentTypes in class AnyFunctionType

Returns:

the list of argument types

getResultType

public SequenceType getResultType()

Get the result type

Specified by:

getResultType in interface FunctionItemType

Overrides:

getResultType in class AnyFunctionType

Returns:

the result type

getAnnotationAssertions

public AnnotationList getAnnotationAssertions()

Get the list of annotation assertions defined on this function item type.

Specified by:

getAnnotationAssertions in interface FunctionItemType

Overrides:

getAnnotationAssertions in class AnyFunctionType

Returns:

the list of annotation assertions, or an empty list if there are none

isAtomizable

public boolean isAtomizable(TypeHierarchy th)

Ask whether values of this type are atomizable

Specified by:

isAtomizable in interface ItemType

Overrides:

isAtomizable in class AnyFunctionType

Parameters:

th - The type hierarchy cache

Returns:

true if some or all instances of this type can be successfully atomized; false * if no instances of this type can be atomized

toString

public String toString()

Produce a representation of this type name for use in error messages.

Specified by:

toString in interface ItemType

Overrides:

toString in class AnyFunctionType

Returns:

a string representation of the type, in notation resembling but not necessarily identical to XPath syntax

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().

Returns:

the string representation as an instance of the XPath SequenceType construct

equals

public boolean equals(Object other)

Test whether this function type equals another function type

Overrides:

equals in class Object

hashCode

public int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class Object

relationship

public int relationship(FunctionItemType other,
                        TypeHierarchy th)

Determine the relationship of one function item type to another. This method is only concerned with the type signatures of the two function item types, and not with their annotation assertions.

Specified by:

relationship in interface FunctionItemType

Overrides:

relationship in class AnyFunctionType

Returns:

for example TypeHierarchy.SUBSUMES, TypeHierarchy.SAME_TYPE

matches

public boolean matches(Item item,
                       TypeHierarchy th)

Test whether a given item conforms to this type

Specified by:

matches in interface ItemType

Overrides:

matches in class AnyFunctionType

Parameters:

item - The item to be tested

th - the type hierarchy cache

Returns:

true if the item is an instance of this type; false otherwise

explainMismatch

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

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

makeFunctionSequenceCoercer

public Expression makeFunctionSequenceCoercer(Expression exp,
                                              RoleDiagnostic role)
                                       throws XPathException

Description copied from class: AnyFunctionType

Create an expression whose effect is to apply function coercion to coerce a function from this type to another type

Specified by:

makeFunctionSequenceCoercer in interface FunctionItemType

Overrides:

makeFunctionSequenceCoercer in class AnyFunctionType

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

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

Overrides:

generateJavaScriptItemTypeTest in class AnyFunctionType

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.