it.cnr.isti.hpc.dexter.document

Class MultifieldDocument

java.lang.Object

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

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FlatDocument

public class MultifieldDocument
extends Document

A document with an unordered set of fields.

Author:

Salvatore Trani, salvatore.trani@isti.cnr.it

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Field>	fields

Constructor Summary

Constructors

Constructor and Description
MultifieldDocument() Constructs a new document with no fields.

Method Summary

Methods

Modifier and Type	Method and Description
void	addField(Field field) Adds a field to a document.
String	getContent() Gets the content of the document, appending the content of the different fields belonging to it.
Field	getField(String name) Returns the field with the given name if exists in this document, or null.
Iterator<Field>	getFields() Returns an iterator over the fields being part of this document.
void	removeField(String name) Removes field with the specified name from the document.

Methods inherited from class java.lang.Object

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

Field Detail

fields

protected Map<String,Field> fields

Constructor Detail

MultifieldDocument

public MultifieldDocument()

Constructs a new document with no fields.

Method Detail

getField

public Field getField(String name)

Returns the field with the given name if exists in this document, or null.

Specified by:

getField in class Document

Parameters:

name - The name of the field to retrieve

Returns:

The field relative to the given name, if exist, null otherwise.

getFields

public Iterator<Field> getFields()

Returns an iterator over the fields being part of this document.

Specified by:

getFields in class Document

Returns:

Iterator over the fields of the document

addField

public void addField(Field field)

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.

Specified by:

addField in class Document

Parameters:

field - The field to add to the document

removeField

public void removeField(String name)

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

Specified by:

removeField in class Document

Parameters:

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

getContent

public String getContent()

Gets the content of the document, appending the content of the different fields belonging to it.

Specified by:

getContent in class Document

Returns:

The content of the document