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

java.lang.Object
  |
  +--org.apache.commons.jelly.TagSupport
        |
        +--org.apache.commons.jelly.tags.xml.ParseTagSupport
All Implemented Interfaces:
org.apache.commons.jelly.Tag
Direct Known Subclasses:
ParseTag

public abstract class ParseTagSupport
extends org.apache.commons.jelly.TagSupport

An abstract base class for any tag which parsers its body as XML.

Version:
$Revision: 1.6 $
Author:
James Strachan

Fields inherited from class org.apache.commons.jelly.TagSupport
body, context, hasTrimmed, parent, shouldTrim
 
Constructor Summary
ParseTagSupport()
           
 
Method Summary
protected abstract  org.dom4j.io.SAXReader createSAXReader()
          Factory method to create a new SAXReader
 org.dom4j.io.SAXReader getSAXReader()
           
 java.lang.String getText()
          Returns the text to be parsed
 java.lang.String getVar()
          The variable name that will be used for the Document variable created
protected  org.dom4j.Document parse(java.lang.Object source)
          Parses the given source
protected  org.dom4j.Document parseBody(org.apache.commons.jelly.XMLOutput output)
          Parses the body of this tag and returns the parsed document
protected  org.dom4j.Document parseText(java.lang.String text)
          Parses the give piece of text as being markup
 void setSAXReader(org.dom4j.io.SAXReader saxReader)
          Sets the SAXReader used for parsing
 void setText(java.lang.String text)
          Sets the text to be parsed by this parser
 void setVar(java.lang.String var)
          Sets the variable name that will be used for the Document variable created
 
Methods inherited from class org.apache.commons.jelly.TagSupport
doTag, 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

ParseTagSupport

public ParseTagSupport()
Method Detail

getVar

public java.lang.String getVar()
The variable name that will be used for the Document variable created

setVar

public void setVar(java.lang.String var)
Sets the variable name that will be used for the Document variable created

getText

public java.lang.String getText()
Returns the text to be parsed
Returns:
String

setText

public void setText(java.lang.String text)
Sets the text to be parsed by this parser
Parameters:
text - The text to be parsed by this parser

getSAXReader

public org.dom4j.io.SAXReader getSAXReader()
                                    throws org.xml.sax.SAXException
Returns:
the SAXReader used for parsing, creating one lazily if need be

setSAXReader

public void setSAXReader(org.dom4j.io.SAXReader saxReader)
Sets the SAXReader used for parsing

createSAXReader

protected abstract org.dom4j.io.SAXReader createSAXReader()
                                                   throws org.xml.sax.SAXException
Factory method to create a new SAXReader

parseBody

protected org.dom4j.Document parseBody(org.apache.commons.jelly.XMLOutput output)
                                throws org.apache.commons.jelly.JellyTagException
Parses the body of this tag and returns the parsed document

parseText

protected org.dom4j.Document parseText(java.lang.String text)
                                throws org.apache.commons.jelly.JellyTagException
Parses the give piece of text as being markup

parse

protected org.dom4j.Document parse(java.lang.Object source)
                            throws org.apache.commons.jelly.JellyTagException
Parses the given source


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