gate.mimir.index

Class DocumentData

java.lang.Object

gate.mimir.index.DocumentData

All Implemented Interfaces:

Serializable

public class DocumentData
extends Object
implements Serializable

A container for the document data that gets stored in the zip collection.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	documentTitle The Document title.
protected String	documentURI The Document URI
protected HashMap<String,Serializable>	metadata A HashMap of arbitrary metadata (all fields must be Serializable).
protected String[]	nonTokens The non-tokens (i.e.
protected String[]	tokens The tokens of the document.

Constructor Summary

Constructors

Constructor and Description
DocumentData(String documentURI, String documentTitle, String[] tokens, String[] nonTokens) Constructs a new DocumentData object.

Method Summary

Modifier and Type	Method and Description
String	getDocumentTitle()
String	getDocumentURI()
Serializable	getMetadataField(String fieldName) Gets the value of a metadata field.
String[]	getNonTokens()
String[][]	getText(int termPosition, int length)
String[]	getTokens()
void	putMetadataField(String fieldName, Serializable fieldValue) Adds a new arbitrary metadata field.

Methods inherited from class java.lang.Object

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

Field Detail

tokens

protected String[] tokens

The tokens of the document.

nonTokens

protected String[] nonTokens

The non-tokens (i.e. spaces) of the document.

documentURI

protected String documentURI

The Document URI

documentTitle

protected String documentTitle

The Document title.

metadata

protected HashMap<String,Serializable> metadata

A HashMap of arbitrary metadata (all fields must be Serializable).

Constructor Detail

DocumentData

public DocumentData(String documentURI,
                    String documentTitle,
                    String[] tokens,
                    String[] nonTokens)

Constructs a new DocumentData object.

Parameters:

documentURI - the URI of the document.

documentTitle - the title of the document.

tokens - the document tokens.

nonTokens - the document non-tokens (i.e. spaces).

Method Detail

putMetadataField

public void putMetadataField(String fieldName,
                             Serializable fieldValue)

Adds a new arbitrary metadata field.

Parameters:

fieldName - the name for the new field.

fieldValue - the value for the new field. The value provided here must be Serializable. The map of metadata fields is stored separately for each individual document; care should be taken to limit the size of the object graph that is serialised!

getMetadataField

public Serializable getMetadataField(String fieldName)

Gets the value of a metadata field.

Parameters:

fieldName - the name of field to be returned.

Returns:

the value previously stored in the metadata map for this field.

getTokens

public String[] getTokens()

Returns:

the tokens

getNonTokens

public String[] getNonTokens()

Returns:

the nonTokens

getText

public String[][] getText(int termPosition,
                          int length)

getDocumentURI

public String getDocumentURI()

Returns:

the documentURI

getDocumentTitle

public String getDocumentTitle()

Returns:

the documentTitle