public abstract class AbstractTransformation extends AbstractSdxXMLPipe implements Transformation
This abstract class properly handle the super.getLog() and the parameters.
SdxObject.ConfigurationNode| Modifier and Type | Field and Description |
|---|---|
protected org.apache.excalibur.source.SourceResolver |
_resolver
The SourceResolver to use.
|
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 org.apache.avalon.framework.parameters.Parameters |
transParameters
The parameters for this transformation provided by the Parameteriable interface's
parameterize method.
|
_configuration, _context, _description, _encoding, _id, _locale, _logger, _manager, _xmlizable_objects, _xmlLang, isToSaxInitializedcontentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumerATTRIBUTE_KEEP, ATTRIBUTE_SRC, ATTRIBUTE_TH, CLASS_NAME_SUFFIX, PACKAGE_QUALNAMEDEFAULT_ENCODING| Constructor and Description |
|---|
AbstractTransformation() |
| Modifier and Type | Method and Description |
|---|---|
void |
configure(org.apache.avalon.framework.configuration.Configuration configuration)
Loads base configuration common to all transformations.
|
protected java.lang.String |
getClassNameSuffix()
Sub classes should element this method to return their class name suffix for SAX output
|
org.apache.avalon.framework.parameters.Parameters |
getParameters()
The parameters for this transformation.
|
protected boolean |
initToSax()
Init the DefaultContext class _xmlizable_objects with the objects in order to describ them in XML
|
protected void |
initVolatileObjectsToSax()
Init the LinkedHashMap _xmlizable_volatile_objects with the objects in order to describ them in XML
Some objects need to be refresh each time a toSAX is called
|
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 |
service(org.apache.avalon.framework.service.ServiceManager serviceManager)
Keeps the SourceResolver.
|
void |
setParameters(org.apache.avalon.framework.parameters.Parameters p)
Sets some parameters from a pipeline.
|
boolean |
shouldKeepResult()
Indicates wheter the results of this transfomation should be retained
|
protected void |
verifyConfigurationParameters(org.apache.avalon.framework.parameters.Parameters params) |
configureDescription, contextualize, enableLogging, getBaseAttributes, getConfiguration, getContext, getDescription, getEncoding, getId, getLocale, getLog, getServiceManager, getXmlLang, setDescription, setEncoding, setId, setLocale, setUpSdxObject, setUpSdxObject, setXmlLang, toSAX, verifyConfigurationResourcescharacters, comment, endCDATA, endDocument, endDTD, endElement, endEntity, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startCDATA, startDocument, startDTD, startElement, startEntity, startPrefixMappingsetConsumer, setContentHandler, setLexicalHandlergetLogger, setupLogger, setupLogger, setupLoggerclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcharacters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMappingcomment, endCDATA, endDTD, endEntity, startCDATA, startDTD, startEntitygetId, setIdgetDescription, setDescriptiongetEncoding, setEncodinggetLocale, getXmlLang, setLocale, setXmlLangprotected static final java.lang.String PARAMETER_NAME_DISABLE
protected static final java.lang.String PARAMETER_NAME_ENABLE
protected org.apache.excalibur.source.SourceResolver _resolver
protected org.apache.avalon.framework.parameters.Parameters parameters
this.setParameters()protected org.apache.avalon.framework.parameters.Parameters transParameters
this.parameterize();public void service(org.apache.avalon.framework.service.ServiceManager serviceManager)
throws org.apache.avalon.framework.service.ServiceException
service in interface org.apache.avalon.framework.service.Serviceableservice in class AbstractSdxXMLPipeorg.apache.avalon.framework.service.ServiceExceptionpublic org.apache.avalon.framework.parameters.Parameters getParameters()
TransformationgetParameters in interface Transformationpublic void setParameters(org.apache.avalon.framework.parameters.Parameters p)
setParameters in interface Transformationp - The parameterspublic void recycle()
recycle in interface Transformationrecycle in interface org.apache.avalon.excalibur.pool.Recyclablerecycle in class org.apache.cocoon.xml.AbstractXMLProducerpublic void configure(org.apache.avalon.framework.configuration.Configuration configuration)
throws org.apache.avalon.framework.configuration.ConfigurationException
configure in interface org.apache.avalon.framework.configuration.Configurableconfigure in class AbstractSdxXMLPipeconfiguration - The configuration objectorg.apache.avalon.framework.configuration.ConfigurationExceptionprotected void verifyConfigurationParameters(org.apache.avalon.framework.parameters.Parameters params)
public boolean shouldKeepResult()
shouldKeepResult in interface Transformationprotected boolean isStepEnabled()
protected java.lang.String getClassNameSuffix()
AbstractSdxXMLPipegetClassNameSuffix in class AbstractSdxXMLPipeprotected boolean initToSax()
AbstractSdxXMLPipeinitToSax in class AbstractSdxXMLPipeprotected void initVolatileObjectsToSax()
initVolatileObjectsToSax in class AbstractSdxXMLPipeCopyright © 2000-2010 Ministere de la culture et de la communication / AJLSM. All Rights Reserved.