eu.project.ttc.models.index

Class MemoryTermIndex

java.lang.Object

eu.project.ttc.models.index.MemoryTermIndex

All Implemented Interfaces:

TermIndex

public class MemoryTermIndex
extends java.lang.Object
implements TermIndex

The in-memory implementation of a TermIndex.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MSG_NO_SUCH_TERM

Constructor Summary

Constructors

Constructor and Description
MemoryTermIndex(java.lang.String name, Lang lang, OccurrenceStore occurrenceStore)

Method Summary

Modifier and Type	Method and Description
void	addTerm(Term term)
Term	addTermOccurrence(eu.project.ttc.types.TermOccAnnotation annotation, java.lang.String fileUrl, boolean keepOccurrence)
void	addWord(Word word)
Word	addWord(eu.project.ttc.types.WordAnnotation anno)
void	classifyTerms(Term classHead, java.lang.Iterable<Term> classTerms)
void	cleanOrphanWords()
void	clearOccurrenceIndex()
java.util.Iterator<Term>	compoundWordTermIterator()
CustomTermIndex	createCustomIndex(java.lang.String indexName, TermValueProvider valueProvider)
void	createOccurrenceIndex()
void	deleteMany(TermSelector selector)
void	dropCustomIndex(java.lang.String indexName)
java.lang.String	getCorpusId()
CustomTermIndex	getCustomIndex(java.lang.String indexName)
Document	getDocument(java.lang.String url) Returns the document identified by this url or creates a new one.
java.util.Collection<Document>	getDocuments()
TermMeasure	getFrequencyMeasure()
Lang	getLang() The language of the pipeline
java.lang.Iterable<TermMeasure>	getMeasures()
java.lang.String	getName() The term index id name
OccurrenceStore	getOccurrenceStore() The occurrence store
int	getSpottedTermsNum() The number of terms added to this TermIndex by invoking TermIndex.addTermOccurrence(TermOccAnnotation, String, boolean)
Term	getTermByGroupingKey(java.lang.String groupingKey)
Term	getTermById(int id)
java.util.Collection<TermClass>	getTermClasses()
java.util.Collection<Term>	getTerms()
Word	getWord(java.lang.String wordId)
int	getWordAnnotationsNum()
java.util.Collection<Word>	getWords()
TermMeasure	getWRLogMeasure()
TermMeasure	getWRMeasure()
int	hashCode()
void	importCas(org.apache.uima.jcas.JCas cas, boolean keepOccurrence)
java.util.Iterator<Term>	multiWordTermIterator()
int	newId()
void	removeTerm(Term t)
void	setCorpusId(java.lang.String corpusId)
void	setSpottedTermsNum(int spottedTermsNum)
void	setWordAnnotationsNum(int nbWordAnnotations)
java.util.Iterator<Term>	singleWordTermIterator()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MSG_NO_SUCH_TERM

public static final java.lang.String MSG_NO_SUCH_TERM

See Also:

Constant Field Values

Constructor Detail

MemoryTermIndex

public MemoryTermIndex(java.lang.String name,
                       Lang lang,
                       OccurrenceStore occurrenceStore)

Method Detail

addTerm

public void addTerm(Term term)

Specified by:

addTerm in interface TermIndex

addWord

public void addWord(Word word)

Specified by:

addWord in interface TermIndex

getTerms

public java.util.Collection<Term> getTerms()

Specified by:

getTerms in interface TermIndex

getWord

public Word getWord(java.lang.String wordId)

Specified by:

getWord in interface TermIndex

addWord

public Word addWord(eu.project.ttc.types.WordAnnotation anno)

addTermOccurrence

public Term addTermOccurrence(eu.project.ttc.types.TermOccAnnotation annotation,
                              java.lang.String fileUrl,
                              boolean keepOccurrence)

Specified by:

addTermOccurrence in interface TermIndex

singleWordTermIterator

public java.util.Iterator<Term> singleWordTermIterator()

Specified by:

singleWordTermIterator in interface TermIndex

multiWordTermIterator

public java.util.Iterator<Term> multiWordTermIterator()

Specified by:

multiWordTermIterator in interface TermIndex

compoundWordTermIterator

public java.util.Iterator<Term> compoundWordTermIterator()

Specified by:

compoundWordTermIterator in interface TermIndex

newId

public int newId()

Specified by:

newId in interface TermIndex

getCustomIndex

public CustomTermIndex getCustomIndex(java.lang.String indexName)

Specified by:

getCustomIndex in interface TermIndex

createCustomIndex

public CustomTermIndex createCustomIndex(java.lang.String indexName,
                                         TermValueProvider valueProvider)

Specified by:

createCustomIndex in interface TermIndex

dropCustomIndex

public void dropCustomIndex(java.lang.String indexName)

Specified by:

dropCustomIndex in interface TermIndex

getWords

public java.util.Collection<Word> getWords()

Specified by:

getWords in interface TermIndex

getTermByGroupingKey

public Term getTermByGroupingKey(java.lang.String groupingKey)

Specified by:

getTermByGroupingKey in interface TermIndex

getTermById

public Term getTermById(int id)

Specified by:

getTermById in interface TermIndex

cleanOrphanWords

public void cleanOrphanWords()

Specified by:

cleanOrphanWords in interface TermIndex

removeTerm

public void removeTerm(Term t)

Specified by:

removeTerm in interface TermIndex

getName

public java.lang.String getName()

Description copied from interface: TermIndex

The term index id name

Specified by:

getName in interface TermIndex

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getDocument

public Document getDocument(java.lang.String url)

Description copied from interface: TermIndex

Returns the document identified by this url or creates a new one.

Specified by:

getDocument in interface TermIndex

Parameters:

url - A url accessible by File's constructor.

Returns:

The created document

getDocuments

public java.util.Collection<Document> getDocuments()

Specified by:

getDocuments in interface TermIndex

createOccurrenceIndex

public void createOccurrenceIndex()

Specified by:

createOccurrenceIndex in interface TermIndex

clearOccurrenceIndex

public void clearOccurrenceIndex()

Specified by:

clearOccurrenceIndex in interface TermIndex

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getLang

public Lang getLang()

Description copied from interface: TermIndex

The language of the pipeline

Specified by:

getLang in interface TermIndex

Returns:

getCorpusId

public java.lang.String getCorpusId()

Specified by:

getCorpusId in interface TermIndex

setCorpusId

public void setCorpusId(java.lang.String corpusId)

Specified by:

setCorpusId in interface TermIndex

getTermClasses

public java.util.Collection<TermClass> getTermClasses()

Specified by:

getTermClasses in interface TermIndex

classifyTerms

public void classifyTerms(Term classHead,
                          java.lang.Iterable<Term> classTerms)

Specified by:

classifyTerms in interface TermIndex

setWordAnnotationsNum

public void setWordAnnotationsNum(int nbWordAnnotations)

Specified by:

setWordAnnotationsNum in interface TermIndex

getWordAnnotationsNum

public int getWordAnnotationsNum()

Specified by:

getWordAnnotationsNum in interface TermIndex

getWRMeasure

public TermMeasure getWRMeasure()

Specified by:

getWRMeasure in interface TermIndex

getWRLogMeasure

public TermMeasure getWRLogMeasure()

Specified by:

getWRLogMeasure in interface TermIndex

getFrequencyMeasure

public TermMeasure getFrequencyMeasure()

Specified by:

getFrequencyMeasure in interface TermIndex

getMeasures

public java.lang.Iterable<TermMeasure> getMeasures()

Specified by:

getMeasures in interface TermIndex

getSpottedTermsNum

public int getSpottedTermsNum()

Description copied from interface: TermIndex

The number of terms added to this TermIndex by invoking TermIndex.addTermOccurrence(TermOccAnnotation, String, boolean)

Specified by:

getSpottedTermsNum in interface TermIndex

Returns:

The number of spotted terms, 0 if none has been added through the method TermIndex.addTermOccurrence(TermOccAnnotation, String, boolean)

setSpottedTermsNum

public void setSpottedTermsNum(int spottedTermsNum)

Specified by:

setSpottedTermsNum in interface TermIndex

getOccurrenceStore

public OccurrenceStore getOccurrenceStore()

Description copied from interface: TermIndex

The occurrence store

Specified by:

getOccurrenceStore in interface TermIndex

deleteMany

public void deleteMany(TermSelector selector)

Specified by:

deleteMany in interface TermIndex

importCas

public void importCas(org.apache.uima.jcas.JCas cas,
                      boolean keepOccurrence)

Specified by:

importCas in interface TermIndex