org.apache.cocoon.portal.coplets.basket
Class BasketTransformer

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.AbstractSAXTransformer
                      org.apache.cocoon.portal.coplets.basket.AbstractBasketTransformer
                          org.apache.cocoon.portal.coplets.basket.BasketTransformer

All Implemented Interfaces:

Poolable, Recyclable, Disposable, Component, Configurable, LogEnabled, Serviceable, SitemapModelComponent, Transformer, XMLPipe, XMLProducer, XMLConsumer, ContentHandler, LexicalHandler

public class BasketTransformer
extends AbstractBasketTransformer

This transformer supports the basket and briefcase feature. It can generate links to add content into a content store.

Version:

CVS $Id: BasketTransformer.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Field Summary

protected static String	ADD_ITEM_ELEMENT Element to add a link
protected String	defaultLinkElement The default link element name
protected String	defaultLinkElementNS The default namespace for the link element
protected String	defaultStoreName The default store: briefcase or basket
protected static String	SHOW_ACTIONS_ELEMENT Element to show all actions

Fields inherited from class org.apache.cocoon.portal.coplets.basket.AbstractBasketTransformer

basketManager, NAMESPACE_URI

Fields inherited from class org.apache.cocoon.transformation.AbstractSAXTransformer

context, defaultNamespaceURI, EMPTY_ATTRIBUTES, emptyAttributes, ignoreEmptyCharacters, ignoreEventsCount, ignoreHooksCount, ignoreWhitespaces, manager, namespaceURI, objectModel, parameters, recorderStack, request, resolver, response, source, stack

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

BasketTransformer()

Method Summary

void	configure(Configuration configuration)
void	endTransformingElement(String uri, String name, String raw) Start processing elements of our namespace.
void	startTransformingElement(String uri, String name, String raw, Attributes attr) Start processing elements of our namespace.

Methods inherited from class org.apache.cocoon.portal.coplets.basket.AbstractBasketTransformer

dispose, service

Methods inherited from class org.apache.cocoon.transformation.AbstractSAXTransformer

addRecorder, characters, comment, endCDATA, endDocument, endDTD, endElement, endEntity, endParametersRecording, endParametersRecording, endPrefixMapping, endRecording, endSAXRecording, endSerializedXMLRecording, endTextRecording, findPrefixMapping, getMutableAttributes, ignorableWhitespace, processingInstruction, recycle, removeRecorder, sendEndElementEvent, sendEndElementEventNS, sendEndPrefixMapping, sendEvents, sendParametersEvents, sendStartElementEvent, sendStartElementEvent, sendStartElementEventNS, sendStartElementEventNS, sendStartPrefixMapping, sendTextEvent, setDocumentLocator, setup, setupTransforming, skippedEntity, startCDATA, startDocument, startDTD, startElement, startEntity, startParametersRecording, startPrefixMapping, startRecording, startSAXRecording, startSerializedXMLRecording, startTextRecording

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

ADD_ITEM_ELEMENT

protected static final String ADD_ITEM_ELEMENT

Element to add a link

See Also:

Constant Field Values

SHOW_ACTIONS_ELEMENT

protected static final String SHOW_ACTIONS_ELEMENT

Element to show all actions

See Also:

Constant Field Values

defaultStoreName

protected String defaultStoreName

The default store: briefcase or basket

defaultLinkElement

protected String defaultLinkElement

The default link element name

defaultLinkElementNS

protected String defaultLinkElementNS

The default namespace for the link element

Constructor Detail

BasketTransformer

public BasketTransformer()

Method Detail

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractSAXTransformer

Throws:

ConfigurationException

endTransformingElement

public void endTransformingElement(String uri,
                                   String name,
                                   String raw)
                            throws ProcessingException,
                                   IOException,
                                   SAXException

Description copied from class: AbstractSAXTransformer

Start processing elements of our namespace. This hook is invoked for each sax event with our namespace.

Overrides:

endTransformingElement in class AbstractSAXTransformer

Parameters:

uri - The namespace of the element.

name - The local name of the element.

raw - The qualified name of the element.

Throws:

ProcessingException

IOException

SAXException

startTransformingElement

public void startTransformingElement(String uri,
                                     String name,
                                     String raw,
                                     Attributes attr)
                              throws ProcessingException,
                                     IOException,
                                     SAXException

Description copied from class: AbstractSAXTransformer

Start processing elements of our namespace. This hook is invoked for each sax event with our namespace.

Overrides:

startTransformingElement in class AbstractSAXTransformer

Parameters:

uri - The namespace of the element.

name - The local name of the element.

raw - The qualified name of the element.

attr - The attributes of the element.

Throws:

ProcessingException

IOException

SAXException