net.ontopia.infoset.fulltext.core

Interface FieldIF

All Known Implementing Classes:

GenericField, LuceneField, RDBMSField

public interface FieldIF

INTERNAL: Represents a name value pair that can be attached to a document.

Method Summary

Modifier and Type	Method and Description
String	getName() INTERNAL: Returns the name of the field.
Reader	getReader() INTERNAL: Returns the Reader value of the field.
String	getValue() INTERNAL: Returns the String value of the field.
boolean	isIndexed() INTERNAL: Returns true if the field is to be indexed, so that it may be searched on.
boolean	isStored() INTERNAL: Returns true if the field is to be stored in the index for return with search hits.
boolean	isTokenized() INTERNAL: Returns true if the field is to be tokenized prior to indexing.

Method Detail

getName

String getName()

INTERNAL: Returns the name of the field.

getValue

String getValue()

INTERNAL: Returns the String value of the field. Note that null is returned if the field has a reader set.

getReader

Reader getReader()

INTERNAL: Returns the Reader value of the field. Note that null is returned if the field has a value set.

isStored

boolean isStored()

INTERNAL: Returns true if the field is to be stored in the index for return with search hits.

isIndexed

boolean isIndexed()

INTERNAL: Returns true if the field is to be indexed, so that it may be searched on.

isTokenized

boolean isTokenized()

INTERNAL: Returns true if the field is to be tokenized prior to indexing.