fr.gouv.culture.sdx.pipeline
Class GetDocumentsTransformation

java.lang.Object
  extended byorg.apache.avalon.framework.logger.AbstractLoggable
      extended byorg.apache.cocoon.xml.AbstractXMLProducer
          extended byorg.apache.cocoon.xml.AbstractXMLPipe
              extended byfr.gouv.culture.sdx.pipeline.AbstractTransformation
                  extended byfr.gouv.culture.sdx.pipeline.GetDocumentsTransformation
All Implemented Interfaces:
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.avalon.framework.logger.Loggable, org.apache.avalon.excalibur.pool.Poolable, org.apache.avalon.excalibur.pool.Recyclable, Transformation, org.apache.cocoon.xml.XMLConsumer, org.apache.cocoon.xml.XMLPipe, org.apache.cocoon.xml.XMLProducer

public class GetDocumentsTransformation
extends AbstractTransformation

Retrieves and passes result documents via the xmlConsumer, may strip other information from provided events if parameters are set. Attention: It is possible to receive no events with the correct set of parameters!


Field Summary
static java.lang.String SEND_ALL_FIELDS
          String representation for a transformation parameter
static java.lang.String SEND_INTERNAL_FIELDS
          String representation for a transformation parameter
static java.lang.String SEND_SDX_ELEMENTS
          String representation for a transformation parameter
static java.lang.String SEND_USER_FIELDS
          String representation for a transformation parameter
 
Fields inherited from class fr.gouv.culture.sdx.pipeline.AbstractTransformation
id, logger, manager, PARAMETER_NAME_DISABLE, PARAMETER_NAME_ENABLE, parameters, props, transParameters
 
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
GetDocumentsTransformation()
           
 
Method Summary
 void characters(char[] c, int start, int len)
          Filters characters
 void configure(org.apache.avalon.framework.configuration.Configuration configuration)
          Could be used to configure this object, but currently has no function
 void endElement(java.lang.String uri, java.lang.String local, java.lang.String qName)
          Filters elements
 void setParameters(org.apache.avalon.framework.parameters.Parameters p)
          Set's the parameters for this transformation
 void startElement(java.lang.String uri, java.lang.String local, java.lang.String qName, org.xml.sax.Attributes attr)
          Filters elements
 
Methods inherited from class fr.gouv.culture.sdx.pipeline.AbstractTransformation
compose, enableLogging, getId, getParameters, isStepEnabled, recycle, setProperties, shouldKeepResult, verifyConfigurationParameters
 
Methods inherited from class org.apache.cocoon.xml.AbstractXMLPipe
comment, endCDATA, endDocument, endDTD, endEntity, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startCDATA, startDocument, startDTD, 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
endDocument, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, 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

SEND_USER_FIELDS

public static final java.lang.String SEND_USER_FIELDS
String representation for a transformation parameter

See Also:
Constant Field Values

SEND_INTERNAL_FIELDS

public static final java.lang.String SEND_INTERNAL_FIELDS
String representation for a transformation parameter

See Also:
Constant Field Values

SEND_SDX_ELEMENTS

public static final java.lang.String SEND_SDX_ELEMENTS
String representation for a transformation parameter

See Also:
Constant Field Values

SEND_ALL_FIELDS

public static final java.lang.String SEND_ALL_FIELDS
String representation for a transformation parameter

See Also:
Constant Field Values
Constructor Detail

GetDocumentsTransformation

public GetDocumentsTransformation()
Method Detail

configure

public void configure(org.apache.avalon.framework.configuration.Configuration configuration)
               throws org.apache.avalon.framework.configuration.ConfigurationException
Could be used to configure this object, but currently has no function

Specified by:
configure in interface org.apache.avalon.framework.configuration.Configurable
Overrides:
configure in class AbstractTransformation
Parameters:
configuration -
Throws:
org.apache.avalon.framework.configuration.ConfigurationException

setParameters

public void setParameters(org.apache.avalon.framework.parameters.Parameters p)
Set's the parameters for this transformation

Specified by:
setParameters in interface Transformation
Overrides:
setParameters in class AbstractTransformation
Parameters:
p - The parameters

startElement

public void startElement(java.lang.String uri,
                         java.lang.String local,
                         java.lang.String qName,
                         org.xml.sax.Attributes attr)
                  throws org.xml.sax.SAXException
Filters elements

Throws:
org.xml.sax.SAXException

characters

public void characters(char[] c,
                       int start,
                       int len)
                throws org.xml.sax.SAXException
Filters characters

Throws:
org.xml.sax.SAXException

endElement

public void endElement(java.lang.String uri,
                       java.lang.String local,
                       java.lang.String qName)
                throws org.xml.sax.SAXException
Filters elements

Throws:
org.xml.sax.SAXException


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