Class XPathFilterCHGPContainer

java.lang.Object

org.apache.xml.security.utils.ElementProxy

org.apache.xml.security.transforms.params.XPathFilterCHGPContainer

All Implemented Interfaces:

TransformParam

public class XPathFilterCHGPContainer
extends ElementProxy
implements TransformParam

Implements the parameters for a custom Transform which has a better performance than the xfilter2.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	_ATT_INCLUDESLASH	Field _ATT_INCLUDESLASH
private static final String	_TAG_EXCLUDE	Field _ATT_FILTER_VALUE_UNION
private static final String	_TAG_EXCLUDE_BUT_SEARCH	Field _ATT_FILTER_VALUE_SUBTRACT
private static final String	_TAG_INCLUDE_BUT_SEARCH	Field _ATT_FILTER_VALUE_INTERSECT
static final String	_TAG_XPATHCHGP	Field _TAG_XPATHCHGP
static final boolean	ExcludeSlash	Field ExcludeSlash
static final boolean	IncludeSlash	Field IncludeSlash
static final String	TRANSFORM_XPATHFILTERCHGP

Fields inherited from class ElementProxy

baseURI, LOG

Constructor Summary

Constructors

Modifier	Constructor	Description
private	XPathFilterCHGPContainer()	Constructor XPathFilterCHGPContainer
private	XPathFilterCHGPContainer(Document doc, boolean includeSlashPolicy, String includeButSearch, String excludeButSearch, String exclude)	Constructor XPathFilterCHGPContainer
private	XPathFilterCHGPContainer(Element element, String baseURI)	Constructor XPathFilterCHGPContainer

Method Summary

Modifier and Type	Method	Description
final String	getBaseLocalName()	Method getBaseLocalName Returns the localname of the Elements of the sub-class.
final String	getBaseNamespace()	Method getBaseNamespace Returns the namespace of the Elements of the sub-class.
String	getExclude()	Method getExclude
String	getExcludeButSearch()	Method getExcludeButSearch
private Node	getHereContextNode(String type)	Returns the first Text node which contains information from the XPath Filter String.
Node	getHereContextNodeExclude()	Method getHereContextNodeExclude
Node	getHereContextNodeExcludeButSearch()	Method getHereContextNodeExcludeButSearch
Node	getHereContextNodeIncludeButSearch()	Method getHereContextNodeIncludeButSearch
String	getIncludeButSearch()	Method getIncludeButSearch
boolean	getIncludeSlashPolicy()	Method getIncludeSlashPolicy
static XPathFilterCHGPContainer	getInstance(Document doc, boolean includeSlashPolicy, String includeButSearch, String excludeButSearch, String exclude)	Creates a new XPathFilterCHGPContainer; needed for generation.
static XPathFilterCHGPContainer	getInstance(Element element, String baseURI)	Creates a XPathFilterCHGPContainer from an existing Element; needed for verification.
private String	getXStr(String type)	Method getXStr
(package private) static String	indentXPathText(String xp)	Method indentXPathText
private static Text	selectNodeText(Node sibling, String uri, String nodeName, int number)

Methods inherited from class 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 Object

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

Field Details

TRANSFORM_XPATHFILTERCHGP

public static final String TRANSFORM_XPATHFILTERCHGP

See Also:

• Constant Field Values

_TAG_INCLUDE_BUT_SEARCH

private static final String _TAG_INCLUDE_BUT_SEARCH

Field _ATT_FILTER_VALUE_INTERSECT

See Also:

• Constant Field Values

_TAG_EXCLUDE_BUT_SEARCH

private static final String _TAG_EXCLUDE_BUT_SEARCH

Field _ATT_FILTER_VALUE_SUBTRACT

See Also:

• Constant Field Values

_TAG_EXCLUDE

private static final String _TAG_EXCLUDE

Field _ATT_FILTER_VALUE_UNION

See Also:

• Constant Field Values

_TAG_XPATHCHGP

public static final String _TAG_XPATHCHGP

Field _TAG_XPATHCHGP

See Also:

• Constant Field Values

_ATT_INCLUDESLASH

public static final String _ATT_INCLUDESLASH

Field _ATT_INCLUDESLASH

See Also:

• Constant Field Values

IncludeSlash

public static final boolean IncludeSlash

Field IncludeSlash

See Also:

• Constant Field Values

ExcludeSlash

public static final boolean ExcludeSlash

Field ExcludeSlash

See Also:

• Constant Field Values

Constructor Details

XPathFilterCHGPContainer

private XPathFilterCHGPContainer()

Constructor XPathFilterCHGPContainer

XPathFilterCHGPContainer

private XPathFilterCHGPContainer(Document doc,
 boolean includeSlashPolicy,
 String includeButSearch,
 String excludeButSearch,
 String exclude)

Constructor XPathFilterCHGPContainer

Parameters:

doc -

includeSlashPolicy -

includeButSearch -

excludeButSearch -

exclude -

XPathFilterCHGPContainer

private XPathFilterCHGPContainer(Element element,
 String baseURI)
                          throws XMLSecurityException

Constructor XPathFilterCHGPContainer

Parameters:

element -

baseURI -

Throws:

XMLSecurityException

Method Details

indentXPathText

static String indentXPathText(String xp)

Method indentXPathText

Parameters:

xp -

Returns:

the string with enters

getInstance

public static XPathFilterCHGPContainer getInstance(Document doc,
 boolean includeSlashPolicy,
 String includeButSearch,
 String excludeButSearch,
 String exclude)

Creates a new XPathFilterCHGPContainer; needed for generation.

Parameters:

doc -

includeSlashPolicy -

includeButSearch -

excludeButSearch -

exclude -

Returns:

the created object

getInstance

public static XPathFilterCHGPContainer getInstance(Element element,
 String baseURI)
                                            throws XMLSecurityException

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

Parameters:

element -

baseURI -

Returns:

the created object.

Throws:

XMLSecurityException

getXStr

private String getXStr(String type)

Method getXStr

Parameters:

type -

Returns:

The Xstr

getIncludeButSearch

public String getIncludeButSearch()

Method getIncludeButSearch

Returns:

the string

getExcludeButSearch

public String getExcludeButSearch()

Method getExcludeButSearch

Returns:

the string

getExclude

public String getExclude()

Method getExclude

Returns:

the string

getIncludeSlashPolicy

public boolean getIncludeSlashPolicy()

Method getIncludeSlashPolicy

Returns:

the string

getHereContextNode

private Node getHereContextNode(String type)

Returns the first Text node which contains information from the XPath Filter String. We must use this stupid hook to enable the here() function to work. $todo$ I dunno whether this crashes: here()/ds:Signature[1]

Parameters:

type -

Returns:

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

selectNodeText

private static Text selectNodeText(Node sibling,
 String uri,
 String nodeName,
 int number)

getHereContextNodeIncludeButSearch

public Node getHereContextNodeIncludeButSearch()

Method getHereContextNodeIncludeButSearch

Returns:

the string

getHereContextNodeExcludeButSearch

public Node getHereContextNodeExcludeButSearch()

Method getHereContextNodeExcludeButSearch

Returns:

the string

getHereContextNodeExclude

public Node getHereContextNodeExclude()

Method getHereContextNodeExclude

Returns:

the string

getBaseLocalName

public final String getBaseLocalName()

Method getBaseLocalName Returns the localname of the Elements of the sub-class.

Specified by:

getBaseLocalName in class ElementProxy

Returns:

the localname of the Elements of the sub-class.

getBaseNamespace

public final String getBaseNamespace()

Method getBaseNamespace Returns the namespace of the Elements of the sub-class.

Specified by:

getBaseNamespace in class ElementProxy

Returns:

the namespace of the Elements of the sub-class.