textractor.datamodel
Class Article

java.lang.Object
  textractor.datamodel.ArticleInfo
      textractor.datamodel.Article

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

OmimArticle, OtmiArticle, SfnArticle

public class Article
extends ArticleInfo
implements Serializable

See Also:

Serialized Form

Field Summary

Fields inherited from class textractor.datamodel.ArticleInfo

documentNumberRangeLength, documentNumberRangeStart, filename, link, pmid

Constructor Summary

Article()
Create a new article.

Method Summary

void	addTermOccurrence(TermOccurrence to)
void	addTermPredictionStatistic(TermPredictionStatistics stat)
Map<String,Object>	getAdditionalFieldsMap() Get the map of additional fields.
long	getArticleNumber()
TermOccurrence[]	getMostFrequentTerms(int number) Gets the specified number of the most frequent terms in this Article.
TermOccurrence[]	getMostFrequentTerms(int number, List<String> exclusionList) Returns the specified number of the most frequent terms in this Article, not including terms from the exclusion_list.
int	getNumMostFrequentTerms() Returns the number of most frequent terms.
int[]	getTargetTermOccurenceIndexAll()
int[]	getTargetTermOccurenceIndexCombined()
int[]	getTargetTermOccurenceIndexMulti()
TermOccurrence	getTermOccurrence(int i)
TermOccurrence	getTermOccurrenceForTerm(int[] indexedTermSearched)
TermPredictionStatistics[]	getTermPredictionStatistics()
String	getText(TextractorManager tm) Get the text associated with this article.
void	removeTermPredictionStatistics()
void	setAdditionalField(String field, Object indexableValue) Set the value of an indexable field.
void	setArticleNumber(long articleNumber)
void	setMostFrequentTerms(TermOccurrence[] terms) Sets the most frequent terms.
void	setTargetTermOccurenceIndexAll(int[] targetTermOccurenceIndexAll)
void	setTargetTermOccurenceIndexCombined(int[] targetTermOccurenceIndexCombined)
void	setTargetTermOccurenceIndexMulti(int[] targetTermOccurenceIndexMulti)
void	setTermPredictionStatistics(TermPredictionStatistics[] stats)
String	toString() String version of this object.

Methods inherited from class textractor.datamodel.ArticleInfo

getDocumentNumberRangeLength, getDocumentNumberRangeStart, getFilename, getID, getLink, getPmid, setDocumentNumberRangeLength, setDocumentNumberRangeStart, setFilename, setLink, setPmid

Methods inherited from class java.lang.Object

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

Constructor Detail

Article

public Article()

Create a new article.

Method Detail

getText

public String getText(TextractorManager tm)

Get the text associated with this article.

Parameters:

tm - Textractor Manager used to access the datastore.

Returns:

Text associated with this article.

getArticleNumber

public long getArticleNumber()

setArticleNumber

public void setArticleNumber(long articleNumber)

setTermPredictionStatistics

public void setTermPredictionStatistics(TermPredictionStatistics[] stats)

addTermPredictionStatistic

public void addTermPredictionStatistic(TermPredictionStatistics stat)

getTermPredictionStatistics

public TermPredictionStatistics[] getTermPredictionStatistics()

removeTermPredictionStatistics

public void removeTermPredictionStatistics()

setMostFrequentTerms

public void setMostFrequentTerms(TermOccurrence[] terms)

Sets the most frequent terms.

Parameters:

terms - The terms

addTermOccurrence

public void addTermOccurrence(TermOccurrence to)

getTermOccurrence

public TermOccurrence getTermOccurrence(int i)

getMostFrequentTerms

public TermOccurrence[] getMostFrequentTerms(int number)

Gets the specified number of the most frequent terms in this Article.

Parameters:

number - number of terms to be returned.

Returns:

an array of the index positions of the of most frequent terms.

getMostFrequentTerms

public TermOccurrence[] getMostFrequentTerms(int number,
                                             List<String> exclusionList)

Returns the specified number of the most frequent terms in this Article, not including terms from the exclusion_list.

Parameters:

number - number of terms to be returned.

exclusionList - terms to be excluded from the terms to be returned.

Returns:

an array of the index positions of the number of most frequent terms.

getTermOccurrenceForTerm

public TermOccurrence getTermOccurrenceForTerm(int[] indexedTermSearched)

getNumMostFrequentTerms

public int getNumMostFrequentTerms()

Returns the number of most frequent terms.

Returns:

the number of most frequent terms stored with this article.

setTargetTermOccurenceIndexAll

public void setTargetTermOccurenceIndexAll(int[] targetTermOccurenceIndexAll)

getTargetTermOccurenceIndexAll

public int[] getTargetTermOccurenceIndexAll()

setTargetTermOccurenceIndexMulti

public void setTargetTermOccurenceIndexMulti(int[] targetTermOccurenceIndexMulti)

getTargetTermOccurenceIndexMulti

public int[] getTargetTermOccurenceIndexMulti()

setTargetTermOccurenceIndexCombined

public void setTargetTermOccurenceIndexCombined(int[] targetTermOccurenceIndexCombined)

getTargetTermOccurenceIndexCombined

public int[] getTargetTermOccurenceIndexCombined()

getAdditionalFieldsMap

public Map<String,Object> getAdditionalFieldsMap()

Get the map of additional fields.

Returns:

the map of additional fields

setAdditionalField

public void setAdditionalField(String field,
                               Object indexableValue)

Set the value of an indexable field.

Parameters:

field - the field name

indexableValue - the field value

toString

public String toString()

String version of this object.

Overrides:

toString in class Object

Returns:

String version of this object