cat.lump.ir.retrievalmodels.document

Class Document

java.lang.Object

cat.lump.ir.retrievalmodels.document.Document

All Implemented Interfaces:

java.io.Serializable

public class Document
extends java.lang.Object
implements java.io.Serializable

A frame to represent a text document and its fragments (in the form of sentences). It is possible accessing the document's overall representations as well as fragment-wise. The representations include

• plain text
• bag of words
• character n-grams

More to be added: word n-grams, keywords, named entities, ESA.

Since:

3 Mar, 2014

Version:

0.1

Author:

albarron

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Dictionary	dictionary Internal dictionary that links terms to their numerical representation

Constructor Summary

Constructors

Constructor and Description
Document(java.lang.String[] text, java.util.Locale language)
Document(java.lang.String[] text, java.util.Locale language, boolean includeBow, boolean includeCharNgrams, boolean includeWordNgrams, boolean includePseudoCognates)
Document(java.lang.String[] text, java.util.Locale language, boolean includeBow, boolean includeCharNgrams, boolean includeWordNgrams, boolean includePseudoCognates, int nGrams)
Document(java.lang.String text, java.util.Locale language)
Document(java.lang.String text, java.util.Locale language, boolean includeBow, boolean includeCharNgrams, boolean includeWordNgrams, boolean includePseudoCognates)
Document(java.lang.String text, java.util.Locale language, boolean includeBow, boolean includeCharNgrams, boolean includeWordNgrams, boolean includePseudoCognates, int nGrams)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	fragmentExists(int i)
java.util.List<java.lang.String>	get(RepresentationType representation)
Fragment	getFragment(int i)
java.util.Map<java.lang.String,java.lang.Double>	getNormalized(RepresentationType representation)
java.lang.String	getText()
java.util.Map<java.lang.String,java.lang.Double>	getWeighted(RepresentationType representation)
int	length()
void	setLanguage(java.util.Locale language)
protected java.util.List<java.lang.String>	splitText(java.lang.String text)

Methods inherited from class java.lang.Object

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

Field Detail

dictionary

protected final Dictionary dictionary

Internal dictionary that links terms to their numerical representation

Constructor Detail

Document

public Document(java.lang.String text,
        java.util.Locale language)

Document

public Document(java.lang.String[] text,
        java.util.Locale language)

Document

public Document(java.lang.String text,
        java.util.Locale language,
        boolean includeBow,
        boolean includeCharNgrams,
        boolean includeWordNgrams,
        boolean includePseudoCognates)

Document

public Document(java.lang.String[] text,
        java.util.Locale language,
        boolean includeBow,
        boolean includeCharNgrams,
        boolean includeWordNgrams,
        boolean includePseudoCognates)

Document

public Document(java.lang.String text,
        java.util.Locale language,
        boolean includeBow,
        boolean includeCharNgrams,
        boolean includeWordNgrams,
        boolean includePseudoCognates,
        int nGrams)

Document

public Document(java.lang.String[] text,
        java.util.Locale language,
        boolean includeBow,
        boolean includeCharNgrams,
        boolean includeWordNgrams,
        boolean includePseudoCognates,
        int nGrams)

Method Detail

fragmentExists

public boolean fragmentExists(int i)

setLanguage

public void setLanguage(java.util.Locale language)

getFragment

public Fragment getFragment(int i)

Parameters:

i -

Returns:

fragment at index i; null if non-existent

get

public java.util.List<java.lang.String> get(RepresentationType representation)

getWeighted

public java.util.Map<java.lang.String,java.lang.Double> getWeighted(RepresentationType representation)

getNormalized

public java.util.Map<java.lang.String,java.lang.Double> getNormalized(RepresentationType representation)

getText

public java.lang.String getText()

Returns:

entire text

length

public int length()

Returns:

number of fragments in the document

splitText

protected java.util.List<java.lang.String> splitText(java.lang.String text)

Parameters:

text -

Returns:

sentences in the text