org.apache.maven.index
Enum SearchType

java.lang.Object
  java.lang.Enum<SearchType>
      org.apache.maven.index.SearchType

All Implemented Interfaces:

Serializable, Comparable<SearchType>

public enum SearchType
extends Enum<SearchType>

Designated search types that NexusIndexer supports.

Author:

cstamas

Enum Constant Summary

EXACT
Exact search types are usually meant for applications filtering index content for some exact filtering condition even in a "future proof" way (example with packaging "maven-archetype" vs "foo-archetype-maven").

SCORED
Scored search types are usually meant for human query input, where loose-matching and result ranking is happening.

Method Summary

boolean	matchesIndexerField(IndexerField field)
static SearchType	valueOf(String name) Returns the enum constant of this type with the specified name.
static SearchType[]	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

SCORED

public static final SearchType SCORED

Scored search types are usually meant for human query input, where loose-matching and result ranking is happening. The order of index hits is important, since it will reflect the hits ordered by score (1st hit, best match, last hit worst).

EXACT

public static final SearchType EXACT

Exact search types are usually meant for applications filtering index content for some exact filtering condition even in a "future proof" way (example with packaging "maven-archetype" vs "foo-archetype-maven").

Method Detail

values

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

Returns:

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

valueOf

public static SearchType 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

matchesIndexerField

public boolean matchesIndexerField(IndexerField field)