org.apache.cocoon.transformation
Class LuceneIndexTransformer2

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.xml.AbstractXMLProducer
          org.apache.cocoon.xml.AbstractXMLPipe
              org.apache.cocoon.transformation.AbstractTransformer
                  org.apache.cocoon.transformation.LuceneIndexTransformer2

All Implemented Interfaces:

org.apache.avalon.excalibur.pool.Poolable, org.apache.avalon.excalibur.pool.Recyclable, org.apache.avalon.framework.component.Component, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.logger.LogEnabled, org.apache.avalon.framework.service.Serviceable, 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 LuceneIndexTransformer2
extends org.apache.cocoon.transformation.AbstractTransformer
implements org.apache.avalon.excalibur.pool.Recyclable, org.apache.avalon.framework.service.Serviceable, org.apache.avalon.framework.configuration.Configurable

Another lucene index transformer.
allow

• index function (update indexing or add indexing if clear attribute is true)
• lucene field boosting
• delete function

This tranformer used several avalon components, but you can use them separatly :

• AnalyzerManager: you can setup a analyzer (configurable) in the analyzer_manager tag in cocoon.xconf file
• IndexManager: you can setup a index in a the /WEB-INF/index.xml (default location , but you can specify the location in the IndexManager component configuration in cocoon.xconf file)
• Indexer (2 implementations: default (with update optimization) and parallel implementation for multiple cpu)

Example of input source:

• to Index
  <lucene:index xmlns:lucene="http://apache.org/cocoon/lucene/1.0"
  indexid="myindex"
  clear="true" (optinal attribute: clear index)
  merge-factor="100"> (optinal attribute: see lucene doc)
  
  <lucene:document uid="http://myhost/myfile1.data">
  <lucene:field name="tile" > sqdqsdq </lucene:field>
  <lucene:field name="description" > a text bla bal blalael balbal</lucene:field>
  <lucene:field name="date" >10/12/2002</lucene:field>
  </lucene:document>
  

  <lucene:document uid="http://myhost/myfile2.data" >
  <lucene:field name="author" boost="2" >Mr Author </lucene:field> (boost the field for the search (see Lucene documentation))
  <lucene:field name="langage" >french</lucene:field>
  </lucene:document>
  < /lucene:index>

• To delete
  

  <lucene:delete indexid="myindex" >
  <lucene:document uid="http://myhost/myfile.data" >
  <lucene:document uid="EODOED-EFE"
  </lucene:delete>

  Example of Output Source

  <page xmlns:lucene="http://apache.org/cocoon/lucene/1.0">
  < lucene:index >
  <lucene:document uid="http://myhost/myfile1.data"/>
  <lucene:document uid="http://myhost/myfile2.data"/>
  </lucene:index>

  <lucene:delete > <lucene:document uid="http://myhost/myfile1.data"/>
  <lucene:document uid="EODOED-EFE"/>
  </lucene:delete >
  

Author:

Nicolas Maisonneuve

Field Summary

static int	DELETE_PROCESS
static int	DELETING_PROCESS
static java.lang.String	DIRECTORY_DEFAULT
static int	IN_DOCUMENT_PROCESS
static int	IN_FIELD_PROCESS
static int	INDEX_PROCESS
static java.lang.String	LUCENE_DELETING_ELEMENT action element: delete doc
static java.lang.String	LUCENE_DOCUMENT_ELEMENT Lucene document element
static java.lang.String	LUCENE_DOCUMENT_UID_ATTRIBUTE Lucene document uid field
static java.lang.String	LUCENE_FIELD_BOOST_ATTRIBUTE Optional attribute: lucene field boost (see lucene docs)
static java.lang.String	LUCENE_FIELD_ELEMENT lucene field element
static java.lang.String	LUCENE_FIELD_NAME_ATTRIBUTE lucene field name
static java.lang.String	LUCENE_INDEXING_ANALYZER_ATTRIBUTE Optional attribute: Analyzer identity: see analyzerManager Component (default: the analyer of the index declared in the index definition)
static java.lang.String	LUCENE_INDEXING_CREATE_ATTRIBUTE Optional attribute: Clear index: true/false (default: false)
static java.lang.String	LUCENE_INDEXING_ELEMENT action element : index doc
static java.lang.String	LUCENE_INDEXING_INDEXID_ATTRIBUTE index identity (see index definition file)
static java.lang.String	LUCENE_INDEXING_MERGE_FACTOR_ATTRIBUTE Optional attribute: MergeFactor number (default 10): improve the indexing speed for large indexing (see Lucene docs)
static java.lang.String	LUCENE_PREXIF
static java.lang.String	LUCENE_URI
static int	NO_PROCESSING

Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.transformation.Transformer

ROLE

Constructor Summary

LuceneIndexTransformer2()


Method Summary

protected boolean	canIndex()
void	characters(char[] ch, int start, int length)
void	configure(org.apache.avalon.framework.configuration.Configuration config)
void	endDocument()
void	endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName)
void	endPrefixMapping(java.lang.String prefix) End the scope of a prefix-URI mapping.
protected java.lang.String	getExceptionMessage(java.lang.Exception ex)
void	recycle()
void	service(org.apache.avalon.framework.service.ServiceManager manager)
void	setup(org.apache.cocoon.environment.SourceResolver resolver, java.util.Map objectModel, java.lang.String src, org.apache.avalon.framework.parameters.Parameters parameters) Setup the transformer.
void	startDocument()
void	startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri) Begin the scope of a prefix-URI Namespace mapping.

Methods inherited from class org.apache.cocoon.xml.AbstractXMLPipe

comment, endCDATA, endDTD, endEntity, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startCDATA, startDTD, startEntity

Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer

setConsumer, setContentHandler, setLexicalHandler

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, 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

ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity

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

DIRECTORY_DEFAULT

public static final java.lang.String DIRECTORY_DEFAULT

See Also:

Constant Field Values

LUCENE_URI

public static final java.lang.String LUCENE_URI

See Also:

Constant Field Values

LUCENE_PREXIF

public static final java.lang.String LUCENE_PREXIF

See Also:

Constant Field Values

LUCENE_INDEXING_ELEMENT

public static final java.lang.String LUCENE_INDEXING_ELEMENT

action element : index doc

See Also:

Constant Field Values

LUCENE_DELETING_ELEMENT

public static final java.lang.String LUCENE_DELETING_ELEMENT

action element: delete doc

See Also:

Constant Field Values

LUCENE_INDEXING_INDEXID_ATTRIBUTE

public static final java.lang.String LUCENE_INDEXING_INDEXID_ATTRIBUTE

index identity (see index definition file)

See Also:

Constant Field Values

LUCENE_INDEXING_CREATE_ATTRIBUTE

public static final java.lang.String LUCENE_INDEXING_CREATE_ATTRIBUTE

Optional attribute: Clear index: true/false (default: false)

See Also:

Constant Field Values

LUCENE_INDEXING_ANALYZER_ATTRIBUTE

public static final java.lang.String LUCENE_INDEXING_ANALYZER_ATTRIBUTE

Optional attribute: Analyzer identity: see analyzerManager Component (default: the analyer of the index declared in the index definition)

See Also:

Constant Field Values

LUCENE_INDEXING_MERGE_FACTOR_ATTRIBUTE

public static final java.lang.String LUCENE_INDEXING_MERGE_FACTOR_ATTRIBUTE

Optional attribute: MergeFactor number (default 10): improve the indexing speed for large indexing (see Lucene docs)

See Also:

Constant Field Values

LUCENE_DOCUMENT_ELEMENT

public static final java.lang.String LUCENE_DOCUMENT_ELEMENT

Lucene document element

See Also:

Constant Field Values

LUCENE_DOCUMENT_UID_ATTRIBUTE

public static final java.lang.String LUCENE_DOCUMENT_UID_ATTRIBUTE

Lucene document uid field

See Also:

Constant Field Values

LUCENE_FIELD_ELEMENT

public static final java.lang.String LUCENE_FIELD_ELEMENT

lucene field element

See Also:

Constant Field Values

LUCENE_FIELD_NAME_ATTRIBUTE

public static final java.lang.String LUCENE_FIELD_NAME_ATTRIBUTE

lucene field name

See Also:

Constant Field Values

LUCENE_FIELD_BOOST_ATTRIBUTE

public static final java.lang.String LUCENE_FIELD_BOOST_ATTRIBUTE

Optional attribute: lucene field boost (see lucene docs)

See Also:

Constant Field Values

NO_PROCESSING

public static final int NO_PROCESSING

See Also:

Constant Field Values

INDEX_PROCESS

public static final int INDEX_PROCESS

See Also:

Constant Field Values

IN_DOCUMENT_PROCESS

public static final int IN_DOCUMENT_PROCESS

See Also:

Constant Field Values

IN_FIELD_PROCESS

public static final int IN_FIELD_PROCESS

See Also:

Constant Field Values

DELETE_PROCESS

public static final int DELETE_PROCESS

See Also:

Constant Field Values

DELETING_PROCESS

public static final int DELETING_PROCESS

See Also:

Constant Field Values

Constructor Detail

LuceneIndexTransformer2

public LuceneIndexTransformer2()

Method Detail

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

Setup the transformer.

Specified by:

setup in interface org.apache.cocoon.sitemap.SitemapModelComponent

Throws:

org.apache.cocoon.ProcessingException

org.xml.sax.SAXException

java.io.IOException

recycle

public void recycle()

Specified by:

recycle in interface org.apache.avalon.excalibur.pool.Recyclable

Overrides:

recycle in class org.apache.cocoon.xml.AbstractXMLProducer

service

public void service(org.apache.avalon.framework.service.ServiceManager manager)
             throws org.apache.avalon.framework.service.ServiceException

Specified by:

service in interface org.apache.avalon.framework.service.Serviceable

Throws:

org.apache.avalon.framework.service.ServiceException

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Overrides:

startDocument in class org.apache.cocoon.xml.AbstractXMLPipe

Throws:

org.xml.sax.SAXException

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Overrides:

endDocument in class org.apache.cocoon.xml.AbstractXMLPipe

Throws:

org.xml.sax.SAXException

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String uri)
                        throws org.xml.sax.SAXException

Begin the scope of a prefix-URI Namespace mapping.

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

Overrides:

startPrefixMapping in class org.apache.cocoon.xml.AbstractXMLPipe

Parameters:

prefix - The Namespace prefix being declared.

uri - The Namespace URI the prefix is mapped to.

Throws:

org.xml.sax.SAXException

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)
                      throws org.xml.sax.SAXException

End the scope of a prefix-URI mapping.

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

Overrides:

endPrefixMapping in class org.apache.cocoon.xml.AbstractXMLPipe

Parameters:

prefix - The prefix that was being mapping.

Throws:

org.xml.sax.SAXException

startElement

public void startElement(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes atts)
                  throws org.xml.sax.SAXException

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class org.apache.cocoon.xml.AbstractXMLPipe

Throws:

org.xml.sax.SAXException

endElement

public void endElement(java.lang.String namespaceURI,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

endElement in class org.apache.cocoon.xml.AbstractXMLPipe

Throws:

org.xml.sax.SAXException

canIndex

protected boolean canIndex()

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException

Specified by:

characters in interface org.xml.sax.ContentHandler

Overrides:

characters in class org.apache.cocoon.xml.AbstractXMLPipe

Throws:

org.xml.sax.SAXException

getExceptionMessage

protected java.lang.String getExceptionMessage(java.lang.Exception ex)
                                        throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

configure

public void configure(org.apache.avalon.framework.configuration.Configuration config)
               throws org.apache.avalon.framework.configuration.ConfigurationException

Specified by:

configure in interface org.apache.avalon.framework.configuration.Configurable

Throws:

org.apache.avalon.framework.configuration.ConfigurationException