it.cnr.isti.hpc.dexter.document

Class FlatDocument

java.lang.Object

it.cnr.isti.hpc.dexter.document.Document

it.cnr.isti.hpc.dexter.document.MultifieldDocument

it.cnr.isti.hpc.dexter.document.FlatDocument

All Implemented Interfaces:

Serializable

public class FlatDocument
extends MultifieldDocument

A FlatDocument is a Document with only one Field.
For simplicity the name of that field will be: "body".

Author:

Salvatore Trani, salvatore.trani@isti.cnr.it created on 18/sept/2013

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	fieldName

Fields inherited from class it.cnr.isti.hpc.dexter.document.MultifieldDocument

fields

Constructor Summary

Constructors

Constructor and Description
FlatDocument()
FlatDocument(File file) FlatDocument build with the content taken from a file
FlatDocument(String text) FlatDocument build with the "text" value as unique field

Method Summary

Methods

Modifier and Type	Method and Description
void	addField(Field field) Adds a field to a document.
void	removeField(String name) Removes field with the specified name from the document.
void	setContent(String content) Set the content of the flat document (the body field)

Methods inherited from class it.cnr.isti.hpc.dexter.document.MultifieldDocument

getContent, getField, getFields

Methods inherited from class java.lang.Object

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

Field Detail

fieldName

protected final String fieldName

See Also:

Constant Field Values

Constructor Detail

FlatDocument

public FlatDocument()

FlatDocument

public FlatDocument(String text)

FlatDocument build with the "text" value as unique field

Parameters:

text - The content of the unique "body" field of the document

FlatDocument

public FlatDocument(File file)

FlatDocument build with the content taken from a file

Parameters:

file - The file where the content has to be taken

Method Detail

setContent

public void setContent(String content)

Set the content of the flat document (the body field)

Parameters:

content - The content of the document

addField

public void addField(Field field)

Description copied from class: MultifieldDocument

Adds a field to a document. Only one field may be added with the same name. In this case, if the fields are already in the document, it will be overwritten.

Overrides:

addField in class MultifieldDocument

Parameters:

field - The field to add to the document

removeField

public void removeField(String name)

Description copied from class: MultifieldDocument

Removes field with the specified name from the document. If there is no field with the specified name, the document remains unchanged.

Overrides:

removeField in class MultifieldDocument

Parameters:

name - The name of the field to remove from the document's fields