| org.apache.cocoon.transformation.AbstractSAXTransformer
 org.apache.cocoon.portal.transformation.AbstractCopletTransformer
All known Subclasses: org.apache.cocoon.portal.transformation.CopletTransformer, org.apache.cocoon.portal.transformation.EventLinkTransformer, org.apache.cocoon.portal.transformation.HTMLEventLinkTransformer, org.apache.cocoon.portal.transformation.NewEventLinkTransformer,
| AbstractCopletTransformer | | abstract public class AbstractCopletTransformer extends AbstractSAXTransformer (Code) | | Abstract transformer implementation that provides some useful methods and
functionality. The portal service is stored in the instance variable
AbstractCopletTransformer.portalService and can be used.
There are some methods to fetch a coplet instance data.
AbstractCopletTransformer.getCopletInstanceData() tries to get the instance associated with the current request and
AbstractCopletTransformer.getCopletInstanceData(String) fetches an instance with a given id.
If you want to get the coplet instance data associated with the current request,
there are three possibilities how the transformer obtains the information required
for getting the coplet instance data - or more precisly its id:
1) If it is used within a coplet pipeline and this pipeline is called using
the "cocoon:" protocol, all required information is passed automatically.
2) The id can be passed to the transformer as sitemap paremeters in the following way:
<map:transform type="coplet">
<map:parameter name="copletId" type="examplecoplet"/>
</map:transform>
3) Any component can set the id as a string in the object model of the current request.
This is the name of the key to be used:
org.apache.cocoon.portal.Constants.COPLET_ID_KEY .
author:
Carsten Ziegeler
version:
CVS $Id: AbstractCopletTransformer.java 433543 2006-08-22 06:22:54Z crossley $ |
| COPLET_ID_PARAM | | final public static String COPLET_ID_PARAM(Code) | | Parameter name for the coplet id.
|
| dispose | | public void dispose()(Code) | |
See Also: org.apache.avalon.framework.activity.Disposable.dispose |
| getCopletInstanceData | | protected CopletInstanceData getCopletInstanceData() throws SAXException(Code) | | Try to get the coplet instance data belonging to the current request
The coplet instance data
throws:
SAXException - If an errors occurs or the instance data is not available |
| getCopletInstanceData | | protected CopletInstanceData getCopletInstanceData(String copletId) throws SAXException(Code) | | Try to get the coplet instance data with the given id
Parameters:
copletId - The id of the coplet instance or null if this transformeris used inside a coplet pipeline The coplet instance data or null
throws:
SAXException - If an error occurs |
| service | | public void service(ServiceManager manager) throws ServiceException(Code) | |
See Also: org.apache.avalon.framework.service.Serviceable.service(org.apache.avalon.framework.service.ServiceManager) |
| Methods inherited from org.apache.cocoon.transformation.AbstractSAXTransformer | protected void addRecorder(XMLConsumer recorder)(Code)(Java Doc)
public void characters(char[] p0, int p1, int p2) throws SAXException(Code)(Java Doc)
public void comment(char ary, int start, int length) throws SAXException(Code)(Java Doc)
public void configure(Configuration configuration) throws ConfigurationException(Code)(Java Doc)
public void dispose()(Code)(Java Doc)
public void endCDATA() throws SAXException(Code)(Java Doc)
public void endDTD() throws SAXException(Code)(Java Doc)
public void endDocument() throws SAXException(Code)(Java Doc)
public void endElement(String uri, String name, String raw) throws SAXException(Code)(Java Doc)
public void endEntity(String name) throws SAXException(Code)(Java Doc)
public SourceParameters endParametersRecording(Parameters source) throws SAXException(Code)(Java Doc)
public SourceParameters endParametersRecording(SourceParameters source) throws SAXException(Code)(Java Doc)
public void endPrefixMapping(String prefix) throws SAXException(Code)(Java Doc)
public DocumentFragment endRecording() throws SAXException(Code)(Java Doc)
public XMLizable endSAXRecording() throws SAXException(Code)(Java Doc)
public String endSerializedXMLRecording() throws SAXException, ProcessingException(Code)(Java Doc)
public String endTextRecording() throws SAXException(Code)(Java Doc)
public void endTransformingElement(String uri, String name, String raw) throws ProcessingException, IOException, SAXException(Code)(Java Doc)
protected String findPrefixMapping(String uri)(Code)(Java Doc)
protected AttributesImpl getMutableAttributes(Attributes a)(Code)(Java Doc)
public void ignorableWhitespace(char[] p0, int p1, int p2) throws SAXException(Code)(Java Doc)
public void processingInstruction(String target, String data) throws SAXException(Code)(Java Doc)
public void recycle()(Code)(Java Doc)
protected Object removeRecorder()(Code)(Java Doc)
public void sendEndElementEvent(String localname) throws SAXException(Code)(Java Doc)
public void sendEndElementEventNS(String localname) throws SAXException(Code)(Java Doc)
protected void sendEndPrefixMapping() throws SAXException(Code)(Java Doc)
public void sendEvents(Node node) throws SAXException(Code)(Java Doc)
public void sendParametersEvents(SourceParameters pars) throws SAXException(Code)(Java Doc)
public void sendStartElementEvent(String localname) throws SAXException(Code)(Java Doc)
public void sendStartElementEvent(String localname, Attributes attr) throws SAXException(Code)(Java Doc)
public void sendStartElementEventNS(String localname) throws SAXException(Code)(Java Doc)
public void sendStartElementEventNS(String localname, Attributes attr) throws SAXException(Code)(Java Doc)
protected void sendStartPrefixMapping() throws SAXException(Code)(Java Doc)
public void sendTextEvent(String text) throws SAXException(Code)(Java Doc)
public void service(ServiceManager manager) throws ServiceException(Code)(Java Doc)
public void setDocumentLocator(Locator locator)(Code)(Java Doc)
public void setup(SourceResolver resolver, Map objectModel, String src, Parameters params) throws ProcessingException, SAXException, IOException(Code)(Java Doc)
public void setupTransforming() throws IOException, ProcessingException, SAXException(Code)(Java Doc)
public void skippedEntity(String name) throws SAXException(Code)(Java Doc)
public void startCDATA() throws SAXException(Code)(Java Doc)
public void startDTD(String name, String public_id, String system_id) throws SAXException(Code)(Java Doc)
public void startDocument() throws SAXException(Code)(Java Doc)
public void startElement(String uri, String name, String raw, Attributes attr) throws SAXException(Code)(Java Doc)
public void startEntity(String name) throws SAXException(Code)(Java Doc)
public void startParametersRecording() throws SAXException(Code)(Java Doc)
public void startPrefixMapping(String prefix, String uri) throws SAXException(Code)(Java Doc)
public void startRecording() throws SAXException(Code)(Java Doc)
public void startSAXRecording() throws SAXException(Code)(Java Doc)
public void startSerializedXMLRecording(Properties format) throws SAXException(Code)(Java Doc)
public void startTextRecording() throws SAXException(Code)(Java Doc)
public void startTransformingElement(String uri, String name, String raw, Attributes attr) throws ProcessingException, IOException, SAXException(Code)(Java Doc)
|
|
|