net.sf.okapi.virtualdb.jdbc

Class Repository

java.lang.Object

net.sf.okapi.virtualdb.jdbc.Repository

All Implemented Interfaces:

IVRepository

public class Repository
extends Object
implements IVRepository

Nested Class Summary

Nested classes/interfaces inherited from interface net.sf.okapi.virtualdb.IVRepository

IVRepository.OpeningMode

Constructor Summary

Constructors

Constructor and Description
Repository(IDBAccess engine)

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.
protected void	finalize()
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.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Repository

public Repository(IDBAccess engine)

Method Detail

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

open

public void open(String name,
        IVRepository.OpeningMode mode)

Specified by:

open in interface IVRepository

create

public void create(String name)

Description copied from interface: IVRepository

Creates a new physical repository.

Specified by:

create in interface IVRepository

Parameters:

name - the name of the repository.

open

public void open(String name)

Description copied from interface: IVRepository

Opens an existing physical repository.

Specified by:

open in interface IVRepository

Parameters:

name - the name of the repository.

close

public void close()

Description copied from interface: IVRepository

Closes the repository.

Specified by:

close in interface IVRepository

documents

public Iterable<IVDocument> documents()

Description copied from interface: IVRepository

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

Specified by:

documents in interface IVRepository

Returns:

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

getDocument

public IVDocument getDocument(long docKey)

Description copied from interface: IVRepository

Gets the virtual document for a given document key.

Specified by:

getDocument in interface IVRepository

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.

importDocument

public String importDocument(RawDocument rawDoc)

Description copied from interface: IVRepository

Imports a document into this repository.

Specified by:

importDocument in interface IVRepository

Parameters:

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

Returns:

the document id of the imported document.

importDocumentReturnKey

public long importDocumentReturnKey(RawDocument rawDoc)

Specified by:

importDocumentReturnKey in interface IVRepository

removeDocument

public void removeDocument(IVDocument doc)

Description copied from interface: IVRepository

Removes a given document from this repository.

Calling this method may invalidate any current iterator created by IVRepository.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.

Specified by:

removeDocument in interface IVRepository

Parameters:

doc - the virtual document to remove.

getFirstDocument

public IVDocument getFirstDocument()

Description copied from interface: IVRepository

Gets the first virtual document in this repository.

Specified by:

getFirstDocument in interface IVRepository

Returns:

the first virtual document in this repository or null.

saveExtraData1

public void saveExtraData1(InputStream inputStream)

Description copied from interface: IVRepository

Saves a block of extra data into the repository.

Specified by:

saveExtraData1 in interface IVRepository

Parameters:

inputStream - the input stream of the object to save.

loadExtraData1

public InputStream loadExtraData1()

Specified by:

loadExtraData1 in interface IVRepository