org.egothor.dir

Class TankerImpl

java.lang.Object

org.egothor.dir.Group

org.egothor.dir.Tanker

org.egothor.dir.TankerImpl

All Implemented Interfaces:

AutoCloseable, Resolver<CachedQuery,CachedResult>, Barrel, BarrelWriter

Direct Known Subclasses:

TankerImplSecure

public class TankerImpl
extends Tanker

This object encapsulates core Tanker structure with some routines which make the life of a programmer easier.

Author:

Leo Galambos

Constructor Summary

Constructors

Constructor and Description
TankerImpl()

Method Summary

Modifier and Type	Method and Description
void	append(BarrelReader a) Add the given Barrel to this Tanker.
void	close() Close this Tanker.
void	commit() Save the state of the tanker object.
void	destroy() Description of the Method
DocumentData	expandDocMetadata(DocumentData ofBarrel, Token[] interest) Retrives the document data, but restrict the data block to the part relevant to some tokens of our interest.
void	initializeTanker(String indexDir, DataRepository repo, boolean useBerkeleyGP, boolean MTE, int capacity) Init a tanker with Egothor dynamizer.
void	initializeTanker(String indexDir, DataRepository repo, boolean useBerkeleyGP, boolean MTE, int capacity, int mergeFactor) Init a tanker with Standard dynamizer.
Properties	loadState() Read properties of the Tanker
boolean	removeDoc(long gid) Remove the document with the given ID and return whether the operation was successful.

Methods inherited from class org.egothor.dir.Tanker

elements, getRootVersionID, isDirty, optimize

Methods inherited from class org.egothor.dir.Group

deleted, expand, forEach, getBitmap, getCache, getCWI, getIListMeta, getMeta, initializeCache, initializeCache, initializeCache, initializeCache, iterate, open, openIList, query, query, query, resolve, setBitmap, size

Methods inherited from class java.lang.Object

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

Constructor Detail

TankerImpl

public TankerImpl()

Method Detail

initializeTanker

public void initializeTanker(String indexDir,
                             DataRepository repo,
                             boolean useBerkeleyGP,
                             boolean MTE,
                             int capacity)
                      throws IOException

Init a tanker with Egothor dynamizer.

Parameters:

indexDir -

repo -

useBerkeleyGP -

MTE -

capacity -

Throws:

IOException

initializeTanker

public void initializeTanker(String indexDir,
                             DataRepository repo,
                             boolean useBerkeleyGP,
                             boolean MTE,
                             int capacity,
                             int mergeFactor)
                      throws IOException

Init a tanker with Standard dynamizer.

Parameters:

indexDir -

repo -

useBerkeleyGP -

MTE -

capacity -

mergeFactor -

Throws:

IOException

append

public void append(BarrelReader a)

Description copied from class: Tanker

Add the given Barrel to this Tanker.

Specified by:

append in interface BarrelWriter

Overrides:

append in class Tanker

Parameters:

a - the Barrel to add

removeDoc

public boolean removeDoc(long gid)

Description copied from class: Group

Remove the document with the given ID and return whether the operation was successful.

Specified by:

removeDoc in interface Barrel

Overrides:

removeDoc in class Group

Parameters:

gid - the document to remove

Returns:

true if the removal was successful, false otherwise

loadState

public Properties loadState()
                     throws IOException

Read properties of the Tanker

Returns:

LastModified of the state file, 0L on any error

Throws:

IOException

expandDocMetadata

public DocumentData expandDocMetadata(DocumentData ofBarrel,
                                      Token[] interest)

Description copied from class: Group

Retrives the document data, but restrict the data block to the part relevant to some tokens of our interest. Full data block is retrieved if none interest is specified.

Specified by:

expandDocMetadata in class Tanker

commit

public void commit()

Save the state of the tanker object.

Specified by:

commit in interface Barrel

Overrides:

commit in class Tanker

destroy

public void destroy()

Description of the Method

Specified by:

destroy in interface Barrel

Overrides:

destroy in class Tanker

close

public void close()

Description copied from class: Tanker

Close this Tanker.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Barrel

Specified by:

close in interface BarrelWriter

Overrides:

close in class Tanker