it.cnr.isti.hpc.dexter.document

Class Document

java.lang.Object

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MultifieldDocument

public abstract class Document
extends Object
implements Serializable

The Document interface defines as a set of fields. Each field has a name and a textual value. Thus each document should typically contain one or more fields which uniquely identify it.
A document can contain only one field with a fixed name (duplicate fields are not supported).

Author:

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Document()

Method Summary

Methods

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

Constructor Detail

Document

public Document()

Method Detail

getField

public abstract Field getField(String name)

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

Parameters:

name - The name of the field to retrieve

Returns:

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

getFields

public abstract Iterator<Field> getFields()

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

Returns:

Iterator over the fields of the document

addField

public abstract 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 overwrited.

Parameters:

field - The field to add to the document

removeField

public abstract 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.

Parameters:

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

getContent

public abstract String getContent()

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

Returns:

The content of the document