Package org.apache.xml.security.transforms.params

Class XPath2FilterContainer

java.lang.Object

org.apache.xml.security.utils.ElementProxy

org.apache.xml.security.transforms.params.XPath2FilterContainer

All Implemented Interfaces:

TransformParam

public class XPath2FilterContainer
extends ElementProxy
implements TransformParam

Implements the parameters for the XPath Filter v2.0.

See Also:

XPath Filter v2.0 (TR)

Field Summary

Fields

Modifier and Type	Field	Description
private static java.lang.String	_ATT_FILTER	Field _ATT_FILTER
private static java.lang.String	_ATT_FILTER_VALUE_INTERSECT	Field _ATT_FILTER_VALUE_INTERSECT
private static java.lang.String	_ATT_FILTER_VALUE_SUBTRACT	Field _ATT_FILTER_VALUE_SUBTRACT
private static java.lang.String	_ATT_FILTER_VALUE_UNION	Field _ATT_FILTER_VALUE_UNION
static java.lang.String	_TAG_XPATH2	Field _TAG_XPATH2
static java.lang.String	INTERSECT	Field INTERSECT
static java.lang.String	SUBTRACT	Field SUBTRACT
static java.lang.String	UNION	Field UNION
static java.lang.String	XPathFilter2NS	Field XPathFiler2NS

Fields inherited from class org.apache.xml.security.utils.ElementProxy

baseURI, LOG

Constructor Summary

Constructors

Modifier	Constructor	Description
private	XPath2FilterContainer()	Constructor XPath2FilterContainer
private	XPath2FilterContainer(org.w3c.dom.Document doc, java.lang.String xpath2filter, java.lang.String filterType)	Constructor XPath2FilterContainer
private	XPath2FilterContainer(org.w3c.dom.Element element, java.lang.String baseURI)	Constructor XPath2FilterContainer

Method Summary

Modifier and Type	Method	Description
java.lang.String	getBaseLocalName()	Method getBaseLocalName
java.lang.String	getBaseNamespace()	Method getBaseNamespace
java.lang.String	getXPathFilterStr()	Returns the XPath 2 Filter String
org.w3c.dom.Node	getXPathFilterTextNode()	Returns the first Text node which contains information from the XPath 2 Filter String.
boolean	isIntersect()	Returns true if the Filter attribute has value "intersect".
boolean	isSubtract()	Returns true if the Filter attribute has value "subtract".
boolean	isUnion()	Returns true if the Filter attribute has value "union".
static XPath2FilterContainer	newInstance(org.w3c.dom.Element element, java.lang.String baseURI)	Creates a XPath2FilterContainer from an existing Element; needed for verification.
static XPath2FilterContainer	newInstanceIntersect(org.w3c.dom.Document doc, java.lang.String xpath2filter)	Creates a new XPath2FilterContainer with the filter type "intersect".
static org.w3c.dom.NodeList	newInstances(org.w3c.dom.Document doc, java.lang.String[][] params)	Method newInstances
static XPath2FilterContainer	newInstanceSubtract(org.w3c.dom.Document doc, java.lang.String xpath2filter)	Creates a new XPath2FilterContainer with the filter type "subtract".
static XPath2FilterContainer	newInstanceUnion(org.w3c.dom.Document doc, java.lang.String xpath2filter)	Creates a new XPath2FilterContainer with the filter type "union".

Methods inherited from class org.apache.xml.security.utils.ElementProxy

addBase64Element, addBase64Text, addBigIntegerElement, addReturnToSelf, addText, addTextElement, appendOther, appendSelf, appendSelf, createElementForFamily, createElementForFamilyLocal, createText, getBaseURI, getBigIntegerFromChildElement, getBytesFromTextChild, getDefaultPrefix, getDocument, getElement, getElementPlusReturns, getFirstChild, getLocalAttribute, getTextFromChildElement, getTextFromTextChild, length, registerDefaultPrefixes, setDefaultPrefix, setDocument, setElement, setElement, setLocalAttribute, setLocalIdAttribute, setXPathNamespaceContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_ATT_FILTER

private static final java.lang.String _ATT_FILTER

Field _ATT_FILTER

See Also:

Constant Field Values

_ATT_FILTER_VALUE_INTERSECT

private static final java.lang.String _ATT_FILTER_VALUE_INTERSECT

Field _ATT_FILTER_VALUE_INTERSECT

See Also:

Constant Field Values

_ATT_FILTER_VALUE_SUBTRACT

private static final java.lang.String _ATT_FILTER_VALUE_SUBTRACT

Field _ATT_FILTER_VALUE_SUBTRACT

See Also:

Constant Field Values

_ATT_FILTER_VALUE_UNION

private static final java.lang.String _ATT_FILTER_VALUE_UNION

Field _ATT_FILTER_VALUE_UNION

See Also:

Constant Field Values

INTERSECT

public static final java.lang.String INTERSECT

Field INTERSECT

See Also:

Constant Field Values

SUBTRACT

public static final java.lang.String SUBTRACT

Field SUBTRACT

See Also:

Constant Field Values

UNION

public static final java.lang.String UNION

Field UNION

See Also:

Constant Field Values

_TAG_XPATH2

public static final java.lang.String _TAG_XPATH2

Field _TAG_XPATH2

See Also:

Constant Field Values

XPathFilter2NS

public static final java.lang.String XPathFilter2NS

Field XPathFiler2NS

See Also:

Constant Field Values

Constructor Detail

XPath2FilterContainer

private XPath2FilterContainer()

Constructor XPath2FilterContainer

XPath2FilterContainer

private XPath2FilterContainer(org.w3c.dom.Document doc,
                              java.lang.String xpath2filter,
                              java.lang.String filterType)

Constructor XPath2FilterContainer

Parameters:

doc -

xpath2filter -

filterType -

XPath2FilterContainer

private XPath2FilterContainer(org.w3c.dom.Element element,
                              java.lang.String baseURI)
                       throws XMLSecurityException

Constructor XPath2FilterContainer

Parameters:

element -

baseURI -

Throws:

XMLSecurityException

Method Detail

newInstanceIntersect

public static XPath2FilterContainer newInstanceIntersect(org.w3c.dom.Document doc,
                                                         java.lang.String xpath2filter)

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

Parameters:

doc -

xpath2filter -

Returns:

the filter.

newInstanceSubtract

public static XPath2FilterContainer newInstanceSubtract(org.w3c.dom.Document doc,
                                                        java.lang.String xpath2filter)

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

Parameters:

doc -

xpath2filter -

Returns:

the filter.

newInstanceUnion

public static XPath2FilterContainer newInstanceUnion(org.w3c.dom.Document doc,
                                                     java.lang.String xpath2filter)

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

Parameters:

doc -

xpath2filter -

Returns:

the filter

newInstances

public static org.w3c.dom.NodeList newInstances(org.w3c.dom.Document doc,
                                                java.lang.String[][] params)

Method newInstances

Parameters:

doc -

params -

Returns:

the nodelist with the data

newInstance

public static XPath2FilterContainer newInstance(org.w3c.dom.Element element,
                                                java.lang.String baseURI)
                                         throws XMLSecurityException

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

Parameters:

element -

baseURI -

Returns:

the filter

Throws:

XMLSecurityException

isIntersect

public boolean isIntersect()

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

Returns:

true if the Filter attribute has value "intersect".

isSubtract

public boolean isSubtract()

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

Returns:

true if the Filter attribute has value "subtract".

isUnion

public boolean isUnion()

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

Returns:

true if the Filter attribute has value "union".

getXPathFilterStr

public java.lang.String getXPathFilterStr()

Returns the XPath 2 Filter String

Returns:

the XPath 2 Filter String

getXPathFilterTextNode

public org.w3c.dom.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:

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

getBaseLocalName

public final java.lang.String getBaseLocalName()

Method getBaseLocalName

Specified by:

getBaseLocalName in class ElementProxy

Returns:

the XPATH2 tag

getBaseNamespace

public final java.lang.String getBaseNamespace()

Method getBaseNamespace

Specified by:

getBaseNamespace in class ElementProxy

Returns:

XPATH2 tag namespace