fr.gouv.culture.sdx.pipeline
Interface Transformation

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 Implementing Classes:
AbstractTransformation

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

An SDX transformation in an SDX pipeline.

A transformation is a generic operation that receives and throws SAX events. It can be a SAX filter, an XSLT transformation, or other complex mechanism.

The only difference with a Cocoon XMLPipe is that it can be parameterized, which can be useful for XSLT transformations.


Field Summary
static java.lang.String ATTRIBUTE_ID
          String representation of the "transformation" attribute name "id"
static java.lang.String ATTRIBUTE_KEEP
          String representation of the "transformation" attribute name "keep".
static java.lang.String ATTRIBUTE_SRC
          String representation of the "transformation" attribute name "src".
static java.lang.String ATTRIBUTE_TH
          String representation of the "transformation" attribute name "th".
static java.lang.String ATTRIBUTE_TYPE
          String representation of the "transformation" attribute name "type".
static java.lang.String CLASS_NAME_SUFFIX
          String representation of the transformation class name suffix.
static java.lang.String ELEMENT_NAME_TRANSFORMATION
          String representation of the element name "transformation".
static java.lang.String PACKAGE_QUALNAME
          String representation of the transformation package name (including trailing separator ".").
 
Method Summary
 java.lang.String getId()
          Returns the Transformations id.
 org.apache.avalon.framework.parameters.Parameters getParameters()
          The parameters for this transformation.
 void recycle()
          Recycles the contentHandler, lexicalHandler, and xmlConsumer for the transformation
 void setParameters(org.apache.avalon.framework.parameters.Parameters p)
          Sets some parameters for this transformation.
 void setProperties(java.util.Hashtable props)
          Sets the properties object for the implementing class.
 boolean shouldKeepResult()
          Indicates wheter the results of this transfomation should be retained
 
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.component.Composable
compose
 
Methods inherited from interface org.apache.avalon.framework.configuration.Configurable
configure
 

Field Detail

ELEMENT_NAME_TRANSFORMATION

public static final java.lang.String ELEMENT_NAME_TRANSFORMATION
String representation of the element name "transformation".

See Also:
Constant Field Values

ATTRIBUTE_SRC

public static final java.lang.String ATTRIBUTE_SRC
String representation of the "transformation" attribute name "src".

See Also:
Constant Field Values

ATTRIBUTE_KEEP

public static final java.lang.String ATTRIBUTE_KEEP
String representation of the "transformation" attribute name "keep".

See Also:
Constant Field Values

ATTRIBUTE_TYPE

public static final java.lang.String ATTRIBUTE_TYPE
String representation of the "transformation" attribute name "type".

See Also:
Constant Field Values

ATTRIBUTE_ID

public static final java.lang.String ATTRIBUTE_ID
String representation of the "transformation" attribute name "id"

See Also:
Constant Field Values

ATTRIBUTE_TH

public static final java.lang.String ATTRIBUTE_TH
String representation of the "transformation" attribute name "th".

See Also:
Constant Field Values

PACKAGE_QUALNAME

public static final java.lang.String PACKAGE_QUALNAME
String representation of the transformation 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 transformation class name suffix.

See Also:
Constant Field Values
Method Detail

setParameters

public void setParameters(org.apache.avalon.framework.parameters.Parameters p)
Sets some parameters for this transformation.


getParameters

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


recycle

public void recycle()
Recycles the contentHandler, lexicalHandler, and xmlConsumer for the transformation


setProperties

public void setProperties(java.util.Hashtable props)
Sets the properties object for the implementing class.

Parameters:
props - The desired properties object

getId

public java.lang.String getId()
Returns the Transformations id.


shouldKeepResult

public boolean shouldKeepResult()
Indicates wheter the results of this transfomation should be retained



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