edu.illinois.cs.cogcomp.core.io.caches

Class TextAnnotationMapDBHandler

java.lang.Object

edu.illinois.cs.cogcomp.core.io.caches.TextAnnotationMapDBHandler

All Implemented Interfaces:

TextAnnotationCache

public class TextAnnotationMapDBHandler
extends Object
implements TextAnnotationCache

Implements the TextAnnotationCache interface using MapDB storage. The keys in the map-based DB are the hash codes of the AbstractTextAnnotation.getTokenizedText().

Author:

Christos Christodoulopoulos

Constructor Summary

Constructors

Constructor and Description
TextAnnotationMapDBHandler(String dbFile)

Method Summary

Modifier and Type	Method and Description
void	addTextAnnotation(String dataset, TextAnnotation ta)
void	close() MapDB requires the database to be closed at the end of operations.
boolean	contains(TextAnnotation ta) checks whether ta with corresponding TEXT is in database -- not whether the same annotations are present
IResetableIterator<TextAnnotation>	getDataset(String dataset)
TextAnnotation	getTextAnnotation(TextAnnotation ta)
boolean	isCached(String dataset, String dbFile) Checks if the dataset is cached in the DB.
void	removeTextAnnotation(TextAnnotation ta)
void	updateTextAnnotation(TextAnnotation ta)

Methods inherited from class java.lang.Object

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

Constructor Detail

TextAnnotationMapDBHandler

public TextAnnotationMapDBHandler(String dbFile)

Method Detail

close

public void close()

MapDB requires the database to be closed at the end of operations. This is usually handled by the closeOnJvmShutdown() snippet in the initializer, but this method needs to be called if multiple instances of the TextAnnotationMapDBHandler are used.

isCached

public boolean isCached(String dataset,
                        String dbFile)

Checks if the dataset is cached in the DB.

Parameters:

dataset - The name of the dataset (e.g. "train", "test")

dbFile - The name of the MapDB file

Returns:

Whether the dataset exists in the DB

addTextAnnotation

public void addTextAnnotation(String dataset,
                              TextAnnotation ta)

Specified by:

addTextAnnotation in interface TextAnnotationCache

updateTextAnnotation

public void updateTextAnnotation(TextAnnotation ta)

Specified by:

updateTextAnnotation in interface TextAnnotationCache

getDataset

public IResetableIterator<TextAnnotation> getDataset(String dataset)

Specified by:

getDataset in interface TextAnnotationCache

contains

public boolean contains(TextAnnotation ta)

checks whether ta with corresponding TEXT is in database -- not whether the same annotations are present

Specified by:

contains in interface TextAnnotationCache

Parameters:

ta -

Returns:

removeTextAnnotation

public void removeTextAnnotation(TextAnnotation ta)

Specified by:

removeTextAnnotation in interface TextAnnotationCache

getTextAnnotation

public TextAnnotation getTextAnnotation(TextAnnotation ta)

Specified by:

getTextAnnotation in interface TextAnnotationCache