<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc (build 1.6.0_18) on Fri Dec 09 20:47:44 GMT 2011 --> <TITLE> MapType </TITLE> <META NAME="date" CONTENT="2011-12-09"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="MapType"; } } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </HEAD> <BODY BGCOLOR="white" onload="windowTitle();"> <HR> <!-- ========= START OF TOP NAVBAR ======= --> <A NAME="navbar_top"><!-- --></A> <A HREF="#skip-navbar_top" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../com/saxonica/functions/map/MapSize.html" title="class in com.saxonica.functions.map"><B>PREV CLASS</B></A> <A HREF="../../../../com/saxonica/functions/map/SingletonMap.html" title="class in com.saxonica.functions.map"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?com/saxonica/functions/map/MapType.html" target="_top"><B>FRAMES</B></A> <A HREF="MapType.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> com.saxonica.functions.map</FONT> <BR> Class MapType</H2> <PRE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html" title="class in net.sf.saxon.type">net.sf.saxon.type.AnyFunctionType</A> <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.saxonica.functions.map.MapType</B> </PRE> <DL> <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A>, <A HREF="../../../../net/sf/saxon/type/FunctionItemType.html" title="interface in net.sf.saxon.type">FunctionItemType</A>, <A HREF="../../../../net/sf/saxon/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A></DD> </DL> <HR> <DL> <DT><PRE>public class <B>MapType</B><DT>extends <A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html" title="class in net.sf.saxon.type">AnyFunctionType</A></DL> </PRE> <P> An instance of this class represents a specific function item type, for example function(xs:int) as xs:boolean <P> <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#com.saxonica.functions.map.MapType">Serialized Form</A></DL> <HR> <P> <!-- =========== FIELD SUMMARY =========== --> <A NAME="field_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Field Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="../../../../com/saxonica/functions/map/MapType.html" title="class in com.saxonica.functions.map">MapType</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/saxonica/functions/map/MapType.html#ANY_MAP_TYPE">ANY_MAP_TYPE</A></B></CODE> <BR> </TD> </TR> </TABLE> <A NAME="fields_inherited_from_class_net.sf.saxon.type.AnyFunctionType"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Fields inherited from class net.sf.saxon.type.<A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html" title="class in net.sf.saxon.type">AnyFunctionType</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html#ANY_FUNCTION">ANY_FUNCTION</A>, <A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html#SINGLE_FUNCTION">SINGLE_FUNCTION</A></CODE></TD> </TR> </TABLE> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Constructor Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../com/saxonica/functions/map/MapType.html#MapType(net.sf.saxon.type.AtomicType, net.sf.saxon.value.SequenceType)">MapType</A></B>(<A HREF="../../../../net/sf/saxon/type/AtomicType.html" title="interface in net.sf.saxon.type">AtomicType</A> keyType, <A HREF="../../../../net/sf/saxon/value/SequenceType.html" title="class in net.sf.saxon.value">SequenceType</A> valueType)</CODE> <BR> </TD> </TR> </TABLE> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/saxonica/functions/map/MapType.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> other)</CODE> <BR> Test whether this function type equals another function type</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/value/SequenceType.html" title="class in net.sf.saxon.value">SequenceType</A>[]</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/saxonica/functions/map/MapType.html#getArgumentTypes()">getArgumentTypes</A></B>()</CODE> <BR> Get the argument types of this map, viewed as a function</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/saxonica/functions/map/MapType.html#getArity()">getArity</A></B>()</CODE> <BR> Get the arity (number of arguments) of this function type</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/value/SequenceType.html" title="class in net.sf.saxon.value">SequenceType</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/saxonica/functions/map/MapType.html#getResultType()">getResultType</A></B>()</CODE> <BR> Get the result type of this map, viewed as a function</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/saxonica/functions/map/MapType.html#getSuperType(net.sf.saxon.type.TypeHierarchy)">getSuperType</A></B>(<A HREF="../../../../net/sf/saxon/type/TypeHierarchy.html" title="class in net.sf.saxon.type">TypeHierarchy</A> th)</CODE> <BR> Get the type from which this item type is derived by restriction.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/saxonica/functions/map/MapType.html#hashCode()">hashCode</A></B>()</CODE> <BR> Returns a hash code value for the object.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/saxonica/functions/map/MapType.html#isMapType()">isMapType</A></B>()</CODE> <BR> Ask whether this function item type is a map type.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/saxonica/functions/map/MapType.html#makeFunctionSequenceCoercer(net.sf.saxon.expr.Expression, net.sf.saxon.expr.parser.RoleLocator, net.sf.saxon.TypeCheckerEnvironment)">makeFunctionSequenceCoercer</A></B>(<A HREF="../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> exp, <A HREF="../../../../net/sf/saxon/expr/parser/RoleLocator.html" title="class in net.sf.saxon.expr.parser">RoleLocator</A> role, <A HREF="../../../../net/sf/saxon/TypeCheckerEnvironment.html" title="interface in net.sf.saxon">TypeCheckerEnvironment</A> visitor)</CODE> <BR> Create an expression whose effect is to apply function coercion to coerce a function from this type to another type</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/saxonica/functions/map/MapType.html#matchesItem(net.sf.saxon.om.Item, boolean, net.sf.saxon.Configuration)">matchesItem</A></B>(<A HREF="../../../../net/sf/saxon/om/Item.html" title="interface in net.sf.saxon.om">Item</A> item, boolean allowURIPromotion, <A HREF="../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config)</CODE> <BR> Test whether a given item conforms to this type</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/saxonica/functions/map/MapType.html#relationship(net.sf.saxon.type.FunctionItemType, net.sf.saxon.type.TypeHierarchy)">relationship</A></B>(<A HREF="../../../../net/sf/saxon/type/FunctionItemType.html" title="interface in net.sf.saxon.type">FunctionItemType</A> other, <A HREF="../../../../net/sf/saxon/type/TypeHierarchy.html" title="class in net.sf.saxon.type">TypeHierarchy</A> th)</CODE> <BR> Determine the relationship of one function item type to another</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/saxonica/functions/map/MapType.html#toString()">toString</A></B>()</CODE> <BR> Produce a representation of this type name for use in error messages.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/saxonica/functions/map/MapType.html#toString(net.sf.saxon.om.NamePool)">toString</A></B>(<A HREF="../../../../net/sf/saxon/om/NamePool.html" title="class in net.sf.saxon.om">NamePool</A> pool)</CODE> <BR> Produce a representation of this type name for use in error messages.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/saxonica/functions/map/MapType.html#visitNamedSchemaComponents(net.sf.saxon.type.SchemaComponentVisitor)">visitNamedSchemaComponents</A></B>(<A HREF="../../../../net/sf/saxon/type/SchemaComponentVisitor.html" title="interface in net.sf.saxon.type">SchemaComponentVisitor</A> visitor)</CODE> <BR> Visit all the schema components used in this ItemType definition</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_net.sf.saxon.type.AnyFunctionType"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class net.sf.saxon.type.<A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html" title="class in net.sf.saxon.type">AnyFunctionType</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html#getAtomizedItemType()">getAtomizedItemType</A>, <A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html#getDefaultPriority()">getDefaultPriority</A>, <A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html#getInstance()">getInstance</A>, <A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html#getPrimitiveItemType()">getPrimitiveItemType</A>, <A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html#getPrimitiveType()">getPrimitiveType</A>, <A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html#isAtomicType()">isAtomicType</A>, <A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html#isAtomizable()">isAtomizable</A>, <A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html#isPlainType()">isPlainType</A>, <A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html#matches(net.sf.saxon.om.Item, net.sf.saxon.expr.XPathContext)">matches</A></CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> </TR> </TABLE> <P> <!-- ============ FIELD DETAIL =========== --> <A NAME="field_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Field Detail</B></FONT></TH> </TR> </TABLE> <A NAME="ANY_MAP_TYPE"><!-- --></A><H3> ANY_MAP_TYPE</H3> <PRE> public static final <A HREF="../../../../com/saxonica/functions/map/MapType.html" title="class in com.saxonica.functions.map">MapType</A> <B>ANY_MAP_TYPE</B></PRE> <DL> <DL> </DL> </DL> <!-- ========= CONSTRUCTOR DETAIL ======== --> <A NAME="constructor_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Constructor Detail</B></FONT></TH> </TR> </TABLE> <A NAME="MapType(net.sf.saxon.type.AtomicType, net.sf.saxon.value.SequenceType)"><!-- --></A><H3> MapType</H3> <PRE> public <B>MapType</B>(<A HREF="../../../../net/sf/saxon/type/AtomicType.html" title="interface in net.sf.saxon.type">AtomicType</A> keyType, <A HREF="../../../../net/sf/saxon/value/SequenceType.html" title="class in net.sf.saxon.value">SequenceType</A> valueType)</PRE> <DL> </DL> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Method Detail</B></FONT></TH> </TR> </TABLE> <A NAME="isMapType()"><!-- --></A><H3> isMapType</H3> <PRE> public boolean <B>isMapType</B>()</PRE> <DL> <DD>Ask whether this function item type is a map type. In this case function coercion (to the map type) will never succeed. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/FunctionItemType.html#isMapType()">isMapType</A></CODE> in interface <CODE><A HREF="../../../../net/sf/saxon/type/FunctionItemType.html" title="interface in net.sf.saxon.type">FunctionItemType</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html#isMapType()">isMapType</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html" title="class in net.sf.saxon.type">AnyFunctionType</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>true if this FunctionItemType is a map type</DL> </DD> </DL> <HR> <A NAME="getArity()"><!-- --></A><H3> getArity</H3> <PRE> public int <B>getArity</B>()</PRE> <DL> <DD>Get the arity (number of arguments) of this function type <P> <DD><DL> <DT><B>Returns:</B><DD>the number of argument types in the function signature</DL> </DD> </DL> <HR> <A NAME="getArgumentTypes()"><!-- --></A><H3> getArgumentTypes</H3> <PRE> public <A HREF="../../../../net/sf/saxon/value/SequenceType.html" title="class in net.sf.saxon.value">SequenceType</A>[] <B>getArgumentTypes</B>()</PRE> <DL> <DD>Get the argument types of this map, viewed as a function <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/FunctionItemType.html#getArgumentTypes()">getArgumentTypes</A></CODE> in interface <CODE><A HREF="../../../../net/sf/saxon/type/FunctionItemType.html" title="interface in net.sf.saxon.type">FunctionItemType</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html#getArgumentTypes()">getArgumentTypes</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html" title="class in net.sf.saxon.type">AnyFunctionType</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the list of argument types of this map, viewed as a function</DL> </DD> </DL> <HR> <A NAME="getResultType()"><!-- --></A><H3> getResultType</H3> <PRE> public <A HREF="../../../../net/sf/saxon/value/SequenceType.html" title="class in net.sf.saxon.value">SequenceType</A> <B>getResultType</B>()</PRE> <DL> <DD>Get the result type of this map, viewed as a function <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/FunctionItemType.html#getResultType()">getResultType</A></CODE> in interface <CODE><A HREF="../../../../net/sf/saxon/type/FunctionItemType.html" title="interface in net.sf.saxon.type">FunctionItemType</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html#getResultType()">getResultType</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html" title="class in net.sf.saxon.type">AnyFunctionType</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the result type of this map, viewed as a function</DL> </DD> </DL> <HR> <A NAME="matchesItem(net.sf.saxon.om.Item, boolean, net.sf.saxon.Configuration)"><!-- --></A><H3> matchesItem</H3> <PRE> public boolean <B>matchesItem</B>(<A HREF="../../../../net/sf/saxon/om/Item.html" title="interface in net.sf.saxon.om">Item</A> item, boolean allowURIPromotion, <A HREF="../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config)</PRE> <DL> <DD>Test whether a given item conforms to this type <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html#matchesItem(net.sf.saxon.om.Item, boolean, net.sf.saxon.Configuration)">matchesItem</A></CODE> in interface <CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html#matchesItem(net.sf.saxon.om.Item, boolean, net.sf.saxon.Configuration)">matchesItem</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html" title="class in net.sf.saxon.type">AnyFunctionType</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>item</CODE> - the item to be tested<DD><CODE>allowURIPromotion</CODE> - true if promotion from URI to string is allowed<DD><CODE>config</CODE> - the Saxon configuration <DT><B>Returns:</B><DD>true if the item is an instance of this type; false otherwise</DL> </DD> </DL> <HR> <A NAME="getSuperType(net.sf.saxon.type.TypeHierarchy)"><!-- --></A><H3> getSuperType</H3> <PRE> public <A HREF="../../../../net/sf/saxon/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A> <B>getSuperType</B>(<A HREF="../../../../net/sf/saxon/type/TypeHierarchy.html" title="class in net.sf.saxon.type">TypeHierarchy</A> th)</PRE> <DL> <DD>Get the type from which this item type is derived by restriction. This is the supertype in the XPath type heirarchy, as distinct from the Schema base type: this means that the supertype of xs:boolean is xs:anyAtomicType, whose supertype is item() (rather than xs:anySimpleType). <p/> In fact the concept of "supertype" is not really well-defined, because the types form a lattice rather than a hierarchy. The only real requirement on this function is that it returns a type that strictly subsumes this type, ideally as narrowly as possible. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html#getSuperType(net.sf.saxon.type.TypeHierarchy)">getSuperType</A></CODE> in interface <CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html#getSuperType(net.sf.saxon.type.TypeHierarchy)">getSuperType</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html" title="class in net.sf.saxon.type">AnyFunctionType</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>th</CODE> - the type hierarchy cache <DT><B>Returns:</B><DD>the supertype, or null if this type is item()</DL> </DD> </DL> <HR> <A NAME="toString(net.sf.saxon.om.NamePool)"><!-- --></A><H3> toString</H3> <PRE> public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>(<A HREF="../../../../net/sf/saxon/om/NamePool.html" title="class in net.sf.saxon.om">NamePool</A> pool)</PRE> <DL> <DD>Produce a representation of this type name for use in error messages. Where this is a QName, it will use conventional prefixes <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html#toString(net.sf.saxon.om.NamePool)">toString</A></CODE> in interface <CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html#toString(net.sf.saxon.om.NamePool)">toString</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html" title="class in net.sf.saxon.type">AnyFunctionType</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>pool</CODE> - the name pool <DT><B>Returns:</B><DD>a string representation of the type, in notation resembling but not necessarily identical to XPath syntax</DL> </DD> </DL> <HR> <A NAME="toString()"><!-- --></A><H3> toString</H3> <PRE> public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE> <DL> <DD>Produce a representation of this type name for use in error messages. <P> <DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html#toString()">toString</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html" title="class in net.sf.saxon.type">AnyFunctionType</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>a string representation of the type, in notation resembling but not necessarily identical to XPath syntax</DL> </DD> </DL> <HR> <A NAME="equals(java.lang.Object)"><!-- --></A><H3> equals</H3> <PRE> public boolean <B>equals</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> other)</PRE> <DL> <DD>Test whether this function type equals another function type <P> <DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A></CODE> in class <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="hashCode()"><!-- --></A><H3> hashCode</H3> <PRE> public int <B>hashCode</B>()</PRE> <DL> <DD>Returns a hash code value for the object. <P> <DD><DL> <DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A></CODE> in class <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="relationship(net.sf.saxon.type.FunctionItemType, net.sf.saxon.type.TypeHierarchy)"><!-- --></A><H3> relationship</H3> <PRE> public int <B>relationship</B>(<A HREF="../../../../net/sf/saxon/type/FunctionItemType.html" title="interface in net.sf.saxon.type">FunctionItemType</A> other, <A HREF="../../../../net/sf/saxon/type/TypeHierarchy.html" title="class in net.sf.saxon.type">TypeHierarchy</A> th)</PRE> <DL> <DD>Determine the relationship of one function item type to another <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/FunctionItemType.html#relationship(net.sf.saxon.type.FunctionItemType, net.sf.saxon.type.TypeHierarchy)">relationship</A></CODE> in interface <CODE><A HREF="../../../../net/sf/saxon/type/FunctionItemType.html" title="interface in net.sf.saxon.type">FunctionItemType</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html#relationship(net.sf.saxon.type.FunctionItemType, net.sf.saxon.type.TypeHierarchy)">relationship</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html" title="class in net.sf.saxon.type">AnyFunctionType</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>for example <A HREF="../../../../net/sf/saxon/type/TypeHierarchy.html#SUBSUMES"><CODE>TypeHierarchy.SUBSUMES</CODE></A>, <A HREF="../../../../net/sf/saxon/type/TypeHierarchy.html#SAME_TYPE"><CODE>TypeHierarchy.SAME_TYPE</CODE></A></DL> </DD> </DL> <HR> <A NAME="makeFunctionSequenceCoercer(net.sf.saxon.expr.Expression, net.sf.saxon.expr.parser.RoleLocator, net.sf.saxon.TypeCheckerEnvironment)"><!-- --></A><H3> makeFunctionSequenceCoercer</H3> <PRE> public <A HREF="../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> <B>makeFunctionSequenceCoercer</B>(<A HREF="../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> exp, <A HREF="../../../../net/sf/saxon/expr/parser/RoleLocator.html" title="class in net.sf.saxon.expr.parser">RoleLocator</A> role, <A HREF="../../../../net/sf/saxon/TypeCheckerEnvironment.html" title="interface in net.sf.saxon">TypeCheckerEnvironment</A> visitor) throws <A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE> <DL> <DD><B>Description copied from class: <CODE><A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html#makeFunctionSequenceCoercer(net.sf.saxon.expr.Expression, net.sf.saxon.expr.parser.RoleLocator, net.sf.saxon.TypeCheckerEnvironment)">AnyFunctionType</A></CODE></B></DD> <DD>Create an expression whose effect is to apply function coercion to coerce a function from this type to another type <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/FunctionItemType.html#makeFunctionSequenceCoercer(net.sf.saxon.expr.Expression, net.sf.saxon.expr.parser.RoleLocator, net.sf.saxon.TypeCheckerEnvironment)">makeFunctionSequenceCoercer</A></CODE> in interface <CODE><A HREF="../../../../net/sf/saxon/type/FunctionItemType.html" title="interface in net.sf.saxon.type">FunctionItemType</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html#makeFunctionSequenceCoercer(net.sf.saxon.expr.Expression, net.sf.saxon.expr.parser.RoleLocator, net.sf.saxon.TypeCheckerEnvironment)">makeFunctionSequenceCoercer</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html" title="class in net.sf.saxon.type">AnyFunctionType</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>exp</CODE> - the expression that delivers the supplied sequence of function items (the ones in need of coercion)<DD><CODE>role</CODE> - information for use in diagnostics<DD><CODE>visitor</CODE> - the expression visitor, supplies context information <DT><B>Returns:</B><DD>the coerced function, a function that calls the original function after checking the parameters <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE></DL> </DD> </DL> <HR> <A NAME="visitNamedSchemaComponents(net.sf.saxon.type.SchemaComponentVisitor)"><!-- --></A><H3> visitNamedSchemaComponents</H3> <PRE> public void <B>visitNamedSchemaComponents</B>(<A HREF="../../../../net/sf/saxon/type/SchemaComponentVisitor.html" title="interface in net.sf.saxon.type">SchemaComponentVisitor</A> visitor) throws <A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE> <DL> <DD>Visit all the schema components used in this ItemType definition <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html#visitNamedSchemaComponents(net.sf.saxon.type.SchemaComponentVisitor)">visitNamedSchemaComponents</A></CODE> in interface <CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html#visitNamedSchemaComponents(net.sf.saxon.type.SchemaComponentVisitor)">visitNamedSchemaComponents</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/type/AnyFunctionType.html" title="class in net.sf.saxon.type">AnyFunctionType</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>visitor</CODE> - the visitor class to be called when each component is visited <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - if an error occurs</DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ======= START OF BOTTOM NAVBAR ====== --> <A NAME="navbar_bottom"><!-- --></A> <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../com/saxonica/functions/map/MapSize.html" title="class in com.saxonica.functions.map"><B>PREV CLASS</B></A> <A HREF="../../../../com/saxonica/functions/map/SingletonMap.html" title="class in com.saxonica.functions.map"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?com/saxonica/functions/map/MapType.html" target="_top"><B>FRAMES</B></A> <A HREF="MapType.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> Copyright (c) 2004-2011 Saxonica Limited. All rights reserved. </BODY> </HTML>