The XML Schema Definition of the XPath element as defined in the W3C Recommendation for XML-Signature XPath Filter 2.0:


<schema xmlns="http://www.w3.org/2001/XMLSchema"
        xmlns:xf="http://www.w3.org/2002/06/xmldsig-filter2"
        targetNamespace="http://www.w3.org/2002/06/xmldsig-filter2"
        version="0.1" elementFormDefault="qualified">

<element name="XPath"
         type="xf:XPathType"/>

<complexType name="XPathType">
  <simpleContent>
    <extension base="string">
      <attribute name="Filter">
        <simpleType>
          <restriction base="string">
            <enumeration value="intersect"/>
            <enumeration value="subtract"/>
            <enumeration value="union"/>
          </restriction>
        </simpleType>
      </attribute>
    </extension>
  </simpleContent>
</complexType>

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	XPathType.Filter Represents the filter set operation.

Modifier and Type	Field and Description
private final String	expression
private final XPathType.Filter	filter
private final Map<String, String>	nsMap

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	XPathType(String the XPath expression to be evaluated expression, XPathType.Filter the filter operation (`Filter#INTERSECT`, `Filter#SUBTRACT`, or `Filter#UNION`) filter) Creates an `XPathType` instance with the specified XPath expression and filter.
public	XPathType(String the XPath expression to be evaluated expression, XPathType.Filter the filter operation (`Filter#INTERSECT`, `Filter#SUBTRACT`, or `Filter#UNION`) filter, Map<String, String> the map of namespace prefixes. Each key is a namespace prefix `String` that maps to a corresponding namespace URI `String`. namespaceMap) Creates an `XPathType` instance with the specified XPath expression, filter, and namespace map.

public

XPathType(String

the XPath expression to be evaluated

expression, XPathType.Filter

the filter operation (Filter#INTERSECT, Filter#SUBTRACT, or Filter#UNION)

filter)

Creates an XPathType instance with the specified XPath expression and filter.

public

XPathType(String

the XPath expression to be evaluated

expression, XPathType.Filter

the filter operation (Filter#INTERSECT, Filter#SUBTRACT, or Filter#UNION)

filter, Map<String, String>

the map of namespace prefixes. Each key is a namespace prefix String that maps to a corresponding namespace URI String.

namespaceMap)

Creates an XPathType instance with the specified XPath expression, filter, and namespace map.

Method Summary

Modifier and Type	Method and Description
public String	Returns: the XPath expression to be evaluated getExpression() Returns the XPath expression to be evaluated.
public XPathType.Filter	Returns: the filter operation getFilter() Returns the filter operation.
public Map<String, String>	Returns: a `Map` of namespace prefixes to namespace URIs (may be empty, but never `null`) getNamespaceMap() Returns a map of namespace prefixes.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

expression	back to summary
private final String expression

filter	back to summary
private final XPathType.Filter filter

nsMap	back to summary
private final Map<String, String> nsMap

Constructor Detail

XPathType back to summary

XPathType	back to summary
public XPathType(String expression, XPathType.Filter filter) Creates an `XPathType` instance with the specified XPath expression and filter. Parameters expression:String the XPath expression to be evaluated filter:XPathType.Filter the filter operation (`Filter#INTERSECT`, `Filter#SUBTRACT`, or `Filter#UNION`) Exceptions NullPointerException: if `expression` or `filter` is `null`

public XPathType(String expression, XPathType.Filter filter)

Creates an XPathType instance with the specified XPath expression and filter.

Parameters

expression:String: the XPath expression to be evaluated
filter:XPathType.Filter: the filter operation (Filter#INTERSECT, Filter#SUBTRACT, or Filter#UNION)

Exceptions

NullPointerException:: if expression or filter is null

XPathType back to summary

XPathType	back to summary
public XPathType(String expression, XPathType.Filter filter, Map<String, String> namespaceMap) Creates an `XPathType` instance with the specified XPath expression, filter, and namespace map. The map is copied to protect against subsequent modification. Parameters expression:String the XPath expression to be evaluated filter:XPathType.Filter the filter operation (`Filter#INTERSECT`, `Filter#SUBTRACT`, or `Filter#UNION`) namespaceMap:Map<String, String> the map of namespace prefixes. Each key is a namespace prefix `String` that maps to a corresponding namespace URI `String`. Exceptions NullPointerException: if `expression`, `filter` or `namespaceMap` are `null` ClassCastException: if any of the map's keys or entries are not of type `String`

public XPathType(String expression, XPathType.Filter filter, Map<String, String> namespaceMap)

Creates an XPathType instance with the specified XPath expression, filter, and namespace map. The map is copied to protect against subsequent modification.

Parameters

expression:String: the XPath expression to be evaluated
filter:XPathType.Filter: the filter operation (Filter#INTERSECT, Filter#SUBTRACT, or Filter#UNION)
namespaceMap:Map<String, String>: the map of namespace prefixes. Each key is a namespace prefix String that maps to a corresponding namespace URI String.

Exceptions

NullPointerException:: if expression, filter or namespaceMap are null
ClassCastException:: if any of the map's keys or entries are not of type String

Method Detail

getExpression	back to summary
public String getExpression() Returns the XPath expression to be evaluated. Returns:String the XPath expression to be evaluated

getExpression

back to summary

public String getExpression()

Returns the XPath expression to be evaluated.

Returns:String: the XPath expression to be evaluated

getFilter	back to summary
public XPathType.Filter getFilter() Returns the filter operation. Returns:XPathType.Filter the filter operation

getFilter

back to summary

public XPathType.Filter getFilter()

Returns the filter operation.

Returns:XPathType.Filter: the filter operation

getNamespaceMap back to summary

getNamespaceMap	back to summary
public Map<String, String> getNamespaceMap() Returns a map of namespace prefixes. Each key is a namespace prefix `String` that maps to a corresponding namespace URI `String`. This implementation returns an `unmodifiable map`. Returns:Map<String, String> a `Map` of namespace prefixes to namespace URIs (may be empty, but never `null`)

public Map<String, String> getNamespaceMap()

Returns a map of namespace prefixes. Each key is a namespace prefix String that maps to a corresponding namespace URI String.

This implementation returns an unmodifiable map.

Returns:Map<String, String>: a Map of namespace prefixes to namespace URIs (may be empty, but never null)

javax.xml.crypto.dsig.spec back to summary

public Class XPathType.Filter

Class Inheritance

extends Object

java.lang.Object
javax.xml.crypto.dsig.spec.XPathType.Filter

Represents the filter set operation.

Field Summary

Modifier and Type	Field and Description
public static final XPathType.Filter	INTERSECT The intersect filter operation.
private final String	operation
public static final XPathType.Filter	SUBTRACT The subtract filter operation.
public static final XPathType.Filter	UNION The union filter operation.

Constructor Summary

Access	Constructor and Description
private	Filter(String operation)

Method Summary

Modifier and Type	Method and Description
public String	Returns: the string form of the operation toString() Overrides java.lang.Object.toString. Returns the string form of the operation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

INTERSECT	back to summary
public static final XPathType.Filter INTERSECT The intersect filter operation.

operation	back to summary
private final String operation

SUBTRACT	back to summary
public static final XPathType.Filter SUBTRACT The subtract filter operation.

UNION	back to summary
public static final XPathType.Filter UNION The union filter operation.

Constructor Detail

Filter	back to summary
private Filter(String operation)

Method Detail

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns the string form of the operation. Returns:String the string form of the operation

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns the string form of the operation.

Returns:String: the string form of the operation