|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jet.AbstractContextExtender
org.eclipse.jet.XPathContextExtender
Context Extender that understands XPath processing.
Constructor Summary | |
---|---|
XPathContextExtender(JET2Context context)
Deprecated. Use XPathContextExtender.getInstance(JET2Context) . This method will be made private in the near future. |
Method Summary | |
---|---|
void |
addCustomFunctions(XPathFunctionMetaData[] functionData)
Add the passed list of XPath function definitions to the XPath processor. |
java.lang.Object |
addElement(java.lang.Object parent,
java.lang.String name)
|
java.lang.Object |
addTextElement(java.lang.Object parentElement,
java.lang.String name,
java.lang.String bodyContent)
Create a new text (simple) element whose content is set to bodyContent . |
java.lang.Object |
addTextElement(java.lang.Object parentElement,
java.lang.String name,
java.lang.String bodyContent,
boolean asCData)
Create a new text (simple) element whose content is set to bodyContent . |
java.lang.Object |
copyElement(java.lang.Object srcElement,
java.lang.Object tgtParent,
java.lang.String name,
boolean recursive)
Copy srcElement as a new element with the specified name under tgtParent .
|
protected java.lang.Object |
createExtendedData(JET2Context context)
Called by the AbstractContextExtender constructor if the extender's data has not yet been created in the context. |
java.lang.Object |
currentXPathContextObject()
|
java.lang.Object |
getAttributeValue(java.lang.Object element,
java.lang.String attributeName)
Return the value of the named attribute on the passed element. |
java.lang.String |
getContent(java.lang.Object object)
Return the string value of the passed object. |
static XPathContextExtender |
getInstance(JET2Context context)
Factory method for XPathContextExtenders |
void |
removeAttribute(java.lang.Object element,
java.lang.String attributeName)
Remove the named attribute from the specified element. |
void |
removeElement(java.lang.Object element)
|
java.lang.Object[] |
resolve(java.lang.Object xpathContextObject,
java.lang.String selectXPath)
|
java.lang.Object |
resolveAsObject(java.lang.Object contextObject,
java.lang.String selectXPath)
Resolve the XPath expression, returning an object. |
java.lang.String |
resolveAsString(java.lang.Object xpathContextObject,
java.lang.String selectXPath)
Resolve the given XPath expression as a string value. |
java.lang.String |
resolveDynamic(java.lang.String value)
Resolve dynamic XPath expressions {...} within the pass value |
java.lang.Object |
resolveSingle(java.lang.Object xpathContextObject,
java.lang.String selectXPath)
|
boolean |
resolveTest(java.lang.Object xpathContext,
java.lang.String testXPath)
Resolve an xpath expression as a boolean result according to the XPath rules. |
java.lang.Object |
resolveVariable(java.lang.String name)
|
boolean |
setAttribute(java.lang.Object element,
java.lang.String name,
java.lang.String bodyContent)
|
Methods inherited from class org.eclipse.jet.AbstractContextExtender |
---|
getContext, getExtendedData |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public XPathContextExtender(JET2Context context)
XPathContextExtender.getInstance(JET2Context)
. This method will be made private in the near future.
context
- Method Detail |
public static XPathContextExtender getInstance(JET2Context context)
context
- the JET2Context that is extended
protected java.lang.Object createExtendedData(JET2Context context)
AbstractContextExtender
createExtendedData
in class AbstractContextExtender
context
- the context in which the data will be created.
public java.lang.Object resolveVariable(java.lang.String name)
resolveVariable
in interface XPathVariableResolver
public java.lang.String resolveAsString(java.lang.Object xpathContextObject, java.lang.String selectXPath) throws JET2TagException
null
xpathContextObject
- the xpath contextselectXPath
- the XPath expression
null
if the expression resulted in an empty node set.
JET2TagException
- if an error occurs during expression evaluationpublic java.lang.Object resolveSingle(java.lang.Object xpathContextObject, java.lang.String selectXPath) throws JET2TagException
JET2TagException
public java.lang.Object currentXPathContextObject()
public java.lang.Object[] resolve(java.lang.Object xpathContextObject, java.lang.String selectXPath) throws JET2TagException
JET2TagException
public boolean resolveTest(java.lang.Object xpathContext, java.lang.String testXPath) throws JET2TagException
TODO Add link to XPath 1.0 spec for clarification
xpathContext
- the XPath context objecttestXPath
- the XPath expression
true
or false
JET2TagException
- if an error occurs in evaluating the expression.public boolean setAttribute(java.lang.Object element, java.lang.String name, java.lang.String bodyContent) throws JET2TagException
JET2TagException
public java.lang.String resolveDynamic(java.lang.String value) throws JET2TagException
value
- a string containing zero or more dynamic xpath expressions
JET2TagException
- if an Xpath evaluation error occurspublic java.lang.Object addElement(java.lang.Object parent, java.lang.String name) throws JET2TagException
JET2TagException
public void removeElement(java.lang.Object element) throws JET2TagException
JET2TagException
public java.lang.Object copyElement(java.lang.Object srcElement, java.lang.Object tgtParent, java.lang.String name, boolean recursive) throws JET2TagException
srcElement
as a new element with the specified name under tgtParent
.
If recursive
is true
, then all the contained children of srcElement
are copied, otherwise, only the element and its attributes are copied.
srcElement
- the element to copytgtParent
- the parent element that will contain the copyname
- the name of the copied elementrecursive
- true
if contained chidren are to be copied, too.
JET2TagException
- an error occurspublic java.lang.Object addTextElement(java.lang.Object parentElement, java.lang.String name, java.lang.String bodyContent) throws JET2TagException
bodyContent
.
parentElement
- the parent of the new element.name
- the name of the new element.bodyContent
- the content.
JET2TagException
- if the element cannot be added.public java.lang.Object addTextElement(java.lang.Object parentElement, java.lang.String name, java.lang.String bodyContent, boolean asCData) throws JET2TagException
bodyContent
.
parentElement
- the parent of the new element.name
- the name of the new element.bodyContent
- the content.asCData
- if true
, create the element as a CDATA section, of possible
JET2TagException
- if the element cannot be added.public java.lang.Object resolveAsObject(java.lang.Object contextObject, java.lang.String selectXPath) throws JET2TagException
contextObject
- the context object to which the XPath expression is relative.selectXPath
- the XPath expression
JET2TagException
- if an error occurs.public java.lang.Object getAttributeValue(java.lang.Object element, java.lang.String attributeName) throws JET2TagException
element
- the element containing the attributeattributeName
- the attribute name
JET2TagException
public void removeAttribute(java.lang.Object element, java.lang.String attributeName) throws JET2TagException
element
- the element containing the attributeattributeName
- the attribute to remove
JET2TagException
- if the attribute cannot be removed (because it is required),
or if element
is not a recognized element.public java.lang.String getContent(java.lang.Object object) throws JET2TagException
object
- the object to examine.
JET2TagException
- if an error occurs.public void addCustomFunctions(XPathFunctionMetaData[] functionData)
functionData
- possible empty array of XPathFunctionMetaData
instances.
|
Copyright 2006 IBM Corporation and others. All Rights Reserved. |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |