org.semanticdesktop.aperture.datasource
Interface DataSource

All Known Implementing Classes:

BibsonomyDataSource, DataSourceBase, DeliciousDataSource, DomainBoundableDataSource, FileSystemDataSource, FlickrDataSource, IcalDataSource, ImapDataSource, MboxDataSource, OutlookDataSource, SambaDataSource, ThunderbirdAddressbookDataSource, WebDataSource

public interface DataSource

A DataSource defines the characteristics of a source from which DataObjects can be extracted. A Datasource contains all information necessary to realize these objects, such as paths, usernames, passwords, etc.

Method Summary

void	dispose() Disposes this DataSource.
RDFContainer	getConfiguration() Gets the RDF model containing the configuration of this DataSource.
URI	getID() Gets the id of this data source.
String	getName() Gets the name of this data source.
URI	getType() Returns a URI that indicates the DataSource type in a platform- and programming language-independent way.
void	setConfiguration(RDFContainer configuration) Sets the RDF model containing the configuration of this DataSource.
void	setName(String name) Sets the name of this data source.

Method Detail

getID

URI getID()

Gets the id of this data source.

Returns:

A URI identifier for the data source.

getName

String getName()

Gets the name of this data source.

Returns:

A descriptive name for the data source.

setName

void setName(String name)

Sets the name of this data source.

Parameters:

name - A descriptive name for the data source.

getType

URI getType()

Returns a URI that indicates the DataSource type in a platform- and programming language-independent way.

Returns:

A URI indicating the DataSource type

getConfiguration

RDFContainer getConfiguration()

Gets the RDF model containing the configuration of this DataSource. The returned RDFContainer can be modified in order to update the configuration.

Returns:

A mutable RDFContainer, or 'null' when the configuration container has not been set yet.

setConfiguration

void setConfiguration(RDFContainer configuration)

Sets the RDF model containing the configuration of this DataSource. The specified RDFContainer is expected to be mutable.

Parameters:

configuration - A mutable RDFContainer, or 'null' when the DataSource's configuration needs to be temporarily unset.

dispose

void dispose()

Disposes this DataSource. This method disposes the underlying configuration RDFContainer. May also perform any other cleanup operations necessary for this particular implementation.