org.semanticdesktop.aperture.detector
Interface DataSourceDetector

All Known Implementing Classes:

HomeFolderDetector, OutlookDataSourceDetector, ThunderbirdAddressbookDetector

public interface DataSourceDetector

Detects a possible datasource on the desktop of the currently logged in user. Returns the detected datasource(s) using the DataSourceDescription class. Intended to be used by Desktop search engines to propose possible datasources that users can index.

Since:

1.1.1

Author:

sauermann, 2.7.2008 based on work by gunnar grimnes

Method Summary

List<DataSourceDescription>	detect() Detect one or more datasources. returns an empty list if nothing detected
URI	getSupportedType() Returns the URI of the supported DataSource type.

Method Detail

getSupportedType

URI getSupportedType()

Returns the URI of the supported DataSource type.

See Also:

DataSourceFactory.getSupportedType()

detect

List<DataSourceDescription> detect()
                                   throws Exception

Detect one or more datasources. returns an empty list if nothing detected

Returns:

a list of detected datasources. May be empty, but never null

Throws:

Exception - if there is a severe problem when detecting the datasource. The method will only throw an Exception, if it can usually detect a datasource, but is not able to detect it due to a faulty environment. For example, if the operating system is Apple, but the Address book was removed, or if Microsoft Outlook is detected, but in a version that is unknown. Error messages must be readable by the end-user and give hints how to add the datasource by hand or how to fix the problem.