net.ontopia.infoset.fulltext.core

Interface DocumentIF

All Known Implementing Classes:

GenericDocument, LuceneDocument, RDBMSDocument, TopicMapDocument

public interface DocumentIF

INTERNAL: Represents an indexable unit of information. A document contains named fields which can have values of the types String or Reader.

Method Summary

Modifier and Type	Method and Description
void	addField(FieldIF field) INTERNAL: Adds the given field to the document.
FieldIF	getField(String name) INTERNAL: Returns the field with the specified name.
Collection<FieldIF>	getFields() INTERNAL: Returns all the fields of this document.
void	removeField(FieldIF field) INTERNAL: Removes the given field from the document.

Method Detail

getField

FieldIF getField(String name)

INTERNAL: Returns the field with the specified name.

getFields

Collection<FieldIF> getFields()

INTERNAL: Returns all the fields of this document.

Returns:

A collection of FieldIF objects.

addField

void addField(FieldIF field)

INTERNAL: Adds the given field to the document.

removeField

void removeField(FieldIF field)

INTERNAL: Removes the given field from the document.