<xm:xml-map> Tag

Specifies that its contents constitute an XML map; also provides the signature defining calls to this map.

# Syntax

    <xm:xml-map
        signature="mapSignature"
    >

# Attributes

signature

The signature of map enclosed in <xm:xml-map> tags.

# Remarks

The <xm:xml-map> tag is used only in map files — files with an .xmlmap extension that contain XML maps. You must enclose every map in a map file between <xm:xml-map> tags. The signature attribute specifies name of the XML map and parameters expected for a call to the enclosed map. For example, consider the following map:

    <!-- Defined in a file called "BookMaps.xmlmap" -->
    <xm:xml-map signature="getInventory(String partID)">
        <checkInventory>
            <partID>{partID}</partID>
        </checkInventory>
    </xm:xml-map>

A call to the map in this example might look something like the following.

    /**
     * @jws:operation
     * @jws:parameter-xml xml-map::
     * <checkInventory>
     *     {BookMaps.getInventoryString(String ISBN)}
     * </checkInventory>
     * ::
     *
     */
    public String checkInventory(String ISBN)
    {
        return "You checked for copies of " + ISBN + ".";
    }

Note The xm prefix and its URI are declared implicitly in any JWS file. However, you must declare the namespace prefix and URI to use the prefix in XMLMAP files. You typically do this in the <xm:map-file> tag.

Related Topics

Creating Reusable XML Maps

<xm:map-file> Tag