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

Field Summary

Fields
Modifier and Type	Field	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	Description
`MapType(AtomicType keyType, SequenceType valueType, boolean mustBeEmpty)`
`MapType(PlainType keyType, SequenceType valueType)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	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.
`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
`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.
`double`	`getDefaultPriority()`	Get the default priority when this ItemType is used as an XSLT pattern
`Genre`	`getGenre()`	Determine the Genre (top-level classification) of this type
`PlainType`	`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
`Affinity`	`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
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
getFullAlphaCode, getNormalizedDefaultPriority

- 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(PlainType 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 PlainType 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
  - 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:
    
    getBasicAlphaCode in interface ItemType
    
    Overrides:
    
    getBasicAlphaCode 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
  - getDefaultPriority
```
public double getDefaultPriority()
```
    Get the default priority when this ItemType is used as an XSLT pattern
    
    Specified by:
    
    getDefaultPriority in interface ItemType
    
    Overrides:
    
    getDefaultPriority in class AnyFunctionType
    
    Returns:
    
    the default priority
  - 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
  - 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.
    
    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 Affinity 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
    
    Parameters:
    
    other - the other function item type
    
    th - the type hierarchy cache
    
    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.
    
    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 - if an error is detected

Class MapType

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

ANY_MAP_TYPE

EMPTY_MAP_TYPE

OPTIONAL_MAP_ITEM

SINGLE_MAP_ITEM

SEQUENCE_OF_MAPS

Constructor Detail

MapType

MapType

Method Detail

getGenre

getKeyType

getValueType

isMapType

isArrayType

getBasicAlphaCode

isAtomizable

getDefaultPriority

matches

getArity

getArgumentTypes

getResultType

toString

toExportString

equals

hashCode

relationship

explainMismatch

makeFunctionSequenceCoercer