com.hcl.domino.data

Enum FTQuery

java.lang.Object

java.lang.Enum<FTQuery>

com.hcl.domino.data.FTQuery

All Implemented Interfaces:

INumberEnum<Integer>, Serializable, Comparable<FTQuery>

public enum FTQuery
extends Enum<FTQuery>
implements INumberEnum<Integer>

These values define the options you may specify in the options parameter when performing a full text search in a database. These options may be combined.

Author:

Karsten Lehmann

Enum Constant Summary

Enum Constants

Enum Constant and Description
FUZZY set if fuzzy search wanted
NOINDEX Search w/o index, requires a IDTable to specify the docs to create a temporary index.
NUMDOCS_ONLY Return # hits only; not the documents
REFINE Refine the query using the IDTable
RETURN_HIGHLIGHT_STRINGS return highlight strings
RETURN_IDTABLE Return ID table, can be read via FTQueryResult.getMatchesWithScore()
SCORES Return document scores (default sort)
SORT_ASCENDING Sort in ascending order (e.g.
SORT_DATE_CREATED Sort by created date (default is to sort by modified date)
SORT_DATE_MODIFIED Sort results by last modified date (modified in this replica, returned by DominoOriginatorId.getSequenceTime() in the OID read via Document.getOID()
STEM_WORDS Stem words in this query
THESAURUS_WORDS Thesaurus words in this query
TOP_SCORES Use Limit arg.

Method Summary

Modifier and Type	Method and Description
long	getLongValue()
Integer	getValue()
static FTQuery	valueOf(String name) Returns the enum constant of this type with the specified name.
static FTQuery[]	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

NUMDOCS_ONLY

public static final FTQuery NUMDOCS_ONLY

Return # hits only; not the documents

REFINE

public static final FTQuery REFINE

Refine the query using the IDTable

SCORES

public static final FTQuery SCORES

Return document scores (default sort)

RETURN_IDTABLE

public static final FTQuery RETURN_IDTABLE

Return ID table, can be read via FTQueryResult.getMatchesWithScore()

TOP_SCORES

public static final FTQuery TOP_SCORES

Use Limit arg. to return only top scores

STEM_WORDS

public static final FTQuery STEM_WORDS

Stem words in this query

THESAURUS_WORDS

public static final FTQuery THESAURUS_WORDS

Thesaurus words in this query

NOINDEX

public static final FTQuery NOINDEX

Search w/o index, requires a IDTable to specify the docs to create a temporary index. By default, not more than 5000 docs can be specified here. Use Notes.ini variable TEMP_INDEX_MAX_DOC to increase this limit.
See this technote for details:
Error: '...Maximum allowable documents exceeded for a temporary index' in log

FUZZY

public static final FTQuery FUZZY

set if fuzzy search wanted

RETURN_HIGHLIGHT_STRINGS

public static final FTQuery RETURN_HIGHLIGHT_STRINGS

return highlight strings

SORT_DATE_MODIFIED

public static final FTQuery SORT_DATE_MODIFIED

Sort results by last modified date (modified in this replica, returned by DominoOriginatorId.getSequenceTime() in the OID read via Document.getOID()

SORT_DATE_CREATED

public static final FTQuery SORT_DATE_CREATED

Sort by created date (default is to sort by modified date)

SORT_ASCENDING

public static final FTQuery SORT_ASCENDING

Sort in ascending order (e.g. ascending score when combined with SCORES )

Method Detail

values

public static FTQuery[] 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 (FTQuery c : FTQuery.values())
    System.out.println(c);

Returns:

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

valueOf

public static FTQuery 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 Integer getValue()

Specified by:

getValue in interface INumberEnum<Integer>

Returns:

the C-level value of the enum

getLongValue

public long getLongValue()

Specified by:

getLongValue in interface INumberEnum<Integer>

Returns:

the C-level value of the enum as a long