APIdia Launch Partner
Top Description Fields Constructors Methods
com.sun.org.apache.xml.internal.security.transforms.params

public final Class XPath2FilterContainer

extends ElementProxy
implements TransformParam
Class Inheritance
All Implemented Interfaces
com.sun.org.apache.xml.internal.security.transforms.TransformParam
Imports
com.sun.org.apache.xml.internal.security.exceptions.XMLSecurityException, com.sun.org.apache.xml.internal.security.transforms.TransformParam, com.sun.org.apache.xml.internal.security.utils.ElementProxy, .HelperNodeList, .XMLUtils, org.w3c.dom.Document, .Element, .Node, .NodeList
Implements the parameters for the XPath Filter v2.0.
See Also
XPath Filter v2.0 (TR)

Field Summary

Modifier and TypeField and Description
private static final String
_ATT_FILTER

Field _ATT_FILTER

private static final String
_ATT_FILTER_VALUE_INTERSECT

Field _ATT_FILTER_VALUE_INTERSECT

private static final String
_ATT_FILTER_VALUE_SUBTRACT

Field _ATT_FILTER_VALUE_SUBTRACT

private static final String
_ATT_FILTER_VALUE_UNION

Field _ATT_FILTER_VALUE_UNION

public static final String
_TAG_XPATH2

Field _TAG_XPATH2

public static final String
INTERSECT

Field INTERSECT

public static final String
SUBTRACT

Field SUBTRACT

public static final String
UNION

Field UNION

public static final String
XPathFilter2NS

Field XPathFiler2NS

Inherited from com.sun.org.apache.xml.internal.security.utils.ElementProxy:
baseURILOG

Constructor Summary

AccessConstructor and Description
private
XPath2FilterContainer()

Constructor XPath2FilterContainer

private
XPath2FilterContainer(Document doc, String xpath2filter, String filterType)

Constructor XPath2FilterContainer

private
XPath2FilterContainer(Element element, String baseURI)

Constructor XPath2FilterContainer

Method Summary

Modifier and TypeMethod and Description
public final String

Returns:

the XPATH2 tag
getBaseLocalName()

Implements abstract com.sun.org.apache.xml.internal.security.utils.ElementProxy.getBaseLocalName.

Method getBaseLocalName

public final String

Returns:

XPATH2 tag namespace
getBaseNamespace()

Implements abstract com.sun.org.apache.xml.internal.security.utils.ElementProxy.getBaseNamespace.

Method getBaseNamespace

public String

Returns:

the XPath 2 Filter String
getXPathFilterStr()

Returns the XPath 2 Filter String

public Node

Returns:

the first Text node which contains information from the XPath 2 Filter String
getXPathFilterTextNode()

Returns the first Text node which contains information from the XPath 2 Filter String.

public boolean

Returns:

true if the Filter attribute has value "intersect".
isIntersect()

Returns true if the Filter attribute has value "intersect".

public boolean

Returns:

true if the Filter attribute has value "subtract".
isSubtract()

Returns true if the Filter attribute has value "subtract".

public boolean

Returns:

true if the Filter attribute has value "union".
isUnion()

Returns true if the Filter attribute has value "union".

public static XPath2FilterContainer

Returns:

the filter
newInstance(Element element, String baseURI)

Creates a XPath2FilterContainer from an existing Element; needed for verification.

public static XPath2FilterContainer

Returns:

the filter.
newInstanceIntersect(Document doc, String xpath2filter)

Creates a new XPath2FilterContainer with the filter type "intersect".

public static NodeList

Returns:

the nodelist with the data
newInstances(Document doc, String[][] params)

Method newInstances

public static XPath2FilterContainer

Returns:

the filter.
newInstanceSubtract(Document doc, String xpath2filter)

Creates a new XPath2FilterContainer with the filter type "subtract".

public static XPath2FilterContainer

Returns:

the filter
newInstanceUnion(Document doc, String xpath2filter)

Creates a new XPath2FilterContainer with the filter type "union".

Inherited from com.sun.org.apache.xml.internal.security.utils.ElementProxy:
addBase64ElementaddBase64TextaddBigIntegerElementaddReturnToSelfaddTextaddTextElementappendOtherappendSelfappendSelfcreateElementForFamilycreateElementForFamilyLocalcreateTextgetBaseURIgetBigIntegerFromChildElementgetBytesFromTextChildgetDefaultPrefixgetDocumentgetElementgetElementPlusReturnsgetFirstChildgetLocalAttributegetTextFromChildElementgetTextFromTextChildlengthregisterDefaultPrefixessetDefaultPrefixsetDocumentsetElementsetElementsetLocalAttributesetLocalIdAttributesetXPathNamespaceContext

Field Detail

_ATT_FILTERback to summary
private static final String _ATT_FILTER

Field _ATT_FILTER

_ATT_FILTER_VALUE_INTERSECTback to summary
private static final String _ATT_FILTER_VALUE_INTERSECT

Field _ATT_FILTER_VALUE_INTERSECT

_ATT_FILTER_VALUE_SUBTRACTback to summary
private static final String _ATT_FILTER_VALUE_SUBTRACT

Field _ATT_FILTER_VALUE_SUBTRACT

_ATT_FILTER_VALUE_UNIONback to summary
private static final String _ATT_FILTER_VALUE_UNION

Field _ATT_FILTER_VALUE_UNION

_TAG_XPATH2back to summary
public static final String _TAG_XPATH2

Field _TAG_XPATH2

INTERSECTback to summary
public static final String INTERSECT

Field INTERSECT

SUBTRACTback to summary
public static final String SUBTRACT

Field SUBTRACT

UNIONback to summary
public static final String UNION

Field UNION

XPathFilter2NSback to summary
public static final String XPathFilter2NS

Field XPathFiler2NS

Constructor Detail

XPath2FilterContainerback to summary
private XPath2FilterContainer()

Constructor XPath2FilterContainer

XPath2FilterContainerback to summary
private XPath2FilterContainer(Document doc, String xpath2filter, String filterType)

Constructor XPath2FilterContainer

XPath2FilterContainerback to summary
private XPath2FilterContainer(Element element, String baseURI) throws XMLSecurityException

Constructor XPath2FilterContainer

Method Detail

getBaseLocalNameback to summary
public final String getBaseLocalName()

Implements abstract com.sun.org.apache.xml.internal.security.utils.ElementProxy.getBaseLocalName.

Method getBaseLocalName

Returns:String

the XPATH2 tag

getBaseNamespaceback to summary
public final String getBaseNamespace()

Implements abstract com.sun.org.apache.xml.internal.security.utils.ElementProxy.getBaseNamespace.

Method getBaseNamespace

Returns:String

XPATH2 tag namespace

getXPathFilterStrback to summary
public String getXPathFilterStr()

Returns the XPath 2 Filter String

Returns:String

the XPath 2 Filter String

getXPathFilterTextNodeback to summary
public Node getXPathFilterTextNode()

Returns the first Text node which contains information from the XPath 2 Filter String. We must use this stupid hook to enable the here() function to work.

Returns:Node

the first Text node which contains information from the XPath 2 Filter String

isIntersectback to summary
public boolean isIntersect()

Returns true if the Filter attribute has value "intersect".

Returns:boolean

true if the Filter attribute has value "intersect".

isSubtractback to summary
public boolean isSubtract()

Returns true if the Filter attribute has value "subtract".

Returns:boolean

true if the Filter attribute has value "subtract".

isUnionback to summary
public boolean isUnion()

Returns true if the Filter attribute has value "union".

Returns:boolean

true if the Filter attribute has value "union".

newInstanceback to summary
public static XPath2FilterContainer newInstance(Element element, String baseURI) throws XMLSecurityException

Creates a XPath2FilterContainer from an existing Element; needed for verification.

Returns:XPath2FilterContainer

the filter

newInstanceIntersectback to summary
public static XPath2FilterContainer newInstanceIntersect(Document doc, String xpath2filter)

Creates a new XPath2FilterContainer with the filter type "intersect".

Returns:XPath2FilterContainer

the filter.

newInstancesback to summary
public static NodeList newInstances(Document doc, String[][] params)

Method newInstances

Returns:NodeList

the nodelist with the data

newInstanceSubtractback to summary
public static XPath2FilterContainer newInstanceSubtract(Document doc, String xpath2filter)

Creates a new XPath2FilterContainer with the filter type "subtract".

Returns:XPath2FilterContainer

the filter.

newInstanceUnionback to summary
public static XPath2FilterContainer newInstanceUnion(Document doc, String xpath2filter)

Creates a new XPath2FilterContainer with the filter type "union".

Returns:XPath2FilterContainer

the filter