eu.project.ttc.models

Interface TermIndex

All Known Implementing Classes:

MemoryTermIndex

public interface TermIndex

Method Summary

Modifier and Type	Method and Description
void	addTerm(Term term)
Term	addTermOccurrence(eu.project.ttc.types.TermOccAnnotation annotation, java.lang.String FileUri, boolean keepOccurrenceInTermIndex) Deprecated.
void	addWord(Word word)
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 termClassProvider)
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 addTermOccurrence(TermOccAnnotation, String, boolean)
Term	getTermByGroupingKey(java.lang.String groupingKey)
Term	getTermById(int termId)
java.util.Collection<TermClass>	getTermClasses()
java.util.Collection<Term>	getTerms()
Word	getWord(java.lang.String lemma)
int	getWordAnnotationsNum()
java.util.Collection<Word>	getWords()
TermMeasure	getWRLogMeasure()
TermMeasure	getWRMeasure()
void	importCas(org.apache.uima.jcas.JCas cas, boolean keepOccurrenceInTermIndex)
java.util.Iterator<Term>	multiWordTermIterator()
int	newId()
void	removeTerm(Term t)
void	setCorpusId(java.lang.String corpusID)
void	setSpottedTermsNum(int nbSpottedTerms)
void	setWordAnnotationsNum(int nbWordAnnotations)
java.util.Iterator<Term>	singleWordTermIterator()

Method Detail

getName

java.lang.String getName()

The term index id name

Returns:

getLang

Lang getLang()

The language of the pipeline

Returns:

setCorpusId

void setCorpusId(java.lang.String corpusID)

getCorpusId

java.lang.String getCorpusId()

getOccurrenceStore

OccurrenceStore getOccurrenceStore()

The occurrence store

getTermByGroupingKey

Term getTermByGroupingKey(java.lang.String groupingKey)

getTermById

Term getTermById(int termId)

removeTerm

void removeTerm(Term t)

addTerm

void addTerm(Term term)

getTerms

java.util.Collection<Term> getTerms()

getTermClasses

java.util.Collection<TermClass> getTermClasses()

classifyTerms

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

addWord

void addWord(Word word)

getWords

java.util.Collection<Word> getWords()

cleanOrphanWords

void cleanOrphanWords()

getWord

Word getWord(java.lang.String lemma)

getDocument

Document getDocument(java.lang.String url)

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

Parameters:

url - A url accessible by File's constructor.

Returns:

The created document

getDocuments

java.util.Collection<Document> getDocuments()

singleWordTermIterator

java.util.Iterator<Term> singleWordTermIterator()

multiWordTermIterator

java.util.Iterator<Term> multiWordTermIterator()

compoundWordTermIterator

java.util.Iterator<Term> compoundWordTermIterator()

getCustomIndex

CustomTermIndex getCustomIndex(java.lang.String indexName)

createCustomIndex

CustomTermIndex createCustomIndex(java.lang.String indexName,
                                  TermValueProvider termClassProvider)

dropCustomIndex

void dropCustomIndex(java.lang.String indexName)

getWRMeasure

TermMeasure getWRMeasure()

getWRLogMeasure

TermMeasure getWRLogMeasure()

getFrequencyMeasure

TermMeasure getFrequencyMeasure()

getMeasures

java.lang.Iterable<TermMeasure> getMeasures()

deleteMany

void deleteMany(TermSelector selector)

addTermOccurrence

@Deprecated
Term addTermOccurrence(eu.project.ttc.types.TermOccAnnotation annotation,
                                   java.lang.String FileUri,
                                   boolean keepOccurrenceInTermIndex)

Deprecated.

createOccurrenceIndex

void createOccurrenceIndex()

clearOccurrenceIndex

void clearOccurrenceIndex()

importCas

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

newId

int newId()

setWordAnnotationsNum

void setWordAnnotationsNum(int nbWordAnnotations)

getWordAnnotationsNum

int getWordAnnotationsNum()

getSpottedTermsNum

int getSpottedTermsNum()

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

Returns:

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

setSpottedTermsNum

void setSpottedTermsNum(int nbSpottedTerms)