| org.apache.cocoon.components.search.LuceneXMLIndexer
All known Subclasses: org.apache.cocoon.components.search.SimpleLuceneXMLIndexerImpl,
| LuceneXMLIndexer | | public interface LuceneXMLIndexer extends Component(Code) | | The avalon behavioural component interface of generating
lucene documents from an xml content.
The well-known fields of a lucene documents are defined as
*_FIELD constants.
You may access generated lucene documents via
allDocuments(), or iterator().
You trigger the generating of lucene documents via
build().
author:
Bernhard Huber
version:
CVS $Id: LuceneXMLIndexer.java 433543 2006-08-22 06:22:54Z crossley $ |
| Field Summary | |
| String | BODY_FIELD
A Lucene document field name, containing xml content text of all xml elements. | | String | ROLE
The ROLE name of this avalon component.
Its value if the FQN of this interface,
ie. | | String | UID_FIELD
A Lucene document field name, containg the a unique key of the indexed
document. | | String | URL_FIELD
A Lucene document field name, containg the URI/URL of the indexed
document. |
| Method Summary | |
| List | build(URL url)
Build lucene documents from a URL.
This method will read the content of the URL, and generates
one or more lucene documents. |
| BODY_FIELD | | String BODY_FIELD(Code) | | A Lucene document field name, containing xml content text of all xml elements.
A concrete implementation of this interface SHOULD
provides a field named body.
A concrete implementation MAY provide additional lucene
document fields.
|
| ROLE | | String ROLE(Code) | | The ROLE name of this avalon component.
Its value if the FQN of this interface,
ie. org.apache.cocoon.components.search.LuceneXMLIndexer.
|
| UID_FIELD | | String UID_FIELD(Code) | | A Lucene document field name, containg the a unique key of the indexed
document.
This document field is used internally to track document
changes, and updates.
A concrete implementation of this interface SHOULD
provide a field named uid.
|
| URL_FIELD | | String URL_FIELD(Code) | | A Lucene document field name, containg the URI/URL of the indexed
document.
A concrete implementation of this interface SHOULD
provide a field named url.
|
| build | | List build(URL url) throws ProcessingException(Code) | | Build lucene documents from a URL.
This method will read the content of the URL, and generates
one or more lucene documents. The generated lucence documents
can be fetched using methods allDocuments(), and iterator().
Parameters:
url - the content of this url gets indexed.
exception:
ProcessingException - Description of Exception |
|
|