|
|||||||||
| Home >> All >> org >> apache >> commons >> [ jelly overview ] | PREV CLASS NEXT CLASS | ||||||||
SUMMARY: JAVADOC | SOURCE | DOWNLOAD | NESTED | FIELD | CONSTR | METHOD |
DETAIL: FIELD | CONSTR | METHOD | ||||||||
org.apache.commons.jelly
Class XMLOutput

java.lang.Objectorg.apache.commons.jelly.XMLOutput
- All Implemented Interfaces:
- org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler
- public class XMLOutput
- extends java.lang.Object
- implements org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler
- extends java.lang.Object
XMLOutput is used to output XML events
in a SAX-like manner. This also allows pipelining to be done
such as in the Cocoon project.
- Version:
- $Revision: 155420 $
| Field Summary | |
private org.xml.sax.ContentHandler |
contentHandler
The SAX ContentHandler that output goes to |
private static boolean |
DEFAULT_ESCAPE_TEXT
the default for escaping of text |
private static org.xml.sax.Attributes |
EMPTY_ATTRIBUTES
empty attributes |
protected static java.lang.String[] |
LEXICAL_HANDLER_NAMES
|
private org.xml.sax.ext.LexicalHandler |
lexicalHandler
The SAX LexicalHandler that output goes to |
private static org.apache.commons.logging.Log |
log
The Log to which logging calls will be made. |
| Constructor Summary | |
XMLOutput()
|
|
XMLOutput(org.xml.sax.ContentHandler contentHandler)
|
|
XMLOutput(org.xml.sax.ContentHandler contentHandler,
org.xml.sax.ext.LexicalHandler lexicalHandler)
|
|
| Method Summary | |
void |
characters(char[] ch,
int start,
int length)
Receive notification of character data. |
void |
close()
Provides a useful hook that implementations can use to close the underlying OutputStream or Writer |
void |
comment(char[] ch,
int start,
int length)
Report an XML comment anywhere in the document. |
static XMLOutput |
createDummyXMLOutput()
returns an XMLOutput object that will discard all tag-generated XML events. |
static XMLOutput |
createXMLOutput(java.io.OutputStream out)
Creates a text based XMLOutput which converts all XML events into text and writes to the underlying OutputStream. |
static XMLOutput |
createXMLOutput(java.io.OutputStream out,
boolean escapeText)
Creates a text based XMLOutput which converts all XML events into text and writes to the underlying OutputStream. |
static XMLOutput |
createXMLOutput(java.io.Writer writer)
Creates a text based XMLOutput which converts all XML events into text and writes to the underlying Writer. |
static XMLOutput |
createXMLOutput(java.io.Writer writer,
boolean escapeText)
Creates a text based XMLOutput which converts all XML events into text and writes to the underlying Writer. |
static XMLOutput |
createXMLOutput(org.xml.sax.XMLReader xmlReader)
Creates an XMLOutput from an existing SAX XMLReader |
protected static XMLOutput |
createXMLOutput(org.dom4j.io.XMLWriter xmlWriter)
Factory method to create a new XMLOutput from an XMLWriter |
void |
endCDATA()
Report the end of a CDATA section. |
void |
endDocument()
Receive notification of the end of a document. |
void |
endDTD()
Report the end of DTD declarations. |
void |
endElement(java.lang.String localName)
Helper method for outputting an end element event for an element in no namespace |
void |
endElement(java.lang.String uri,
java.lang.String localName,
java.lang.String qName)
Receive notification of the end of an element. |
void |
endEntity(java.lang.String name)
Report the end of an entity. |
void |
endPrefixMapping(java.lang.String prefix)
End the scope of a prefix-URI mapping. |
void |
flush()
|
org.xml.sax.ContentHandler |
getContentHandler()
|
org.xml.sax.ext.LexicalHandler |
getLexicalHandler()
|
void |
ignorableWhitespace(char[] ch,
int start,
int length)
Receive notification of ignorable whitespace in element content. |
void |
objectData(java.lang.Object object)
Pass data through the pipline. |
void |
processingInstruction(java.lang.String target,
java.lang.String data)
Receive notification of a processing instruction. |
void |
setContentHandler(org.xml.sax.ContentHandler contentHandler)
Sets the SAX ContentHandler to pipe SAX events into |
void |
setDocumentLocator(org.xml.sax.Locator locator)
Receive an object for locating the origin of SAX document events. |
void |
setLexicalHandler(org.xml.sax.ext.LexicalHandler lexicalHandler)
Sets the SAX LexicalHandler to pipe SAX events into |
void |
skippedEntity(java.lang.String name)
Receive notification of a skipped entity. |
void |
startCDATA()
Report the start of a CDATA section. |
void |
startDocument()
Receive notification of the beginning of a document. |
void |
startDTD(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
Report the start of DTD declarations, if any. |
void |
startElement(java.lang.String localName)
Helper method for outputting a start element event for an element in no namespace |
void |
startElement(java.lang.String localName,
org.xml.sax.Attributes attributes)
Helper method for outputting a start element event for an element in no namespace |
void |
startElement(java.lang.String uri,
java.lang.String localName,
java.lang.String qName,
org.xml.sax.Attributes atts)
Receive notification of the beginning of an element. |
void |
startEntity(java.lang.String name)
Report the beginning of some internal and external XML entities. |
void |
startPrefixMapping(java.lang.String prefix,
java.lang.String uri)
Begin the scope of a prefix-URI Namespace mapping. |
java.lang.String |
toString()
Convert this Object to a human-readable String. |
void |
write(java.lang.String text)
Outputs the given String as a piece of valid text in the XML event stream. |
void |
writeCDATA(java.lang.String text)
Outputs the given String as a piece of CDATA in the XML event stream. |
void |
writeComment(java.lang.String text)
Outputs a comment to the XML stream |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
LEXICAL_HANDLER_NAMES
protected static final java.lang.String[] LEXICAL_HANDLER_NAMES
EMPTY_ATTRIBUTES
private static final org.xml.sax.Attributes EMPTY_ATTRIBUTES
- empty attributes
log
private static final org.apache.commons.logging.Log log
- The Log to which logging calls will be made.
DEFAULT_ESCAPE_TEXT
private static final boolean DEFAULT_ESCAPE_TEXT
- the default for escaping of text
- See Also:
- Constant Field Values
contentHandler
private org.xml.sax.ContentHandler contentHandler
- The SAX ContentHandler that output goes to
lexicalHandler
private org.xml.sax.ext.LexicalHandler lexicalHandler
- The SAX LexicalHandler that output goes to
| Constructor Detail |
XMLOutput
public XMLOutput()
XMLOutput
public XMLOutput(org.xml.sax.ContentHandler contentHandler)
XMLOutput
public XMLOutput(org.xml.sax.ContentHandler contentHandler, org.xml.sax.ext.LexicalHandler lexicalHandler)
| Method Detail |
toString
public java.lang.String toString()
- Description copied from class:
java.lang.Object - Convert this Object to a human-readable String.
There are no limits placed on how long this String
should be or what it should contain. We suggest you
make it as intuitive as possible to be able to place
it into System.out.println() 55
and such.
It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.
This method will be called when performing string concatenation with this object. If the result is
null, string concatenation will instead use"null".The default implementation returns
getClass().getName() + "@" + Integer.toHexString(hashCode()).
close
public void close()
throws java.io.IOException
- Provides a useful hook that implementations can use to close the
underlying OutputStream or Writer
flush
public void flush()
throws java.io.IOException
createXMLOutput
public static XMLOutput createXMLOutput(org.xml.sax.XMLReader xmlReader)
- Creates an XMLOutput from an existing SAX XMLReader
createXMLOutput
public static XMLOutput createXMLOutput(java.io.Writer writer)
- Creates a text based XMLOutput which converts all XML events into
text and writes to the underlying Writer.
createXMLOutput
public static XMLOutput createXMLOutput(java.io.Writer writer, boolean escapeText)
- Creates a text based XMLOutput which converts all XML events into
text and writes to the underlying Writer.
createXMLOutput
public static XMLOutput createXMLOutput(java.io.OutputStream out) throws java.io.UnsupportedEncodingException
- Creates a text based XMLOutput which converts all XML events into
text and writes to the underlying OutputStream.
createXMLOutput
public static XMLOutput createXMLOutput(java.io.OutputStream out, boolean escapeText) throws java.io.UnsupportedEncodingException
- Creates a text based XMLOutput which converts all XML events into
text and writes to the underlying OutputStream.
createDummyXMLOutput
public static XMLOutput createDummyXMLOutput()
- returns an XMLOutput object that will discard all
tag-generated XML events. Useful when tag output is not expected
or not significant.
write
public void write(java.lang.String text) throws org.xml.sax.SAXException
- Outputs the given String as a piece of valid text in the
XML event stream.
Any special XML characters should be properly escaped.
writeCDATA
public void writeCDATA(java.lang.String text) throws org.xml.sax.SAXException
- Outputs the given String as a piece of CDATA in the
XML event stream.
writeComment
public void writeComment(java.lang.String text) throws org.xml.sax.SAXException
- Outputs a comment to the XML stream
startElement
public void startElement(java.lang.String localName) throws org.xml.sax.SAXException
- Helper method for outputting a start element event for an element in no namespace
startElement
public void startElement(java.lang.String localName, org.xml.sax.Attributes attributes) throws org.xml.sax.SAXException
- Helper method for outputting a start element event for an element in no namespace
endElement
public void endElement(java.lang.String localName) throws org.xml.sax.SAXException
- Helper method for outputting an end element event for an element in no namespace
setDocumentLocator
public void setDocumentLocator(org.xml.sax.Locator locator)
- Receive an object for locating the origin of SAX document events.
SAX parsers are strongly encouraged (though not absolutely required) to supply a locator: if it does so, it must supply the locator to the application by invoking this method before invoking any of the other methods in the ContentHandler interface.
The locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error. Typically, the application will use this information for reporting its own errors (such as character content that does not match an application's business rules). The information returned by the locator is probably not sufficient for use with a search engine.
Note that the locator will return correct information only during the invocation of the events in this interface. The application should not attempt to use it at any other time.
- Specified by:
setDocumentLocatorin interfaceorg.xml.sax.ContentHandler
startDocument
public void startDocument()
throws org.xml.sax.SAXException
- Receive notification of the beginning of a document.
The SAX parser will invoke this method only once, before any other event callbacks (except for setDocumentLocator 55 ).
- Specified by:
startDocumentin interfaceorg.xml.sax.ContentHandler
endDocument
public void endDocument()
throws org.xml.sax.SAXException
- Receive notification of the end of a document.
The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.
- Specified by:
endDocumentin interfaceorg.xml.sax.ContentHandler
startPrefixMapping
public void startPrefixMapping(java.lang.String prefix, java.lang.String uri) throws org.xml.sax.SAXException
- Begin the scope of a prefix-URI Namespace mapping.
The information from this event is not necessary for normal Namespace processing: the SAX XML reader will automatically replace prefixes for element and attribute names when the
http://xml.org/sax/features/namespacesfeature is true (the default).There are cases, however, when applications need to use prefixes in character data or in attribute values, where they cannot safely be expanded automatically; the start/endPrefixMapping event supplies the information to the application to expand prefixes in those contexts itself, if necessary.
Note that start/endPrefixMapping events are not guaranteed to be properly nested relative to each other: all startPrefixMapping events will occur immediately before the corresponding startElement 55 event, and all endPrefixMapping 55 events will occur immediately after the corresponding endElement 55 event, but their order is not otherwise guaranteed.
There should never be start/endPrefixMapping events for the "xml" prefix, since it is predeclared and immutable.
- Specified by:
startPrefixMappingin interfaceorg.xml.sax.ContentHandler
endPrefixMapping
public void endPrefixMapping(java.lang.String prefix) throws org.xml.sax.SAXException
- End the scope of a prefix-URI mapping.
See startPrefixMapping 55 for details. These events will always occur immediately after the corresponding endElement 55 event, but the order of endPrefixMapping 55 events is not otherwise guaranteed.
- Specified by:
endPrefixMappingin interfaceorg.xml.sax.ContentHandler
startElement
public void startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts) throws org.xml.sax.SAXException
- Receive notification of the beginning of an element.
The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding endElement 55 event for every startElement event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding endElement event.
This event allows up to three name components for each element:
- the Namespace URI;
- the local name; and
- the qualified (prefixed) name.
Any or all of these may be provided, depending on the values of the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes properties:
- the Namespace URI and local name are required when the namespaces property is true (the default), and are optional when the namespaces property is false (if one is specified, both must be);
- the qualified name is required when the namespace-prefixes property is true, and is optional when the namespace-prefixes property is false (the default).
Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted. The attribute list will contain attributes used for Namespace declarations (xmlns* attributes) only if the
http://xml.org/sax/features/namespace-prefixesproperty is true (it is false by default, and support for a true value is optional).Like characters() 55 , attribute values may have characters that need more than one
charvalue.- Specified by:
startElementin interfaceorg.xml.sax.ContentHandler
endElement
public void endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName) throws org.xml.sax.SAXException
- Receive notification of the end of an element.
The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding startElement 55 event for every endElement event (even when the element is empty).
For information on the names, see startElement.
- Specified by:
endElementin interfaceorg.xml.sax.ContentHandler
characters
public void characters(char[] ch,
int start,
int length)
throws org.xml.sax.SAXException
- Receive notification of character data.
The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity so that the Locator provides useful information.
The application must not attempt to read from the array outside of the specified range.
Individual characters may consist of more than one Java
charvalue. There are two important cases where this happens, because characters can't be represented in just sixteen bits. In one case, characters are represented in a Surrogate Pair, using two special Unicode values. Such characters are in the so-called "Astral Planes", with a code point above U+FFFF. A second case involves composite characters, such as a base character combining with one or more accent characters.Your code should not assume that algorithms using
char-at-a-time idioms will be working in character units; in some cases they will split characters. This is relevant wherever XML permits arbitrary characters, such as attribute values, processing instruction data, and comments as well as in data reported from this method. It's also generally relevant whenever Java code manipulates internationalized text; the issue isn't unique to XML.Note that some parsers will report whitespace in element content using the ignorableWhitespace 55 method rather than this one (validating parsers must do so).
- Specified by:
charactersin interfaceorg.xml.sax.ContentHandler
ignorableWhitespace
public void ignorableWhitespace(char[] ch,
int start,
int length)
throws org.xml.sax.SAXException
- Receive notification of ignorable whitespace in element content.
Validating Parsers must use this method to report each chunk of whitespace in element content (see the W3C XML 1.0 recommendation, section 2.10): non-validating parsers may also use this method if they are capable of parsing and using content models.
SAX parsers may return all contiguous whitespace in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.
The application must not attempt to read from the array outside of the specified range.
- Specified by:
ignorableWhitespacein interfaceorg.xml.sax.ContentHandler
processingInstruction
public void processingInstruction(java.lang.String target, java.lang.String data) throws org.xml.sax.SAXException
- Receive notification of a processing instruction.
The Parser will invoke this method once for each processing instruction found: note that processing instructions may occur before or after the main document element.
A SAX parser must never report an XML declaration (XML 1.0, section 2.8) or a text declaration (XML 1.0, section 4.3.1) using this method.
Like characters() 55 , processing instruction data may have characters that need more than one
charvalue.- Specified by:
processingInstructionin interfaceorg.xml.sax.ContentHandler
skippedEntity
public void skippedEntity(java.lang.String name) throws org.xml.sax.SAXException
- Receive notification of a skipped entity.
This is not called for entity references within markup constructs
such as element start tags or markup declarations. (The XML
recommendation requires reporting skipped external entities.
SAX also reports internal entity expansion/non-expansion, except
within markup constructs.)
The Parser will invoke this method each time the entity is skipped. Non-validating processors may skip entities if they have not seen the declarations (because, for example, the entity was declared in an external DTD subset). All processors may skip external entities, depending on the values of the
http://xml.org/sax/features/external-general-entitiesand thehttp://xml.org/sax/features/external-parameter-entitiesproperties.- Specified by:
skippedEntityin interfaceorg.xml.sax.ContentHandler
startDTD
public void startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId) throws org.xml.sax.SAXException
- Report the start of DTD declarations, if any.
This method is intended to report the beginning of the DOCTYPE declaration; if the document has no DOCTYPE declaration, this method will not be invoked.
All declarations reported through DTDHandler or DeclHandler events must appear between the startDTD and endDTD 55 events. Declarations are assumed to belong to the internal DTD subset unless they appear between startEntity 55 and endEntity 55 events. Comments and processing instructions from the DTD should also be reported between the startDTD and endDTD events, in their original order of (logical) occurrence; they are not required to appear in their correct locations relative to DTDHandler or DeclHandler events, however.
Note that the start/endDTD events will appear within the start/endDocument events from ContentHandler and before the first startElement 55 event.
- Specified by:
startDTDin interfaceorg.xml.sax.ext.LexicalHandler
endDTD
public void endDTD()
throws org.xml.sax.SAXException
- Report the end of DTD declarations.
This method is intended to report the end of the DOCTYPE declaration; if the document has no DOCTYPE declaration, this method will not be invoked.
- Specified by:
endDTDin interfaceorg.xml.sax.ext.LexicalHandler
startEntity
public void startEntity(java.lang.String name) throws org.xml.sax.SAXException
- Report the beginning of some internal and external XML entities.
The reporting of parameter entities (including the external DTD subset) is optional, and SAX2 drivers that report LexicalHandler events may not implement it; you can use the
http://xml.org/sax/features/lexical-handler/parameter-entitiesfeature to query or control the reporting of parameter entities.General entities are reported with their regular names, parameter entities have '%' prepended to their names, and the external DTD subset has the pseudo-entity name "[dtd]".
When a SAX2 driver is providing these events, all other events must be properly nested within start/end entity events. There is no additional requirement that events from DeclHandler or DTDHandler be properly ordered.
Note that skipped entities will be reported through the skippedEntity 55 event, which is part of the ContentHandler interface.
Because of the streaming event model that SAX uses, some entity boundaries cannot be reported under any circumstances:
- general entities within attribute values
- parameter entities within declarations
These will be silently expanded, with no indication of where the original entity boundaries were.
Note also that the boundaries of character references (which are not really entities anyway) are not reported.
All start/endEntity events must be properly nested.
- Specified by:
startEntityin interfaceorg.xml.sax.ext.LexicalHandler
endEntity
public void endEntity(java.lang.String name) throws org.xml.sax.SAXException
- Report the end of an entity.
- Specified by:
endEntityin interfaceorg.xml.sax.ext.LexicalHandler
startCDATA
public void startCDATA()
throws org.xml.sax.SAXException
- Report the start of a CDATA section.
The contents of the CDATA section will be reported through the regular characters 55 event; this event is intended only to report the boundary.
- Specified by:
startCDATAin interfaceorg.xml.sax.ext.LexicalHandler
endCDATA
public void endCDATA()
throws org.xml.sax.SAXException
- Report the end of a CDATA section.
- Specified by:
endCDATAin interfaceorg.xml.sax.ext.LexicalHandler
comment
public void comment(char[] ch,
int start,
int length)
throws org.xml.sax.SAXException
- Report an XML comment anywhere in the document.
This callback will be used for comments inside or outside the document element, including comments in the external DTD subset (if read). Comments in the DTD must be properly nested inside start/endDTD and start/endEntity events (if used).
- Specified by:
commentin interfaceorg.xml.sax.ext.LexicalHandler
objectData
public void objectData(java.lang.Object object) throws org.xml.sax.SAXException
- Pass data through the pipline.
By default, this call is ignored.
Subclasses are invited to use this as a way for children tags to
pass data to their parent.
getContentHandler
public org.xml.sax.ContentHandler getContentHandler()
setContentHandler
public void setContentHandler(org.xml.sax.ContentHandler contentHandler)
- Sets the SAX ContentHandler to pipe SAX events into
getLexicalHandler
public org.xml.sax.ext.LexicalHandler getLexicalHandler()
setLexicalHandler
public void setLexicalHandler(org.xml.sax.ext.LexicalHandler lexicalHandler)
- Sets the SAX LexicalHandler to pipe SAX events into
createXMLOutput
protected static XMLOutput createXMLOutput(org.dom4j.io.XMLWriter xmlWriter)
- Factory method to create a new XMLOutput from an XMLWriter
|
|||||||||
| Home >> All >> org >> apache >> commons >> [ jelly overview ] | PREV CLASS NEXT CLASS | ||||||||
SUMMARY: JAVADOC | SOURCE | DOWNLOAD | NESTED | FIELD | CONSTR | METHOD |
DETAIL: FIELD | CONSTR | METHOD | ||||||||
JAVADOC
org.apache.commons.jelly.XMLOutput