org.apache.commons.jelly.tags.xml
Class SetTag

java.lang.Object
  |
  +--org.apache.commons.jelly.TagSupport
        |
        +--org.apache.commons.jelly.xpath.XPathTagSupport
              |
              +--org.apache.commons.jelly.tags.xml.SetTag
All Implemented Interfaces:
org.apache.commons.jelly.Tag

public class SetTag
extends org.apache.commons.jelly.xpath.XPathTagSupport

A tag which defines a variable from an XPath expression. This function creates a variable of type List or Node (for example Element or Attribute). Thus, the variable created from xml:set can be used from the other xml library functions.

Version:
$Revision: 1.11 $
Author:
James Strachan

Fields inherited from class org.apache.commons.jelly.TagSupport
body, context, hasTrimmed, parent, shouldTrim
 
Constructor Summary
SetTag()
           
 
Method Summary
 void doTag(org.apache.commons.jelly.XMLOutput output)
           
 void setDescending(boolean descending)
          Set whether to sort ascending or descending.
 void setSelect(org.jaxen.XPath select)
          Sets the XPath expression to evaluate.
 void setSingle(boolean single)
          If set to true will only take the first element matching.
 void setSort(org.jaxen.XPath sortXPath)
          Sets the xpath expression to use to sort selected nodes.
 void setVar(java.lang.String var)
          Sets the variable name to define for this expression
 
Methods inherited from class org.apache.commons.jelly.xpath.XPathTagSupport
getXPathContext
 
Methods inherited from class org.apache.commons.jelly.TagSupport
findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, getBody, getBodyText, getBodyText, getContext, getParent, invokeBody, isEscapeText, isTrim, setBody, setContext, setEscapeText, setParent, setTrim, trimBody
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SetTag

public SetTag()
Method Detail

doTag

public void doTag(org.apache.commons.jelly.XMLOutput output)
           throws org.apache.commons.jelly.MissingAttributeException,
                  org.apache.commons.jelly.JellyTagException
Overrides:
doTag in class org.apache.commons.jelly.TagSupport

setVar

public void setVar(java.lang.String var)
Sets the variable name to define for this expression

setSelect

public void setSelect(org.jaxen.XPath select)
Sets the XPath expression to evaluate.

setSingle

public void setSingle(boolean single)
If set to true will only take the first element matching. If set to false, guarantees that a list is returned. It then guarantees that the result is of type Node thereby making sure that, for example, when an element is selected, one can directly call such methods as setAttribute.

setSort

public void setSort(org.jaxen.XPath sortXPath)
             throws org.jaxen.JaxenException
Sets the xpath expression to use to sort selected nodes. Ignored if single is true.

setDescending

public void setDescending(boolean descending)
Set whether to sort ascending or descending.


Copyright © 2002-2004 Apache Software Foundation. All Rights Reserved.