org.jboss.portal.search.federated.lucene
Class LuceneSearchFederated

java.lang.Object
  org.jboss.portal.search.federated.lucene.LuceneSearchFederated

All Implemented Interfaces:

SearchFederated

Direct Known Subclasses:

TestLuceneSearchFederated

public abstract class LuceneSearchFederated
extends java.lang.Object
implements SearchFederated

Version:

$Revision$

Author:

Thomas Heute

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.portal.search.SearchFederated

SearchFederated.MarkupLevel

Constructor Summary

LuceneSearchFederated(java.lang.String id, java.lang.String indexPath, java.lang.String defaultField)

Method Summary

void	create() The create method should index the required components
void	destroy() Method called when this federated search is not used anymore.
abstract java.util.List	getDocuments() List of GenericDocument
java.lang.String	getId() Get the ID for this federated search
Info	getInfo() Info should return information on the current status if the federated search
java.util.List	getLuceneDocuments()
java.lang.String	getMarkup(ResultSet results, int markupLevel) TODO: Subject to change...
ResultSet	search(Query query) From the query object this method is responsible to return the results of the query

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jboss.portal.search.SearchFederated

getName

Constructor Detail

LuceneSearchFederated

public LuceneSearchFederated(java.lang.String id,
                             java.lang.String indexPath,
                             java.lang.String defaultField)

Method Detail

create

public void create()
            throws IndexingException

Description copied from interface: SearchFederated

The create method should index the required components

Specified by:

create in interface SearchFederated

Throws:

IndexingException

getLuceneDocuments

public java.util.List getLuceneDocuments()

getDocuments

public abstract java.util.List getDocuments()

List of GenericDocument

Returns:

destroy

public void destroy()

Description copied from interface: SearchFederated

Method called when this federated search is not used anymore. This could be the place to destry any index

Specified by:

destroy in interface SearchFederated

getId

public java.lang.String getId()

Description copied from interface: SearchFederated

Get the ID for this federated search

Specified by:

getId in interface SearchFederated

Returns:

String representing this particular federated search

getInfo

public Info getInfo()

Description copied from interface: SearchFederated

Info should return information on the current status if the federated search

Specified by:

getInfo in interface SearchFederated

Returns:

search

public ResultSet search(Query query)

Description copied from interface: SearchFederated

From the query object this method is responsible to return the results of the query

Specified by:

search in interface SearchFederated

Returns:

getMarkup

public java.lang.String getMarkup(ResultSet results,
                                  int markupLevel)

Description copied from interface: SearchFederated

TODO: Subject to change... get the markup fragment for this federated search. A markup level is used to define different amount of information to provide.

Specified by:

getMarkup in interface SearchFederated

Returns: