java.fedora.server.search.FieldSearch Maven / Gradle / Ivy
Show all versions of fcrepo-client Show documentation
/*
* -----------------------------------------------------------------------------
*
* License and Copyright: The contents of this file are subject to the
* Apache License, Version 2.0 (the "License"); you may not use
* this file except in compliance with the License. You may obtain a copy of
* the License at
* http://www.fedora-commons.org/licenses.
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
* the specific language governing rights and limitations under the License.
*
* The entire file consists of original code.
* Copyright © 2008 Fedora Commons, Inc.
*
Copyright © 2002-2007 The Rector and Visitors of the University of
* Virginia and Cornell University
* All rights reserved.
*
* -----------------------------------------------------------------------------
*/
package fedora.server.search;
import fedora.server.errors.ServerException;
import fedora.server.storage.DOReader;
/**
*
* Title: FieldSearch.java
* Description: A provider of a simple field-based search service
* across all objects in the repository
*
* Key object metadata and dublin core fields are searchable from via
* implementations of this interface.
*
* Key fields include:
* pid, label, cModel, state, ownerId, cDate, mDate, dcmDate
*
* Dublin core fields include:
* title, creator, subject, description, publisher, contributor, date, type,
* format, identifier, source, language, relation, coverage, rights
*
*
* @author [email protected]
* @version $Id: FieldSearch.java 3966 2005-04-21 13:33:01Z rlw $
*/
public interface FieldSearch {
/**
* Update the search indexes with information from the provided DOReader.
*
* @param reader the DOReader containing all the field information
* for the object
* @throws ServerException if anything went wrong
*/
public void update(DOReader reader)
throws ServerException;
/**
* Remove an object from the search indexes.
*
* @param pid the unique id of the object whose info should be removed
* @return true if object successfully removed; false otherwise.
* @throws ServerException if anything went wrong
*/
public boolean delete(String pid)
throws ServerException;
/**
* Search across specific fields and return the desired fields.
*
* @param resultFields the desired fields
* @param maxResults the maximum number of results the client wants
* @param query the query
* @return FieldSearchResult the results
* @throws ServerException if anything went wrong
*/
public FieldSearchResult findObjects(String[] resultFields,
int maxResults, FieldSearchQuery query)
throws ServerException;
/**
* Resume an in-progress search across specific fields and return the
* desired fields.
*
* @param sessionToken the token of the session in which the remaining
* results can be found
* @return FieldSearchResult the results
* @throws ServerException if anything went wrong
*/
public FieldSearchResult resumeFindObjects(String sessionToken)
throws ServerException;
}