textractor.datamodel
Class TextractorDocument

java.lang.Object
  textractor.datamodel.TextractorDocument

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PaddingDocument, Sentence

public abstract class TextractorDocument
extends Object
implements Serializable

A super class for each type of Textractor Document.

See Also:

Serialized Form

Field Summary

static int	ABSTRACT_SECTION
protected long	documentNumber By design, this number exactly match the document number in the MG4J full text index.
static int	OTHER_SECTION
static int	REFERENCE_SECTION

Constructor Summary

TextractorDocument()

Method Summary

long	getDocumentNumber() Get the document number.
int	getDocumentSection()
Reference2ObjectMap<Enum<?>,Object>	getMetaData() Get the metadata for this document.
abstract String	getText() Get the text contained in this document.
void	setDocumentNumber(long number) Set the document number.
void	setDocumentSection(int section) Set the document Section.

Methods inherited from class java.lang.Object

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

Field Detail

ABSTRACT_SECTION

public static final int ABSTRACT_SECTION

See Also:

Constant Field Values

OTHER_SECTION

public static final int OTHER_SECTION

See Also:

Constant Field Values

REFERENCE_SECTION

public static final int REFERENCE_SECTION

See Also:

Constant Field Values

documentNumber

protected long documentNumber

By design, this number exactly match the document number in the MG4J full text index.

Constructor Detail

TextractorDocument

public TextractorDocument()

Method Detail

getDocumentSection

public final int getDocumentSection()

setDocumentSection

public final void setDocumentSection(int section)

Set the document Section.

Parameters:

section - Section of this document.

getDocumentNumber

public final long getDocumentNumber()

Get the document number. By design, this number exactly match the document number in the MG4J full text index.

Returns:

The document number.

setDocumentNumber

public final void setDocumentNumber(long number)

Set the document number.

Parameters:

number - Number of this document.

getText

public abstract String getText()

Get the text contained in this document.

Returns:

A string of text

getMetaData

public Reference2ObjectMap<Enum<?>,Object> getMetaData()

Get the metadata for this document.

Returns:

map containing metadata