|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.avalon.framework.logger.AbstractLoggable
org.apache.cocoon.xml.AbstractXMLProducer
org.apache.cocoon.xml.AbstractXMLPipe
fr.gouv.culture.sdx.pipeline.AbstractPipeline
An abstract implementation of a Pipeline for manipulation of SAX events
Field Summary | |
protected org.apache.avalon.framework.configuration.Configuration |
configuration
The configruation object |
protected java.lang.String |
id
The id for the pipeline. |
protected java.lang.String |
keepStep
|
protected org.apache.avalon.framework.logger.Logger |
logger
Avalon logger to write information. |
protected org.apache.avalon.framework.component.ComponentManager |
manager
The a component manager |
protected java.util.Hashtable |
props
The Pipelines properties. |
protected java.util.LinkedList |
transformations
A list of the transformations that make up this pipeline. |
protected java.util.Vector |
transformsList
A list of the transformations that make up this pipeline. |
Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer |
contentHandler, lexicalHandler, xmlConsumer |
Fields inherited from interface fr.gouv.culture.sdx.pipeline.Pipeline |
ATTRIBUTE_ID, ATTRIBUTE_TYPE, CLASS_NAME_SUFFIX, ELEMENT_NAME, ELEMENT_NAME_PIPELINES, PACKAGE_QUALNAME |
Constructor Summary | |
AbstractPipeline()
|
Method Summary | |
void |
addTransformation(Transformation t)
Adds a transformation to the pipeline and sets the consumer of the last transformation to be the newly added transformation. |
void |
compose(org.apache.avalon.framework.component.ComponentManager manager)
Sets the pipeline's ComponentManager. |
void |
configure(org.apache.avalon.framework.configuration.Configuration configuration)
Configures the pipeline. |
void |
enableLogging(org.apache.avalon.framework.logger.Logger logger)
Sets the logger for the pipeline |
java.lang.String |
getId()
Returns the id for the pipeline |
org.apache.avalon.framework.parameters.Parameters |
getParameters()
Returns the paramters for this pipeline |
byte[] |
getTransformedBytes()
Returns a byte array which contains the data of a transformation step. |
java.io.File |
getTransformedFile()
Returns a file which contains the data of a transformation step. |
Pipeline |
newInstance()
Returns a new instance of this object |
void |
setConsumer(org.apache.cocoon.xml.XMLConsumer xmlConsumer)
Sets the consumer of the pipeline. |
void |
setParameters(org.apache.avalon.framework.parameters.Parameters params)
Sets the Parameters for each step in the Pipeline |
protected void |
setParametersToTransformations(org.apache.avalon.framework.parameters.Parameters parameters)
|
void |
setProperties(java.util.Hashtable props)
Sets Properties. |
protected void |
verifyConfigurationParameters(org.apache.avalon.framework.parameters.Parameters params)
|
Methods inherited from class org.apache.cocoon.xml.AbstractXMLPipe |
characters, comment, endCDATA, endDocument, endDTD, endElement, endEntity, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startCDATA, startDocument, startDTD, startElement, startEntity, startPrefixMapping |
Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer |
recycle, setContentHandler, setLexicalHandler |
Methods inherited from class org.apache.avalon.framework.logger.AbstractLoggable |
getLogger, setLogger, 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.xml.sax.ContentHandler |
characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping |
Methods inherited from interface org.xml.sax.ext.LexicalHandler |
comment, endCDATA, endDTD, endEntity, startCDATA, startDTD, startEntity |
Field Detail |
protected org.apache.avalon.framework.configuration.Configuration configuration
protected java.lang.String id
protected java.util.LinkedList transformations
protected org.apache.avalon.framework.logger.Logger logger
protected java.util.Vector transformsList
protected org.apache.avalon.framework.component.ComponentManager manager
protected java.lang.String keepStep
protected java.util.Hashtable props
Constructor Detail |
public AbstractPipeline()
Method Detail |
public void enableLogging(org.apache.avalon.framework.logger.Logger logger)
enableLogging
in interface org.apache.avalon.framework.logger.LogEnabled
logger
- The logger created from Cocoon's logkit.public void compose(org.apache.avalon.framework.component.ComponentManager manager) throws org.apache.avalon.framework.component.ComponentException
compose
in interface org.apache.avalon.framework.component.Composable
manager
- The ComponentManager to use.
org.apache.avalon.framework.component.ComponentException
public void configure(org.apache.avalon.framework.configuration.Configuration configuration) throws org.apache.avalon.framework.configuration.ConfigurationException
configure
in interface org.apache.avalon.framework.configuration.Configurable
configuration
- The configuration object provided from a document base object.
Retrieves the children elements named "transformation" and builds a transformation object for each element. Currently the only supported transformation type is "xslt".
Sample configuration snippet:
<sdx:pipeline sdx:id = "sdxIndexationPipeline">
<sdx:transformation src = "path to stylesheet, can be absolute or relative to the directory containing this file" sdx:id = "step2" sdx:type = "xslt"/>
<sdx:transformation src = "path to stylesheet, can be absolute or relative to the directory containing this file" sdx:id = "step3" sdx:type = "xslt" keep = "true"/>
</sdx:pipeline>
org.apache.avalon.framework.configuration.ConfigurationException
protected void verifyConfigurationParameters(org.apache.avalon.framework.parameters.Parameters params)
public void addTransformation(Transformation t) throws SDXException
addTransformation
in interface Pipeline
t
- The transformation to be added.
SDXException
public void setConsumer(org.apache.cocoon.xml.XMLConsumer xmlConsumer)
setConsumer
in interface org.apache.cocoon.xml.XMLProducer
xmlConsumer
- The XMLConsumer for the LAST step of the pipelinepublic void setParameters(org.apache.avalon.framework.parameters.Parameters params)
setParameters
in interface Pipeline
params
- The Parameters to use for each transformation step.
Each transformation step in the pipeline can call (getParameters() defined in the Transformation interface) and make use this Parameters object as needed before pipeline processing begins.
protected void setParametersToTransformations(org.apache.avalon.framework.parameters.Parameters parameters)
public java.lang.String getId()
Pipeline
getId
in interface Pipeline
public Pipeline newInstance() throws SDXException
newInstance
in interface Pipeline
SDXException
public org.apache.avalon.framework.parameters.Parameters getParameters()
getParameters
in interface Pipeline
public byte[] getTransformedBytes()
null
will be returned
getTransformedBytes
in interface Pipeline
public java.io.File getTransformedFile() throws SDXException
null
will be returned
getTransformedFile
in interface Pipeline
SDXException
public void setProperties(java.util.Hashtable props)
setProperties
in interface Pipeline
props
- A Properties object containing path information for an instance of an application.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |