fr.gouv.culture.sdx.pipeline
Interface Pipeline

All Superinterfaces:
org.apache.avalon.framework.component.Composable, org.apache.avalon.framework.configuration.Configurable, org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler, org.apache.avalon.framework.logger.LogEnabled, org.apache.cocoon.xml.XMLConsumer, org.apache.cocoon.xml.XMLPipe, org.apache.cocoon.xml.XMLProducer
All Known Subinterfaces:
TermHighlighter
All Known Implementing Classes:
AbstractPipeline, LuceneTermHighlighter

public interface Pipeline
extends org.apache.cocoon.xml.XMLPipe, org.apache.avalon.framework.logger.LogEnabled, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.component.Composable


Field Summary
static java.lang.String ATTRIBUTE_ID
          String representation of the "pipeline" attribute name "id" in our xconf config files.
static java.lang.String ATTRIBUTE_TYPE
          String representation of the "pipeline" attribute name "type" in our xconf config files.
static java.lang.String CLASS_NAME_SUFFIX
          String representation of the pipeline class name suffix.
static java.lang.String ELEMENT_NAME
          String representation of the element name "pipeline".
static java.lang.String ELEMENT_NAME_PIPELINES
          String representation of the element name "pipelines".
static java.lang.String PACKAGE_QUALNAME
          String representation of the pipeline package name (including trailing separator ".").
 
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.
 java.lang.String getId()
          Returns the id for the pipeline
 org.apache.avalon.framework.parameters.Parameters getParameters()
          The parameters 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()
          Generates a new instance of a Pipeline object
 void setParameters(org.apache.avalon.framework.parameters.Parameters params)
          Set's the default pipeline parameters
 void setProperties(java.util.Hashtable props)
          Sets Properties.
 
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
 
Methods inherited from interface org.apache.cocoon.xml.XMLProducer
setConsumer
 
Methods inherited from interface org.apache.avalon.framework.logger.LogEnabled
enableLogging
 
Methods inherited from interface org.apache.avalon.framework.configuration.Configurable
configure
 
Methods inherited from interface org.apache.avalon.framework.component.Composable
compose
 

Field Detail

ELEMENT_NAME

public static final java.lang.String ELEMENT_NAME
String representation of the element name "pipeline".

See Also:
Constant Field Values

ELEMENT_NAME_PIPELINES

public static final java.lang.String ELEMENT_NAME_PIPELINES
String representation of the element name "pipelines".

See Also:
Constant Field Values

ATTRIBUTE_ID

public static final java.lang.String ATTRIBUTE_ID
String representation of the "pipeline" attribute name "id" in our xconf config files.

See Also:
Constant Field Values

ATTRIBUTE_TYPE

public static final java.lang.String ATTRIBUTE_TYPE
String representation of the "pipeline" attribute name "type" in our xconf config files.

See Also:
Constant Field Values

PACKAGE_QUALNAME

public static final java.lang.String PACKAGE_QUALNAME
String representation of the pipeline package name (including trailing separator ".").

See Also:
Constant Field Values

CLASS_NAME_SUFFIX

public static final java.lang.String CLASS_NAME_SUFFIX
String representation of the pipeline class name suffix.

See Also:
Constant Field Values
Method Detail

newInstance

public Pipeline newInstance()
                     throws SDXException
Generates a new instance of a Pipeline object

Throws:
SDXException

setParameters

public void setParameters(org.apache.avalon.framework.parameters.Parameters params)
Set's the default pipeline parameters

Parameters:
params - The parameters for steps of the pipeline

getId

public java.lang.String getId()
Returns the id for the pipeline


getParameters

public org.apache.avalon.framework.parameters.Parameters getParameters()
The parameters for this pipeline.


setProperties

public void setProperties(java.util.Hashtable props)
Sets Properties.

Parameters:
props - A Properties object for configuration etc.

addTransformation

public void addTransformation(Transformation t)
                       throws SDXException
Adds a transformation to the pipeline and sets the consumer of the last transformation to be the newly added transformation.

Parameters:
t - The transformation to be added.
Throws:
SDXException

getTransformedBytes

public byte[] getTransformedBytes()
Returns a byte array which contains the data of a transformation step. The data will only be present after a pipeline is executed, if no transformation data is retained null will be returned


getTransformedFile

public java.io.File getTransformedFile()
                                throws SDXException
Returns a file which contains the data of a transformation step. The data will only be present after a pipeline is executed, if no transformation data is retained null will be returned

Throws:
SDXException


Copyright © 2000-2004 Ministere de la culture et de la communication / AJLSM. All Rights Reserved.