com.hcl.domino.data

Enum FTIndex

java.lang.Object

java.lang.Enum<FTIndex>

com.hcl.domino.data.FTIndex

All Implemented Interfaces:

INumberEnum<Short>, Serializable, Comparable<FTIndex>

public enum FTIndex
extends Enum<FTIndex>
implements INumberEnum<Short>

These values define the options used when creating a full text index for a database.
These options may be combined as a Set.
However, AUTOOPTIONS will ignore all other indexing options and therefore should not be OR-ed with any of the other indexing options.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTOOPTIONS Use the index options that are in database.
CASE_SENSITIVE Build case sensitive index
ENCRYPTED_FIELDS Index Encrypted Fields
INDEX_ATTACHED_FILES Index Attachments
INDEX_SENTENCE_PARAGRAPH_BREAKS Build index with word, sentence, and paragraph index break option which allows a search for words within a sentence or paragraph.
OPTIMIZE Optimize index (e.g.
REINDEX Forces re-indexing the database from scratch.
STEM_INDEX Build an index that includes word variants (stems).
SUMMARY_ONLY Index summary data only
USE_CONVERSION_FILTERS_FOR_FILES Index all attachments including BINARY formats

Method Summary

Modifier and Type	Method and Description
long	getLongValue()
Short	getValue()
static FTIndex	valueOf(String name) Returns the enum constant of this type with the specified name.
static FTIndex[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

REINDEX

public static final FTIndex REINDEX

Forces re-indexing the database from scratch. This option is useful if the indexing options for the database are being changed.

CASE_SENSITIVE

public static final FTIndex CASE_SENSITIVE

Build case sensitive index

STEM_INDEX

public static final FTIndex STEM_INDEX

Build an index that includes word variants (stems). This allows searching to include word variants. A full text search index built with the Notes user interface, is automatically stemmed.

INDEX_SENTENCE_PARAGRAPH_BREAKS

public static final FTIndex INDEX_SENTENCE_PARAGRAPH_BREAKS

Build index with word, sentence, and paragraph index break option which allows a search for words within a sentence or paragraph.

OPTIMIZE

public static final FTIndex OPTIMIZE

Optimize index (e.g. for CDROM) (Not used)

INDEX_ATTACHED_FILES

public static final FTIndex INDEX_ATTACHED_FILES

Index Attachments

ENCRYPTED_FIELDS

public static final FTIndex ENCRYPTED_FIELDS

Index Encrypted Fields

AUTOOPTIONS

public static final FTIndex AUTOOPTIONS

Use the index options that are in database. If the database has never been indexed, use the default indexing options. Database indexing options include the Stop Word File name, case sensitivity, the PSW option, reindexing, and the stem index. Note that the stem index will be set if AUTOOPTIONS is used.

SUMMARY_ONLY

public static final FTIndex SUMMARY_ONLY

Index summary data only

USE_CONVERSION_FILTERS_FOR_FILES

public static final FTIndex USE_CONVERSION_FILTERS_FOR_FILES

Index all attachments including BINARY formats

Method Detail

values

public static FTIndex[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FTIndex c : FTIndex.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FTIndex valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public Short getValue()

Specified by:

getValue in interface INumberEnum<Short>

Returns:

the C-level value of the enum

getLongValue

public long getLongValue()

Specified by:

getLongValue in interface INumberEnum<Short>

Returns:

the C-level value of the enum as a long