net.sourceforge.chaperon.cocoon
Class LexicalTransformer

java.lang.Object
  extended by net.sourceforge.chaperon.process.LexicalProcessor
      extended by net.sourceforge.chaperon.cocoon.LexicalTransformer
All Implemented Interfaces:
org.apache.avalon.excalibur.pool.Poolable, org.apache.avalon.excalibur.pool.Recyclable, org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.component.Component, org.apache.avalon.framework.logger.LogEnabled, org.apache.avalon.framework.parameters.Parameterizable, org.apache.avalon.framework.service.Serviceable, org.apache.cocoon.caching.CacheableProcessingComponent, org.apache.cocoon.sitemap.SitemapModelComponent, org.apache.cocoon.transformation.Transformer, org.apache.cocoon.xml.XMLPipe, org.apache.cocoon.xml.XMLProducer, org.apache.excalibur.xml.sax.XMLConsumer, org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler

public class LexicalTransformer
extends LexicalProcessor
implements org.apache.cocoon.transformation.Transformer, org.apache.avalon.framework.logger.LogEnabled, org.apache.avalon.framework.service.Serviceable, org.apache.avalon.excalibur.pool.Recyclable, org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.parameters.Parameterizable, org.apache.cocoon.caching.CacheableProcessingComponent

This transfomer transforms special mark text part of a XML file into lexemes by using a lexicon file.

Input:

 <text xmlns="http://chaperon.sourceforge.net/schema/text/1.0">
  Text 123 bla
 </text>
 

were transform into the following output:

 <lexemes xmlns="http://chaperon.sourceforge.net/schema/lexemes/1.0">
  <lexeme symbol="word" text="Text"/>
  <lexeme symbol="number" text="123"/>
  <lexeme symbol="word" text="bla"/>
 </lexemes>
 

Version:
CVS $Id: LexicalTransformer.java,v 1.3 2004/01/18 01:36:29 benedikta Exp $
Author:
Stephan Michels

Nested Class Summary
 class LexicalTransformer.LexicalAutomatonEntry
          This class represent a entry in a store to cache the lexical automaton.
 
Field Summary
 
Fields inherited from class net.sourceforge.chaperon.process.LexicalProcessor
ERROR, GROUP, LEXEME, NS, NS_OUTPUT, OUTPUT, TEXT
 
Fields inherited from interface org.apache.cocoon.transformation.Transformer
ROLE
 
Constructor Summary
LexicalTransformer()
           
 
Method Summary
 void dispose()
          The dispose operation is called at the end of a components lifecycle.
 void enableLogging(org.apache.avalon.framework.logger.Logger logger)
          Provide component with a logger.
 java.io.Serializable getKey()
          Generate the unique key.
 org.apache.excalibur.source.SourceValidity getValidity()
          Generate the validity object.
 void parameterize(org.apache.avalon.framework.parameters.Parameters parameters)
          Provide component with parameters.
 void recycle()
          Recycle this component.
 void service(org.apache.avalon.framework.service.ServiceManager manager)
          Pass the ServiceManager to the service.
 void setConsumer(org.apache.cocoon.xml.XMLConsumer consumer)
          Set the XMLConsumer that will receive XML data.
 void setup(org.apache.cocoon.environment.SourceResolver resolver, java.util.Map objectmodel, java.lang.String src, org.apache.avalon.framework.parameters.Parameters parameters)
          Set the SourceResolver, objectModel Map, the source and sitemap Parameters used to process the request.
 
Methods inherited from class net.sourceforge.chaperon.process.LexicalProcessor
characters, comment, endCDATA, endDocument, endDTD, endElement, endEntity, endPrefixMapping, handleEndDocument, ignorableWhitespace, processingInstruction, setContentHandler, setDocumentLocator, setGrouping, setLexicalAutomaton, setLexicalHandler, setLocalizable, setLog, skippedEntity, startCDATA, startDocument, startDTD, startElement, startEntity, startPrefixMapping
 
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
 

Constructor Detail

LexicalTransformer

public LexicalTransformer()
Method Detail

enableLogging

public void enableLogging(org.apache.avalon.framework.logger.Logger logger)
Provide component with a logger.

Specified by:
enableLogging in interface org.apache.avalon.framework.logger.LogEnabled
Parameters:
logger - the logger

service

public void service(org.apache.avalon.framework.service.ServiceManager manager)
Pass the ServiceManager to the service. The Serviceable implementation should use the specified ServiceManager to acquire the components it needs for execution.

Specified by:
service in interface org.apache.avalon.framework.service.Serviceable
Parameters:
manager - The ServiceManager which this Composable uses.

parameterize

public void parameterize(org.apache.avalon.framework.parameters.Parameters parameters)
                  throws org.apache.avalon.framework.parameters.ParameterException
Provide component with parameters.

Specified by:
parameterize in interface org.apache.avalon.framework.parameters.Parameterizable
Parameters:
parameters - the parameters
Throws:
org.apache.avalon.framework.parameters.ParameterException - if parameters are invalid

setConsumer

public void setConsumer(org.apache.cocoon.xml.XMLConsumer consumer)
Set the XMLConsumer that will receive XML data.

Specified by:
setConsumer in interface org.apache.cocoon.xml.XMLProducer
Parameters:
consumer -

setup

public void setup(org.apache.cocoon.environment.SourceResolver resolver,
                  java.util.Map objectmodel,
                  java.lang.String src,
                  org.apache.avalon.framework.parameters.Parameters parameters)
           throws org.apache.cocoon.ProcessingException,
                  org.xml.sax.SAXException,
                  java.io.IOException
Set the SourceResolver, objectModel Map, the source and sitemap Parameters used to process the request.

Specified by:
setup in interface org.apache.cocoon.sitemap.SitemapModelComponent
Parameters:
resolver - Source resolver
objectmodel - Object model
src - Source
parameters - Parameters
Throws:
java.io.IOException
org.apache.cocoon.ProcessingException
org.xml.sax.SAXException

getKey

public java.io.Serializable getKey()
Generate the unique key. This key must be unique inside the space of this component.

Specified by:
getKey in interface org.apache.cocoon.caching.CacheableProcessingComponent
Returns:
The generated key hashes the src

getValidity

public org.apache.excalibur.source.SourceValidity getValidity()
Generate the validity object.

Specified by:
getValidity in interface org.apache.cocoon.caching.CacheableProcessingComponent
Returns:
The generated validity object or null if the component is currently not cacheable.

recycle

public void recycle()
Recycle this component. All instance variables are set to null.

Specified by:
recycle in interface org.apache.avalon.excalibur.pool.Recyclable

dispose

public void dispose()
The dispose operation is called at the end of a components lifecycle.

Specified by:
dispose in interface org.apache.avalon.framework.activity.Disposable


Copyright ? 2003 Chaperon project. All Rights Reserved.