org.jboss.portal.search
Interface SearchFederated

All Known Implementing Classes:

CMSFederatedSearch, DummySearchFederated, GenericSearchFederated, LuceneSearchFederated, LuceneSearchFederated, TestLuceneSearchFederated

public interface SearchFederated

Version:

$Revision$

Author:

Thomas Heute

Nested Class Summary

static interface

SearchFederated.MarkupLevel

Method Summary

void	create() The create method should index the required components
void	destroy() Method called when this federated search is not used anymore.
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.lang.String	getMarkup(ResultSet results, int markupLevel) TODO: Subject to change...
java.lang.String	getName(java.util.Locale locale) Get a localized name for this federated search
ResultSet	search(Query query) From the query object this method is responsible to return the results of the query

Method Detail

getId

java.lang.String getId()

Get the ID for this federated search

Returns:

String representing this particular federated search

getName

java.lang.String getName(java.util.Locale locale)

Get a localized name for this federated search

Returns:

String

destroy

void destroy()
             throws IndexingException

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

Throws:

IndexingException

create

void create()
            throws IndexingException

The create method should index the required components

Throws:

IndexingException

getInfo

Info getInfo()

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

Returns:

search

ResultSet search(Query query)

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

Parameters:

query -

Returns:

getMarkup

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

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.

Parameters:

results -

markupLevel -

Returns: