| org.apache.cocoon.transformation.AbstractTransformer org.apache.cocoon.transformation.AbstractExtractionTransformer
All known Subclasses: org.apache.cocoon.transformation.SimpleFormInstanceExtractionTransformer,
AbstractExtractionTransformer | abstract public class AbstractExtractionTransformer extends AbstractTransformer (Code) | | This transformer sieves an incoming stream of xml
and feeds a DOMBuilder with it.
author: Paul Russell author: Christian Haul version: CVS $Id: AbstractExtractionTransformer.java 433543 2006-08-22 06:22:54Z crossley $ |
Method Summary | |
public void | characters(char c, int start, int len) Receive notification of character data. | public void | comment(char ch, int start, int len) Report an XML comment anywhere in the document. | public void | endCDATA() Report the end of a CDATA section. | public void | endDTD() Report the end of DTD declarations. | public void | endElement(String uri, String loc, String raw) Receive notification of the end of an element. | public void | endEntity(String name) Report the end of an entity. | abstract boolean | endExtracting(String uri, String loc, String raw) Receive notification of the end of an element and signal extraction end. | public void | endExtractingDocument(String uri, String loc, String raw) Receive notification of the end of the extracted Document. | public void | endPrefixMapping(String prefix) End the scope of a prefix-URI mapping. | abstract void | handleExtractedDocument(Document doc) Receive notification of the end of the extracted Document. | public void | ignorableWhitespace(char c, int start, int len) Receive notification of ignorable whitespace in element content. | public void | processingInstruction(String target, String data) Receive notification of a processing instruction. | public void | recycle() | public void | setup(SourceResolver resolver, Map objectModel, String src, Parameters parameters) Setup the transformer. | public void | skippedEntity(String name) Receive notification of a skipped entity.
Parameters: name - The name of the skipped entity. | public void | startCDATA() Report the start of a CDATA section. | public void | startDTD(String name, String publicId, String systemId) Report the start of DTD declarations, if any. | public void | startElement(String uri, String loc, String raw, Attributes a) Receive notification of the beginning of an element. | public void | startEntity(String name) Report the beginning of an entity.
Parameters: name - The name of the entity. | abstract boolean | startExtracting(String uri, String loc, String raw, Attributes a) Receive notification of the beginning of an element and signal extraction start.
Parameters: uri - The Namespace URI, or the empty string if the element has noNamespace URI or if Namespaceprocessing is not being performed. Parameters: loc - The local name (without prefix), or the empty string ifNamespace processing is not being performed. Parameters: raw - The raw XML 1.0 name (with prefix), or the empty string ifraw names are not available. Parameters: a - The attributes attached to the element. | public void | startExtractingDocument(String uri, String loc, String raw, Attributes a) Receive notification of the beginning of the extracted Document. | public void | startPrefixMapping(String prefix, String uri) Begin the scope of a prefix-URI Namespace mapping. |
extractLevel | protected int extractLevel(Code) | | |
characters | public void characters(char c, int start, int len) throws SAXException(Code) | | Receive notification of character data.
Parameters: c - The characters from the XML document. Parameters: start - The start position in the array. Parameters: len - The number of characters to read from the array. |
comment | public void comment(char ch, int start, int len) throws SAXException(Code) | | Report an XML comment anywhere in the document.
Parameters: ch - An array holding the characters in the comment. Parameters: start - The starting position in the array. Parameters: len - The number of characters to use from the array. |
endCDATA | public void endCDATA() throws SAXException(Code) | | Report the end of a CDATA section.
|
endElement | public void endElement(String uri, String loc, String raw) throws SAXException(Code) | | Receive notification of the end of an element. Uses
endExtraction to determine whether to stop extracting or
not. Calls endExtractedDocument with the extracted document.
Parameters: uri - The Namespace URI, or the empty string if the element has noNamespace URI or if Namespaceprocessing is not being performed. Parameters: loc - The local name (without prefix), or the empty string ifNamespace processing is not being performed. Parameters: raw - The raw XML 1.0 name (with prefix), or the empty string ifraw names are not available. |
endEntity | public void endEntity(String name) throws SAXException(Code) | | Report the end of an entity.
Parameters: name - The name of the entity that is ending. |
endExtracting | abstract boolean endExtracting(String uri, String loc, String raw)(Code) | | Receive notification of the end of an element and signal extraction end.
Parameters: uri - The Namespace URI, or the empty string if the element has noNamespace URI or if Namespaceprocessing is not being performed. Parameters: loc - The local name (without prefix), or the empty string ifNamespace processing is not being performed. Parameters: raw - The raw XML 1.0 name (with prefix), or the empty string if a boolean value to signal to stop extracting |
endExtractingDocument | public void endExtractingDocument(String uri, String loc, String raw) throws SAXException(Code) | | Receive notification of the end of the extracted Document. Per default,
send endElement message to document builder. Override if necessary.
Must override
AbstractExtractionTransformer.startExtractingDocument(String,String,String,Attributes) as well.
Parameters: uri - The Namespace URI, or the empty string if the element has noNamespace URI or if Namespaceprocessing is not being performed. Parameters: loc - The local name (without prefix), or the empty string ifNamespace processing is not being performed. Parameters: raw - The raw XML 1.0 name (with prefix), or the empty string ifraw names are not available. |
endPrefixMapping | public void endPrefixMapping(String prefix) throws SAXException(Code) | | End the scope of a prefix-URI mapping.
Parameters: prefix - The prefix that was being mapping. |
handleExtractedDocument | abstract void handleExtractedDocument(Document doc)(Code) | | Receive notification of the end of the extracted Document.
Parameters: doc - a Document value |
ignorableWhitespace | public void ignorableWhitespace(char c, int start, int len) throws SAXException(Code) | | Receive notification of ignorable whitespace in element content.
Parameters: c - The characters from the XML document. Parameters: start - The start position in the array. Parameters: len - The number of characters to read from the array. |
processingInstruction | public void processingInstruction(String target, String data) throws SAXException(Code) | | Receive notification of a processing instruction.
Parameters: target - The processing instruction target. Parameters: data - The processing instruction data, or null if none wassupplied. |
recycle | public void recycle()(Code) | | |
skippedEntity | public void skippedEntity(String name) throws SAXException(Code) | | Receive notification of a skipped entity.
Parameters: name - The name of the skipped entity. If it is a parameterentity, the name will begin with '%'. |
startCDATA | public void startCDATA() throws SAXException(Code) | | Report the start of a CDATA section.
|
startDTD | public void startDTD(String name, String publicId, String systemId) throws SAXException(Code) | | Report the start of DTD declarations, if any.
Parameters: name - The document type name. Parameters: publicId - The declared public identifier for the external DTDsubset, or null if none was declared. Parameters: systemId - The declared system identifier for the external DTDsubset, or null if none was declared. |
startElement | public void startElement(String uri, String loc, String raw, Attributes a) throws SAXException(Code) | | Receive notification of the beginning of an element. Uses
startExtraction to determine whether to start
extracting. Nested triggering tags result in only one document.
startExtractedDocument with the first node of the extracted
Document.
Parameters: uri - The Namespace URI, or the empty string if the element has noNamespace URI or if Namespaceprocessing is not being performed. Parameters: loc - The local name (without prefix), or the empty string ifNamespace processing is not being performed. Parameters: raw - The raw XML 1.0 name (with prefix), or the empty string ifraw names are not available. Parameters: a - The attributes attached to the element. If there are noattributes, it shall be an empty Attributes object. |
startEntity | public void startEntity(String name) throws SAXException(Code) | | Report the beginning of an entity.
Parameters: name - The name of the entity. If it is a parameter entity, thename will begin with '%'. |
startExtracting | abstract boolean startExtracting(String uri, String loc, String raw, Attributes a)(Code) | | Receive notification of the beginning of an element and signal extraction start.
Parameters: uri - The Namespace URI, or the empty string if the element has noNamespace URI or if Namespaceprocessing is not being performed. Parameters: loc - The local name (without prefix), or the empty string ifNamespace processing is not being performed. Parameters: raw - The raw XML 1.0 name (with prefix), or the empty string ifraw names are not available. Parameters: a - The attributes attached to the element. If there are noattributes, it shall be an empty Attributes object. a boolean value to signal to start extracting |
startExtractingDocument | public void startExtractingDocument(String uri, String loc, String raw, Attributes a) throws SAXException(Code) | | Receive notification of the beginning of the extracted Document. Per default send
startElement message to document builder. Override if necessary. Must override
AbstractExtractionTransformer.endExtractingDocument(String,String,String) as well.
Parameters: uri - The Namespace URI, or the empty string if the element has noNamespace URI or if Namespaceprocessing is not being performed. Parameters: loc - The local name (without prefix), or the empty string ifNamespace processing is not being performed. Parameters: raw - The raw XML 1.0 name (with prefix), or the empty string ifraw names are not available. Parameters: a - The attributes attached to the element. If there are noattributes, it shall be an empty Attributes object. |
startPrefixMapping | public void startPrefixMapping(String prefix, String uri) throws SAXException(Code) | | Begin the scope of a prefix-URI Namespace mapping.
Parameters: prefix - The Namespace prefix being declared. Parameters: uri - The Namespace URI the prefix is mapped to. |
|
|