net.sf.saxon.ma.map

Class MapType

java.lang.Object

net.sf.saxon.type.AnyFunctionType

net.sf.saxon.ma.map.MapType

All Implemented Interfaces:

FunctionItemType, ItemType

public class MapType
extends AnyFunctionType

An instance of this class represents a specific map item type, for example map(x:integer, element(employee))

Nested Class Summary

Nested classes/interfaces inherited from interface net.sf.saxon.type.ItemType

ItemType.WithSequenceTypeCache

Field Summary

Fields

Modifier and Type	Field and Description
static MapType	ANY_MAP_TYPE
static MapType	EMPTY_MAP_TYPE
static SequenceType	OPTIONAL_MAP_ITEM A type that allows a sequence of zero or one map items
static SequenceType	SEQUENCE_OF_MAPS
static SequenceType	SINGLE_MAP_ITEM

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

ANY_FUNCTION

Constructor Summary

Constructors

Constructor and Description
MapType(AtomicType keyType, SequenceType valueType)
MapType(AtomicType keyType, SequenceType valueType, boolean mustBeEmpty)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other) Test whether this function type equals another function type
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.
java.lang.String	generateJavaScriptItemTypeTest(ItemType knownToBe, int targetVersion) Generate Javascript code to test whether an item conforms to this item type
java.lang.String	getAlphaCode() Get an alphabetic code representing the type, or at any rate, the nearest built-in type from which this type is derived.
SequenceType[]	getArgumentTypes() Get the argument types of this map, viewed as a function
int	getArity() Get the arity (number of arguments) of this function type
Genre	getGenre() Determine the Genre (top-level classification) of this type
AtomicType	getKeyType() Get the type of the keys
SequenceType	getResultType() Get the result type of this map, viewed as a function
SequenceType	getValueType() Get the type of the indexed values
int	hashCode() Returns a hash code value for the object.
boolean	isArrayType() Ask whether this function item type is an array type.
boolean	isAtomizable(TypeHierarchy th) Ask whether values of this type are atomizable
boolean	isMapType() Ask whether this function item type is a map type.
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
java.lang.String	toExportString() Return a string representation of this ItemType suitable for use in stylesheet export files.
java.lang.String	toString() Produce a representation of this type name for use in error messages.

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

generateJavaScriptItemTypeAcceptor, getAnnotationAssertions, getAtomizedItemType, getInstance, getPrimitiveItemType, getPrimitiveType, getUType, isAtomicType, isPlainType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

isTrueItemType

Field Detail

ANY_MAP_TYPE

public static final MapType ANY_MAP_TYPE

EMPTY_MAP_TYPE

public static final MapType EMPTY_MAP_TYPE

OPTIONAL_MAP_ITEM

public static final SequenceType OPTIONAL_MAP_ITEM

A type that allows a sequence of zero or one map items

SINGLE_MAP_ITEM

public static final SequenceType SINGLE_MAP_ITEM

SEQUENCE_OF_MAPS

public static final SequenceType SEQUENCE_OF_MAPS

Constructor Detail

MapType

public MapType(AtomicType keyType,
               SequenceType valueType)

MapType

public MapType(AtomicType keyType,
               SequenceType valueType,
               boolean mustBeEmpty)

Method Detail

getGenre

public Genre getGenre()

Determine the Genre (top-level classification) of this type

Returns:

the Genre to which this type belongs, specifically Genre.MAP

getKeyType

public AtomicType getKeyType()

Get the type of the keys

Returns:

the type to which all keys must conform

getValueType

public SequenceType getValueType()

Get the type of the indexed values

Returns:

the type to which all associated values must conform

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:

isMapType in interface FunctionItemType

Overrides:

isMapType in class AnyFunctionType

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:

isArrayType in interface FunctionItemType

Overrides:

isArrayType in class AnyFunctionType

Returns:

true if this FunctionItemType is an array type

getAlphaCode

public java.lang.String getAlphaCode()

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:

getAlphaCode in interface ItemType

Overrides:

getAlphaCode in class AnyFunctionType

Returns:

the alphacode for the nearest containing built-in type

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

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 -

Returns:

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

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:

getArgumentTypes in interface FunctionItemType

Overrides:

getArgumentTypes in class AnyFunctionType

Returns:

the list of argument types of this map, viewed as a function

getResultType

public SequenceType getResultType()

Get the result type of this map, viewed as a function

Specified by:

getResultType in interface FunctionItemType

Overrides:

getResultType in class AnyFunctionType

Returns:

the result type of this map, viewed as a function

toString

public java.lang.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 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. 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(java.lang.Object other)

Test whether this function type equals another function type

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class java.lang.Object

relationship

public int relationship(FunctionItemType other,
                        TypeHierarchy th)

Determine the relationship of one function item type to another

Specified by:

relationship in interface FunctionItemType

Overrides:

relationship in class AnyFunctionType

Returns:

for example TypeHierarchy.SUBSUMES, TypeHierarchy.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.

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 java.lang.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 - a type that this item is known to conform to

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.