fedora.server.search
Class FieldSearchSQLModule

java.lang.Object
  fedora.server.Parameterized
      fedora.server.Pluggable
          fedora.server.Module
              fedora.server.search.FieldSearchSQLModule

All Implemented Interfaces:

Constants, FieldSearch

public class FieldSearchSQLModule
extends Module
implements FieldSearch

Module that wraps FieldSearchSQLImpl.

Version:

$Id: FieldSearchSQLModule.java 5261 2006-12-01 05:57:11Z cwilper $

Author:

cwilper@cs.cornell.edu

Nested Class Summary

Nested classes/interfaces inherited from interface fedora.common.Constants

Constants.FedoraHome

Field Summary

Fields inherited from interface fedora.common.Constants

ACTION, BDEF, BMECH, DATASTREAM, DC, DISSEMINATOR, ENVIRONMENT, FEDORA, FEDORA_HOME, FEDORA_SYSTEM_DEF_PID, FEDORA_SYSTEM_DEF_URI, HTTP_REQUEST, MODEL, OBJECT, RDF, RECOVERY, RELS_EXT, RESOURCE, SUBJECT, TUCANA, VIEW, XSD

Constructor Summary

FieldSearchSQLModule(java.util.Map params, Server server, java.lang.String role)

Method Summary

boolean	delete(java.lang.String pid) Remove an object from the search indexes.
FieldSearchResult	findObjects(java.lang.String[] resultFields, int maxResults, FieldSearchQuery query) Search across specific fields and return the desired fields.
java.lang.String[]	getRequiredModuleRoles() Gets the names of the roles that are required by this Pluggable.
void	postInitModule() Second stage of Module initialization.
FieldSearchResult	resumeFindObjects(java.lang.String sessionToken) Resume an in-progress search across specific fields and return the desired fields.
void	update(DOReader reader) Update the search indexes with information from the provided DOReader.

Methods inherited from class fedora.server.Module

getRole, getServer, initModule, shutdownModule

Methods inherited from class fedora.server.Pluggable

getHelp, getOptionalParameters, getParameterHelp, getRequiredParameters

Methods inherited from class fedora.server.Parameterized

getParameter, getParameter, getParameters, parameterNames, setParameter, setParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldSearchSQLModule

public FieldSearchSQLModule(java.util.Map params,
                            Server server,
                            java.lang.String role)
                     throws ModuleInitializationException

Throws:

ModuleInitializationException

Method Detail

postInitModule

public void postInitModule()
                    throws ModuleInitializationException

Description copied from class: Module

Second stage of Module initialization. This is guaranteed to run after all Module's initModule() methods have run.

Overrides:

postInitModule in class Module

Throws:

ModuleInitializationException - If initialization values are invalid or initialization fails for some other reason.

getRequiredModuleRoles

public java.lang.String[] getRequiredModuleRoles()

Description copied from class: Pluggable

Gets the names of the roles that are required by this Pluggable.

By default, no roles need to be fulfilled.

Overrides:

getRequiredModuleRoles in class Pluggable

Returns:

The roles.

update

public void update(DOReader reader)
            throws ServerException

Description copied from interface: FieldSearch

Update the search indexes with information from the provided DOReader.

Specified by:

update in interface FieldSearch

Parameters:

reader - the DOReader containing all the field information for the object

Throws:

ServerException - if anything went wrong

delete

public boolean delete(java.lang.String pid)
               throws ServerException

Description copied from interface: FieldSearch

Remove an object from the search indexes.

Specified by:

delete in interface FieldSearch

Parameters:

pid - the unique id of the object whose info should be removed

Returns:

true if object successfully removed; false otherwise.

Throws:

ServerException - if anything went wrong

findObjects

public FieldSearchResult findObjects(java.lang.String[] resultFields,
                                     int maxResults,
                                     FieldSearchQuery query)
                              throws ServerException

Description copied from interface: FieldSearch

Search across specific fields and return the desired fields.

Specified by:

findObjects in interface FieldSearch

Parameters:

resultFields - the desired fields

maxResults - the maximum number of results the client wants

query - the query

Returns:

FieldSearchResult the results

Throws:

ServerException - if anything went wrong

resumeFindObjects

public FieldSearchResult resumeFindObjects(java.lang.String sessionToken)
                                    throws ServerException

Description copied from interface: FieldSearch

Resume an in-progress search across specific fields and return the desired fields.

Specified by:

resumeFindObjects in interface FieldSearch

Parameters:

sessionToken - the token of the session in which the remaining results can be found

Returns:

FieldSearchResult the results

Throws:

ServerException - if anything went wrong