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

java.lang.Object
  org.apache.commons.jelly.TagSupport
      org.apache.commons.jelly.tags.xml.ParseTagSupport
          org.apache.commons.jelly.tags.xml.ParseTag

All Implemented Interfaces:

org.apache.commons.jelly.Tag

Direct Known Subclasses:

TransformTag

public class ParseTag

extends ParseTagSupport

A tag which parses some XML and defines a variable with the parsed Document. The XML can either be specified as its body or can be passed in via the xml property which can be a Reader, InputStream, URL or String URI.

Version:

$Revision: 1.7 $

Author:

James Strachan

Field Summary

private static org.apache.commons.logging.Log	log The Log to which logging calls will be made.
private boolean	validate whether XML validation is enabled or disabled
private java.lang.Object	xml The xml to parse, either a String URI, a Reader or InputStream

Fields inherited from class org.apache.commons.jelly.tags.xml.ParseTagSupport

Fields inherited from class org.apache.commons.jelly.TagSupport

body, context, hasTrimmed, parent, shouldTrim

Constructor Summary

ParseTag()

Method Summary

protected org.dom4j.io.SAXReader	createSAXReader() Factory method to create a new SAXReader
void	doTag(org.apache.commons.jelly.XMLOutput output)
boolean	getValidate()
java.lang.Object	getXml() Gets the source of the XML which is either a String URI, Reader or InputStream
protected org.dom4j.Document	getXmlDocument(org.apache.commons.jelly.XMLOutput output)
void	setValidate(boolean validate) Sets whether XML validation is enabled or disabled
void	setXml(java.lang.Object xml) Sets the source of the XML which is either a String URI, a File, Reader or InputStream

Methods inherited from class org.apache.commons.jelly.tags.xml.ParseTagSupport

getSAXReader, getText, getVar, parse, parseBody, parseText, setSAXReader, setText, setVar

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

Field Detail

log

private static final org.apache.commons.logging.Log log

The Log to which logging calls will be made.

xml

private java.lang.Object xml

The xml to parse, either a String URI, a Reader or InputStream

validate

private boolean validate

whether XML validation is enabled or disabled

Constructor Detail

ParseTag

public ParseTag()

Method Detail

doTag

public void doTag(org.apache.commons.jelly.XMLOutput output)
           throws org.apache.commons.jelly.MissingAttributeException,
                  org.apache.commons.jelly.JellyTagException

Throws:

org.apache.commons.jelly.MissingAttributeException

org.apache.commons.jelly.JellyTagException

getXml

public java.lang.Object getXml()

Gets the source of the XML which is either a String URI, Reader or InputStream

setXml

public void setXml(java.lang.Object xml)

Sets the source of the XML which is either a String URI, a File, Reader or InputStream

getValidate

public boolean getValidate()

Returns:

whether XML validation is enabled or disabled

setValidate

public void setValidate(boolean validate)

Sets whether XML validation is enabled or disabled

createSAXReader

protected org.dom4j.io.SAXReader createSAXReader()

Factory method to create a new SAXReader

Specified by:

createSAXReader in class ParseTagSupport

getXmlDocument

protected org.dom4j.Document getXmlDocument(org.apache.commons.jelly.XMLOutput output)
                                     throws org.apache.commons.jelly.JellyTagException

Throws:

org.apache.commons.jelly.JellyTagException