|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.avalon.framework.logger.AbstractLogEnabled org.apache.cocoon.xml.AbstractXMLProducer org.apache.cocoon.xml.AbstractXMLPipe org.apache.cocoon.transformation.AbstractTransformer org.apache.cocoon.transformation.AbstractDOMTransformer
public abstract class AbstractDOMTransformer
An Abstract DOM Transformer, for use when a transformer needs a DOM-based
view of the document.
Subclass this interface and implement transform(Document doc)
.
If you need a ComponentManager there is an instance variable
manager
for use.
Field Summary | |
---|---|
protected DOMBuilder |
builder
The DOMBuilder used to build DOM tree out of
incoming SAX events. |
protected ComponentManager |
manager
A ComponentManager which is available for use. |
protected Map |
objectModel
The request object model |
protected Parameters |
parameters
Parameters in the sitemap |
protected SourceResolver |
resolver
The SAX entity resolver |
protected String |
source
The URI requested |
Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer |
---|
contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer |
Fields inherited from interface org.apache.cocoon.transformation.Transformer |
---|
ROLE |
Constructor Summary | |
---|---|
AbstractDOMTransformer()
|
Method Summary | |
---|---|
void |
characters(char[] c,
int start,
int len)
Receive notification of character data. |
void |
comment(char[] ch,
int start,
int len)
Report an XML comment anywhere in the document. |
void |
compose(ComponentManager manager)
Set the component manager. |
void |
dispose()
dispose |
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(String uri,
String loc,
String raw)
Receive notification of the end of an element. |
void |
endEntity(String name)
Report the end of an entity. |
void |
endPrefixMapping(String prefix)
End the scope of a prefix-URI mapping. |
void |
ignorableWhitespace(char[] c,
int start,
int len)
Receive notification of ignorable whitespace in element content. |
void |
notify(Document doc)
This method is called when the Document is finished. |
void |
processingInstruction(String target,
String data)
Receive notification of a processing instruction. |
void |
recycle()
Recycle the component. |
void |
setDocumentLocator(Locator locator)
Receive an object for locating the origin of SAX document events. |
void |
setup(SourceResolver resolver,
Map objectModel,
String src,
Parameters par)
Set the SourceResolver , objectModel Map ,
the source and sitemap Parameters used to process the request. |
void |
skippedEntity(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(String name,
String publicId,
String systemId)
Report the start of DTD declarations, if any. |
void |
startElement(String uri,
String loc,
String raw,
Attributes a)
Receive notification of the beginning of an element. |
void |
startEntity(String name)
Report the beginning of an entity. |
void |
startPrefixMapping(String prefix,
String uri)
Begin the scope of a prefix-URI Namespace mapping. |
protected abstract Document |
transform(Document doc)
Transform the specified DOM, returning a new DOM to stream down the pipeline. |
Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer |
---|
setConsumer, setContentHandler, setLexicalHandler |
Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled |
---|
enableLogging, getLogger, setupLogger, setupLogger, setupLogger |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.cocoon.xml.XMLProducer |
---|
setConsumer |
Field Detail |
---|
protected SourceResolver resolver
protected Map objectModel
protected String source
protected Parameters parameters
protected ComponentManager manager
ComponentManager
which is available for use.
protected DOMBuilder builder
DOMBuilder
used to build DOM tree out of
incoming SAX events.
Constructor Detail |
---|
public AbstractDOMTransformer()
Method Detail |
---|
public void compose(ComponentManager manager)
compose
in interface Composable
public void setup(SourceResolver resolver, Map objectModel, String src, Parameters par) throws ProcessingException, SAXException, IOException
SourceResolver
, objectModel Map
,
the source and sitemap Parameters
used to process the request.
If you wish to process the parameters, override this method, call
super()
and then add your code.
setup
in interface SitemapModelComponent
ProcessingException
SAXException
IOException
public void recycle()
recycle
in interface Recyclable
recycle
in class AbstractXMLProducer
public void dispose()
dispose
in interface Disposable
public void notify(Document doc) throws SAXException
notify
in interface DOMBuilder.Listener
doc
- The DOM Document object representing this SAX stream
SAXException
DOMBuilder.Listener
protected abstract Document transform(Document doc)
doc
- The DOM Document representing the SAX stream
public void setDocumentLocator(Locator locator)
AbstractXMLPipe
setDocumentLocator
in interface ContentHandler
setDocumentLocator
in class AbstractXMLPipe
locator
- An object that can return the location of any SAX
document event.public void startDocument() throws SAXException
AbstractXMLPipe
startDocument
in interface ContentHandler
startDocument
in class AbstractXMLPipe
SAXException
public void endDocument() throws SAXException
AbstractXMLPipe
endDocument
in interface ContentHandler
endDocument
in class AbstractXMLPipe
SAXException
public void startPrefixMapping(String prefix, String uri) throws SAXException
AbstractXMLPipe
startPrefixMapping
in interface ContentHandler
startPrefixMapping
in class AbstractXMLPipe
prefix
- The Namespace prefix being declared.uri
- The Namespace URI the prefix is mapped to.
SAXException
public void endPrefixMapping(String prefix) throws SAXException
AbstractXMLPipe
endPrefixMapping
in interface ContentHandler
endPrefixMapping
in class AbstractXMLPipe
prefix
- The prefix that was being mapping.
SAXException
public void startElement(String uri, String loc, String raw, Attributes a) throws SAXException
AbstractXMLPipe
startElement
in interface ContentHandler
startElement
in class AbstractXMLPipe
uri
- The Namespace URI, or the empty string if the element has no
Namespace URI or if Namespace
processing is not being performed.loc
- The local name (without prefix), or the empty string if
Namespace processing is not being performed.raw
- The raw XML 1.0 name (with prefix), or the empty string if
raw names are not available.a
- The attributes attached to the element. If there are no
attributes, it shall be an empty Attributes object.
SAXException
public void endElement(String uri, String loc, String raw) throws SAXException
AbstractXMLPipe
endElement
in interface ContentHandler
endElement
in class AbstractXMLPipe
uri
- The Namespace URI, or the empty string if the element has no
Namespace URI or if Namespace
processing is not being performed.loc
- The local name (without prefix), or the empty string if
Namespace processing is not being performed.raw
- The raw XML 1.0 name (with prefix), or the empty string if
raw names are not available.
SAXException
public void characters(char[] c, int start, int len) throws SAXException
AbstractXMLPipe
characters
in interface ContentHandler
characters
in class AbstractXMLPipe
c
- The characters from the XML document.start
- The start position in the array.len
- The number of characters to read from the array.
SAXException
public void ignorableWhitespace(char[] c, int start, int len) throws SAXException
AbstractXMLPipe
ignorableWhitespace
in interface ContentHandler
ignorableWhitespace
in class AbstractXMLPipe
c
- The characters from the XML document.start
- The start position in the array.len
- The number of characters to read from the array.
SAXException
public void processingInstruction(String target, String data) throws SAXException
AbstractXMLPipe
processingInstruction
in interface ContentHandler
processingInstruction
in class AbstractXMLPipe
target
- The processing instruction target.data
- The processing instruction data, or null if none was
supplied.
SAXException
public void skippedEntity(String name) throws SAXException
AbstractXMLPipe
skippedEntity
in interface ContentHandler
skippedEntity
in class AbstractXMLPipe
name
- The name of the skipped entity. If it is a parameter
entity, the name will begin with '%'.
SAXException
public void startDTD(String name, String publicId, String systemId) throws SAXException
AbstractXMLPipe
startDTD
in interface LexicalHandler
startDTD
in class AbstractXMLPipe
name
- The document type name.publicId
- The declared public identifier for the external DTD
subset, or null if none was declared.systemId
- The declared system identifier for the external DTD
subset, or null if none was declared.
SAXException
public void endDTD() throws SAXException
AbstractXMLPipe
endDTD
in interface LexicalHandler
endDTD
in class AbstractXMLPipe
SAXException
public void startEntity(String name) throws SAXException
AbstractXMLPipe
startEntity
in interface LexicalHandler
startEntity
in class AbstractXMLPipe
name
- The name of the entity. If it is a parameter entity, the
name will begin with '%'.
SAXException
public void endEntity(String name) throws SAXException
AbstractXMLPipe
endEntity
in interface LexicalHandler
endEntity
in class AbstractXMLPipe
name
- The name of the entity that is ending.
SAXException
public void startCDATA() throws SAXException
AbstractXMLPipe
startCDATA
in interface LexicalHandler
startCDATA
in class AbstractXMLPipe
SAXException
public void endCDATA() throws SAXException
AbstractXMLPipe
endCDATA
in interface LexicalHandler
endCDATA
in class AbstractXMLPipe
SAXException
public void comment(char[] ch, int start, int len) throws SAXException
AbstractXMLPipe
comment
in interface LexicalHandler
comment
in class AbstractXMLPipe
ch
- An array holding the characters in the comment.start
- The starting position in the array.len
- The number of characters to use from the array.
SAXException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |