|
||||||||||
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.AbstractTransformation
An abstract transformation for basic operations.
This abstract class properly handle the logger and the parameters.
Field Summary | |
protected java.lang.String |
id
The id for this Transformation |
protected org.apache.avalon.framework.logger.Logger |
logger
Avalon logger to write information. |
protected org.apache.avalon.framework.component.ComponentManager |
manager
The component manager. |
protected static java.lang.String |
PARAMETER_NAME_DISABLE
|
protected static java.lang.String |
PARAMETER_NAME_ENABLE
|
protected org.apache.avalon.framework.parameters.Parameters |
parameters
The parameters for this transformation provided by the pipeline via the setParameters() method. |
protected java.util.Hashtable |
props
The Transformation's properties. |
protected org.apache.avalon.framework.parameters.Parameters |
transParameters
The parameters for this transformation provided by the Parameteriable interface's parameterize method. |
Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer |
contentHandler, lexicalHandler, xmlConsumer |
Fields inherited from interface fr.gouv.culture.sdx.pipeline.Transformation |
ATTRIBUTE_ID, ATTRIBUTE_KEEP, ATTRIBUTE_SRC, ATTRIBUTE_TH, ATTRIBUTE_TYPE, CLASS_NAME_SUFFIX, ELEMENT_NAME_TRANSFORMATION, PACKAGE_QUALNAME |
Constructor Summary | |
AbstractTransformation()
|
Method Summary | |
void |
compose(org.apache.avalon.framework.component.ComponentManager manager)
Sets the pipeline's ComponentManager. |
void |
configure(org.apache.avalon.framework.configuration.Configuration configuration)
Loads base configuration common to all transformations. |
void |
enableLogging(org.apache.avalon.framework.logger.Logger logger)
Set's the logger for the transformation. |
java.lang.String |
getId()
Returns the Transformations id. |
org.apache.avalon.framework.parameters.Parameters |
getParameters()
The parameters for this transformation. |
protected boolean |
isStepEnabled()
Returns a boolean indicating whether this transformation is enabled first check the tranformations parameters secondly checking the parameters passed from the containing pipeline |
void |
recycle()
Recycles the contentHandler, lexicalHandler, and xmlConsumer for the transformation |
void |
setParameters(org.apache.avalon.framework.parameters.Parameters p)
Sets some parameters from a pipeline. |
void |
setProperties(java.util.Hashtable props)
Sets Properties for the subclasses. |
boolean |
shouldKeepResult()
Indicates wheter the results of this transfomation should be retained |
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 |
setConsumer, 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 |
Methods inherited from interface org.apache.cocoon.xml.XMLProducer |
setConsumer |
Field Detail |
protected static final java.lang.String PARAMETER_NAME_DISABLE
protected static final java.lang.String PARAMETER_NAME_ENABLE
protected org.apache.avalon.framework.parameters.Parameters parameters
this.setParameters()
protected org.apache.avalon.framework.parameters.Parameters transParameters
this.parameterize();
protected org.apache.avalon.framework.logger.Logger logger
protected java.lang.String id
protected java.util.Hashtable props
protected org.apache.avalon.framework.component.ComponentManager manager
Constructor Detail |
public AbstractTransformation()
Method Detail |
public void setProperties(java.util.Hashtable props)
setProperties
in interface Transformation
props
- A Properties object containing path information for an instance of an application.public void enableLogging(org.apache.avalon.framework.logger.Logger logger)
enableLogging
in interface org.apache.avalon.framework.logger.LogEnabled
logger
- The logger to use for this transformation.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 org.apache.avalon.framework.parameters.Parameters getParameters()
Transformation
getParameters
in interface Transformation
public void setParameters(org.apache.avalon.framework.parameters.Parameters p)
setParameters
in interface Transformation
p
- The parameterspublic void recycle()
recycle
in interface Transformation
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
org.apache.avalon.framework.configuration.ConfigurationException
protected void verifyConfigurationParameters(org.apache.avalon.framework.parameters.Parameters params)
public java.lang.String getId()
Transformation
getId
in interface Transformation
public boolean shouldKeepResult()
shouldKeepResult
in interface Transformation
protected boolean isStepEnabled()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |