Package ch.systemsx.cisd.openbis.dss.generic.server.api.v2.sequencedatabases

Class EchoDatabase

java.lang.Object

ch.systemsx.cisd.openbis.dss.generic.server.api.v2.sequencedatabases.AbstractSearchDomainService

ch.systemsx.cisd.openbis.dss.generic.server.api.v2.sequencedatabases.EchoDatabase

All Implemented Interfaces:

ISearchDomainService

public class EchoDatabase
extends AbstractSearchDomainService

A test database that returns a search result that was stored in the parameters map under a key equal to the searched sequence snippet.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EchoDatabase.HelperBean

Field Summary

Fields

Modifier and Type	Field	Description
static org.apache.log4j.Logger	operationLog

Fields inherited from class ch.systemsx.cisd.openbis.dss.generic.server.api.v2.sequencedatabases.AbstractSearchDomainService

name

Constructor Summary

Constructors

Constructor	Description
EchoDatabase(java.util.Properties properties, java.io.File storeRoot)

Method Summary

Modifier and Type	Method	Description
java.util.List<SearchDomainSearchOption>	getPossibleSearchOptions()	Returns all possible search options.
java.lang.String	getPossibleSearchOptionsKey()	Returns the key used in optionalParametersOrNull if this service supports different SearchDomainSearchOptions.
boolean	isAvailable()	Returns true if this service is available.
java.util.List<SearchDomainSearchResult>	search(java.lang.String sequenceSnippet, java.util.Map<java.lang.String,java.lang.String> optionalParametersOrNull)	Searches this service for the specified search string.

Methods inherited from class ch.systemsx.cisd.openbis.dss.generic.server.api.v2.sequencedatabases.AbstractSearchDomainService

getLabel, setName

Methods inherited from class java.lang.Object

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

Field Detail

operationLog

public static final org.apache.log4j.Logger operationLog

Constructor Detail

EchoDatabase

public EchoDatabase(java.util.Properties properties,
                    java.io.File storeRoot)

Method Detail

isAvailable

public boolean isAvailable()

Description copied from interface: ISearchDomainService

Returns true if this service is available. For example, a local BLAST sequence search service is available if the external BLAST tools are available.

getPossibleSearchOptionsKey

public java.lang.String getPossibleSearchOptionsKey()

Description copied from interface: ISearchDomainService

Returns the key used in optionalParametersOrNull if this service supports different SearchDomainSearchOptions.

Specified by:

getPossibleSearchOptionsKey in interface ISearchDomainService

Overrides:

getPossibleSearchOptionsKey in class AbstractSearchDomainService

Returns:

null if no such options supported.

getPossibleSearchOptions

public java.util.List<SearchDomainSearchOption> getPossibleSearchOptions()

Description copied from interface: ISearchDomainService

Returns all possible search options. The first option is the default option.

Specified by:

getPossibleSearchOptions in interface ISearchDomainService

Overrides:

getPossibleSearchOptions in class AbstractSearchDomainService

Returns:

an empty list if ISearchDomainService.getPossibleSearchOptionsKey() return null.

search

public java.util.List<SearchDomainSearchResult> search(java.lang.String sequenceSnippet,
                                                       java.util.Map<java.lang.String,java.lang.String> optionalParametersOrNull)

Description copied from interface: ISearchDomainService

Searches this service for the specified search string.

optionalParametersOrNull - Optional parameters which might be used. Can be null.

Returns:

an empty list if nothing be found.