org.jboss.portal.cms.search
Class CMSFederatedSearch

java.lang.Object
  org.jboss.portal.search.impl.GenericSearchFederated
      org.jboss.portal.cms.search.CMSFederatedSearch

All Implemented Interfaces:

SearchFederated

public class CMSFederatedSearch
extends GenericSearchFederated

Version:

$Revision$

Author:

Thomas Heute

Nested Class Summary

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

SearchFederated.MarkupLevel

Constructor Summary

CMSFederatedSearch(java.lang.String id)

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...
ResultSet	search(Query query) From the query object this method is responsible to return the results of the query
void	setCMS(CMS cms)

Methods inherited from class org.jboss.portal.search.impl.GenericSearchFederated

getName

Methods inherited from class java.lang.Object

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

Constructor Detail

CMSFederatedSearch

public CMSFederatedSearch(java.lang.String id)

Method Detail

setCMS

public void setCMS(CMS cms)

create

public void create()
            throws IndexingException

Description copied from interface: SearchFederated

The create method should index the required components

Throws:

IndexingException

destroy

public void destroy()
             throws IndexingException

Description copied from interface: SearchFederated

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

Throws:

IndexingException

getInfo

public Info getInfo()

Description copied from interface: SearchFederated

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

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.

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

Returns:

getId

public java.lang.String getId()

Description copied from interface: SearchFederated

Get the ID for this federated search

Returns:

String representing this particular federated search