net.sf.okapi.virtualdb

Interface IVRepository

All Known Implementing Classes:

Repository

public interface IVRepository

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IVRepository.OpeningMode

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the repository.
void	create(String name) Creates a new physical repository.
Iterable<IVDocument>	documents() Creates an iterable object for all the documents contained into this repository.
IVDocument	getDocument(long docKey) Gets the virtual document for a given document key.
IVDocument	getFirstDocument() Gets the first virtual document in this repository.
String	importDocument(RawDocument rawDoc) Imports a document into this repository.
long	importDocumentReturnKey(RawDocument rawDoc)
InputStream	loadExtraData1()
void	open(String name) Opens an existing physical repository.
void	open(String name, IVRepository.OpeningMode mode)
void	removeDocument(IVDocument doc) Removes a given document from this repository.
void	saveExtraData1(InputStream inputStream) Saves a block of extra data into the repository.

Method Detail

open

void open(String name,
        IVRepository.OpeningMode mode)

create

void create(String name)

Creates a new physical repository.

Parameters:

name - the name of the repository.

open

void open(String name)

Opens an existing physical repository.

Parameters:

name - the name of the repository.

close

void close()

Closes the repository.

documents

Iterable<IVDocument> documents()

Creates an iterable object for all the documents contained into this repository.

Returns:

an new iterable object for all the items contained into this repository.

importDocument

String importDocument(RawDocument rawDoc)

Imports a document into this repository.

Parameters:

rawDoc - the document to import (must be URI based).

Returns:

the document id of the imported document.

importDocumentReturnKey

long importDocumentReturnKey(RawDocument rawDoc)

removeDocument

void removeDocument(IVDocument doc)

Removes a given document from this repository.

Calling this method may invalidate any current iterator created by documents(), as well as the sibling relationships for any current IVDocument corresponding to the previous and next documents of this one.

To remove all documents from a repository it may be simpler to re-create the repository.

Parameters:

doc - the virtual document to remove.

getFirstDocument

IVDocument getFirstDocument()

Gets the first virtual document in this repository.

Returns:

the first virtual document in this repository or null.

getDocument

IVDocument getDocument(long docKey)

Gets the virtual document for a given document key.

Parameters:

docKey - the key of the document to retrieve.

Returns:

the virtual document for the given key, or null if no document could be retrieve.

saveExtraData1

void saveExtraData1(InputStream inputStream)

Saves a block of extra data into the repository.

Parameters:

inputStream - the input stream of the object to save.

loadExtraData1

InputStream loadExtraData1()