net.ontopia.infoset.fulltext.core

Class GenericField

java.lang.Object

net.ontopia.infoset.fulltext.core.GenericField

All Implemented Interfaces:

FieldIF

public class GenericField
extends Object
implements FieldIF

INTERNAL: A generic document field.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	index
protected String	name
protected Reader	reader
protected boolean	store
protected boolean	tokenize
protected String	value

Constructor Summary

Constructors

Constructor and Description
GenericField(String name, Reader value, boolean store, boolean index, boolean tokenize)
GenericField(String name, String value, boolean store, boolean index, boolean tokenize)

Method Summary

Modifier and Type	Method and Description
static FieldIF	createKeywordField(String name, String value)
static FieldIF	createTextField(String name, String value)
static FieldIF	createUnstoredField(String name, Reader reader)
static FieldIF	createUnstoredField(String name, String value)
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.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

value

protected String value

reader

protected Reader reader

store

protected boolean store

index

protected boolean index

tokenize

protected boolean tokenize

Constructor Detail

GenericField

public GenericField(String name,
                    String value,
                    boolean store,
                    boolean index,
                    boolean tokenize)

GenericField

public GenericField(String name,
                    Reader value,
                    boolean store,
                    boolean index,
                    boolean tokenize)

Method Detail

createUnstoredField

public static FieldIF createUnstoredField(String name,
                                          String value)

createUnstoredField

public static FieldIF createUnstoredField(String name,
                                          Reader reader)

createKeywordField

public static FieldIF createKeywordField(String name,
                                         String value)

createTextField

public static FieldIF createTextField(String name,
                                      String value)

getName

public String getName()

Description copied from interface: FieldIF

INTERNAL: Returns the name of the field.

Specified by:

getName in interface FieldIF

getValue

public String getValue()

Description copied from interface: FieldIF

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

Specified by:

getValue in interface FieldIF

getReader

public Reader getReader()

Description copied from interface: FieldIF

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

Specified by:

getReader in interface FieldIF

isStored

public boolean isStored()

Description copied from interface: FieldIF

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

Specified by:

isStored in interface FieldIF

isIndexed

public boolean isIndexed()

Description copied from interface: FieldIF

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

Specified by:

isIndexed in interface FieldIF

isTokenized

public boolean isTokenized()

Description copied from interface: FieldIF

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

Specified by:

isTokenized in interface FieldIF