nl.inl.blacklab.search.lucene

Enum SpanQueryPositionFilter.Operation

java.lang.Object

java.lang.Enum<SpanQueryPositionFilter.Operation>

nl.inl.blacklab.search.lucene.SpanQueryPositionFilter.Operation

All Implemented Interfaces:

Serializable, Comparable<SpanQueryPositionFilter.Operation>

Enclosing class:

SpanQueryPositionFilter

public static enum SpanQueryPositionFilter.Operation
extends Enum<SpanQueryPositionFilter.Operation>

The different positional operations

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTAINING Producer hit contains filter hit
CONTAINING_AT_END Producer hit contains filter hit, at its start
CONTAINING_AT_START Producer hit contains filter hit, at its end
ENDS_AT Producer hit ends at filter hit
MATCHES Producer hit exactly matches filter hit
STARTS_AT Producer hit starts at filter hit
WITHIN Producer hit contained in filter hit

Method Summary

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

CONTAINING

public static final SpanQueryPositionFilter.Operation CONTAINING

Producer hit contains filter hit

WITHIN

public static final SpanQueryPositionFilter.Operation WITHIN

Producer hit contained in filter hit

STARTS_AT

public static final SpanQueryPositionFilter.Operation STARTS_AT

Producer hit starts at filter hit

ENDS_AT

public static final SpanQueryPositionFilter.Operation ENDS_AT

Producer hit ends at filter hit

MATCHES

public static final SpanQueryPositionFilter.Operation MATCHES

Producer hit exactly matches filter hit

CONTAINING_AT_START

public static final SpanQueryPositionFilter.Operation CONTAINING_AT_START

Producer hit contains filter hit, at its end

CONTAINING_AT_END

public static final SpanQueryPositionFilter.Operation CONTAINING_AT_END

Producer hit contains filter hit, at its start

Method Detail

values

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

Returns:

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

valueOf

public static SpanQueryPositionFilter.Operation 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