EditableDocumentDataProvider Interface Reference

Inheritance diagram for EditableDocumentDataProvider:
Collaboration diagram for EditableDocumentDataProvider:

List of all members.

Public Methods

IDocumentData saveOrUpdateDocumentData (TeslaDocument td, IDocumentData data) throws DataSourceException
void deleteDocuments (List< TeslaDocument > documents) throws DataSourceException
void saveOrUpdateDocument (TeslaDocument td) throws DataSourceException
void setDataSource (DataSource ds)
IDocumentData getDocumentData (TeslaDocument doc) throws DocumentNotFoundException, DataSourceException
List< TeslaDocumentgetAllDocuments () throws DataSourceException
void initialize (DocumentProviderConfiguration config) throws DataSourceException
TeslaDocument getDocument (String documentId) throws DocumentNotFoundException, DataSourceException
int getNumberOfDocuments ()
DocumentProviderConfiguration getConfiguration ()
IDublinCoreMetadata getMetadata (TeslaDocument document) throws DataSourceException

Method Details

void deleteDocuments ( List< TeslaDocument documents) throws DataSourceException

Implemented in TeslaDocumentProvider.

List<TeslaDocument> getAllDocuments ( ) throws DataSourceException [inherited]

Returns all documents managed by the provider.

Parameters:
dataSourceIdwill be removed soon
Returns:
Exceptions:
DataSourceException

Implemented in TeslaDocumentProvider, and ZipDocumentProvider.

DocumentProviderConfiguration getConfiguration ( ) [inherited]

Returns the configuration of the provider.

Returns:

Implemented in TeslaDocumentProvider, and ZipDocumentProvider.

TeslaDocument getDocument ( String  documentId) throws DocumentNotFoundException, DataSourceException [inherited]

Returns the document with the given id.

Parameters:
documentId
Returns:
Exceptions:
DocumentNotFoundException
DataSourceException

Implemented in TeslaDocumentProvider, and ZipDocumentProvider.

IDocumentData getDocumentData ( TeslaDocument  doc) throws DocumentNotFoundException, DataSourceException [inherited]

Returns content related to a TeslaDocument as IDocumentData.

Parameters:
docThe related TeslaDocument.
Returns:
IDocumentData of TeslaDocument

Implemented in TeslaDocumentProvider, and ZipDocumentProvider.

IDublinCoreMetadata getMetadata ( TeslaDocument  document) throws DataSourceException [inherited]
int getNumberOfDocuments ( ) [inherited]

Returns the number of documents managed by this provider. Returns -1, if the number of documents may vary.

Returns:

Implemented in TeslaDocumentProvider, and ZipDocumentProvider.

void initialize ( DocumentProviderConfiguration  config) throws DataSourceException [inherited]

Initializes a document provider. The appropriate implementation of this interface is determined by the information found in a datasource-definition (as can be found in directory configurations/datasources in Tesla's main directory).

Parameters:
config
Exceptions:
DataSourceException

Implemented in TeslaDocumentProvider, ZipDocumentProvider, and BrownCorpusDocumentProvider.

void saveOrUpdateDocument ( TeslaDocument  td) throws DataSourceException

Implemented in TeslaDocumentProvider.

IDocumentData saveOrUpdateDocumentData ( TeslaDocument  td,
IDocumentData  data 
) throws DataSourceException
Returns:
id only for use with external sources with editable DocumentData (not implemented yet)

Implemented in TeslaDocumentProvider.

void setDataSource ( DataSource  ds)

Implemented in TeslaDocumentProvider.