net.sf.farrago.fennel.rel
Enum FennelSearchEndpoint

java.lang.Object
  java.lang.Enum<FennelSearchEndpoint>
      net.sf.farrago.fennel.rel.FennelSearchEndpoint

All Implemented Interfaces:

Serializable, Comparable<FennelSearchEndpoint>

public enum FennelSearchEndpoint
extends Enum<FennelSearchEndpoint>

FennelSearchEndpoint defines an enumeration corresponding to fennel/common/SearchEndpoint.h. Any changes there must be applied here as well.

Version:

$Id: //open/dev/farrago/src/net/sf/farrago/fennel/rel/FennelSearchEndpoint.java#1 $

Author:

John V. Sichi

Enum Constant Summary

SEARCH_CLOSED_LOWER
Defines the beginning of an interval which has a closed bound below.

SEARCH_CLOSED_UPPER
Defines the end of an interval which has a closed bound above.

SEARCH_OPEN_LOWER
Defines the beginning of an interval which has an open bound below.

SEARCH_OPEN_UPPER
Defines the end of an interval which has an open bound above.

SEARCH_UNBOUNDED_LOWER
Defines the beginning of an interval which is unbounded below.

SEARCH_UNBOUNDED_UPPER
Defines the end of an interval which is unbounded above.

Field Summary

private String

symbol

Method Summary

String	getSymbol()
static FennelSearchEndpoint	valueOf(String name) Returns the enum constant of this type with the specified name.
static FennelSearchEndpoint[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SEARCH_UNBOUNDED_LOWER

public static final FennelSearchEndpoint SEARCH_UNBOUNDED_LOWER

Defines the beginning of an interval which is unbounded below. The associated key value should be all null.

SEARCH_OPEN_LOWER

public static final FennelSearchEndpoint SEARCH_OPEN_LOWER

Defines the beginning of an interval which has an open bound below.

SEARCH_CLOSED_LOWER

public static final FennelSearchEndpoint SEARCH_CLOSED_LOWER

Defines the beginning of an interval which has a closed bound below.

SEARCH_OPEN_UPPER

public static final FennelSearchEndpoint SEARCH_OPEN_UPPER

Defines the end of an interval which has an open bound above.

SEARCH_CLOSED_UPPER

public static final FennelSearchEndpoint SEARCH_CLOSED_UPPER

Defines the end of an interval which has a closed bound above.

SEARCH_UNBOUNDED_UPPER

public static final FennelSearchEndpoint SEARCH_UNBOUNDED_UPPER

Defines the end of an interval which is unbounded above. The associated key value should be all null.

Field Detail

symbol

private final String symbol

Method Detail

values

public static final FennelSearchEndpoint[] values()

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

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

Returns:

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

valueOf

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

getSymbol

public String getSymbol()

Returns:

symbol used to communicate endpoint type to Fennel