org.bridgedb
Interface IDMapperCapabilities

All Known Implementing Classes:

AbstractIDMapperCapabilities

public interface IDMapperCapabilities

Describes capabilities of an IDMapper. Free form key-value properties are used for version info etc.

Method Summary

java.util.Set<java.lang.String>	getKeys()
java.lang.String	getProperty(java.lang.String key) Return a value for a property, or null if this property is not defined.
java.util.Set<DataSource>	getSupportedSrcDataSources()
java.util.Set<DataSource>	getSupportedTgtDataSources()
boolean	isFreeSearchSupported()
boolean	isMappingSupported(DataSource src, DataSource tgt)

Method Detail

isFreeSearchSupported

boolean isFreeSearchSupported()

Returns:

true if free text search is supported, false otherwise.

getSupportedSrcDataSources

java.util.Set<DataSource> getSupportedSrcDataSources()
                                                     throws IDMapperException

Returns:

supported source ID types

Throws:

IDMapperException - if supported DataSources could not be determined because of service unavailability.

getSupportedTgtDataSources

java.util.Set<DataSource> getSupportedTgtDataSources()
                                                     throws IDMapperException

Returns:

supported target ID types

Throws:

IDMapperException - if supported DataSources could not be determined because of service unavailability.

isMappingSupported

boolean isMappingSupported(DataSource src,
                           DataSource tgt)
                           throws IDMapperException

Parameters:

src - source data source

tgt - target data source

Returns:

true if mapping is supported from src to des

Throws:

IDMapperException - if service is unavailable

getProperty

java.lang.String getProperty(java.lang.String key)

Return a value for a property, or null if this property is not defined. Implementations are free to choose a set of properties. Suggested properties:

• Version
• DateCreated
• SourceDatabase
• SourceDatabaseVersion
• Species

Parameters:

key - key

Returns:

property string

getKeys

java.util.Set<java.lang.String> getKeys()

Returns:

the keys of all properties. Implementations may return an empty set but never null.