uk.ac.ebi.intact.application.commons.search
Interface SearchHelperI

All Known Implementing Classes:

SearchHelper

public interface SearchHelperI

Interface describing how to search data in IntAct.

Version:

$Id: SearchHelperI.java,v 1.2 2004/03/19 12:04:40 smudali Exp $

Author:

Samuel Kerrien (skerrien@ebi.ac.uk)

Method Summary

java.util.Collection	doLookup(java.util.List searchClasses, java.lang.String value, IntactUserI user) Search in the IntAct data for a colleciton of object (type=searchClass).
java.util.Collection	doLookup(java.lang.String searchClass, java.lang.String value, IntactUserI user) Search in the IntAct data for a colleciton of object (type=searchClass).
java.util.Collection	doLookupSimple(java.lang.String searchClass, java.lang.String query, IntactUserI user) Peforms a simple search in the IntAct data for given search class and value.
java.util.Collection	getSearchCritera() Return a collection of search criteria.

Method Detail

doLookupSimple

public java.util.Collection doLookupSimple(java.lang.String searchClass,
                                           java.lang.String query,
                                           IntactUserI user)
                                    throws IntactException

Peforms a simple search in the IntAct data for given search class and value. This search is limited to AC and short label fields.

Parameters:

searchClass - the search class to perform the search on (e.g., Experiment)

query - the search query; doesn't support mupltiple comma separated values.

user - the user to invoke search on.

Returns:

a collection of Intact objects of same class as searchClass or an empty collection if none found.

Throws:

IntactException - for any errors in searching the persistent system.

doLookup

public java.util.Collection doLookup(java.lang.String searchClass,
                                     java.lang.String value,
                                     IntactUserI user)
                              throws IntactException

Search in the IntAct data for a colleciton of object (type=searchClass). The objects found must match with the value given by the user (ac, shortlabel ...).

Parameters:

searchClass - the search class we are looking for in the IntAct data.

value - the queryString for which the objects should match.

user - the IntAct datasource.

Returns:

A collection of Intact objects of the type searchClass.

Throws:

IntactException - if an erro occurs when searching in the database.

doLookup

public java.util.Collection doLookup(java.util.List searchClasses,
                                     java.lang.String value,
                                     IntactUserI user)
                              throws IntactException

Search in the IntAct data for a colleciton of object (type=searchClass). The objects found must match with the value given by the user (ac, shortlabel ...).

Parameters:

searchClasses - the search classes (ordered by preference) we are looking for in the IntAct data.

value - the queryString for which the objects should match.

user - the IntAct datasource.

Returns:

A collection of Intact objects of the type searchClass.

Throws:

IntactException - if an erro occurs when searching in the database.

getSearchCritera

public java.util.Collection getSearchCritera()

Return a collection of search criteria.

Returns:

a Collection of CriteriaBean.