com.simba.dsi.dataengine.utilities
Enum Searchable

java.lang.Object
  extended by java.lang.Enum<Searchable>
      extended by com.simba.dsi.dataengine.utilities.Searchable
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Searchable>

public enum Searchable
extends java.lang.Enum<Searchable>

A Searchable is used to indicate how a column may be used with a WHERE clause.


Enum Constant Summary
PREDICATE_BASIC
          Indicates that the column may be used in a WHERE clause with all of the comparison operators except LIKE.
PREDICATE_CHAR
          Indicates that the column may be used in a WHERE clause only with the LIKE operator.
PREDICATE_NONE
          Indicates that the column may not be used in a WHERE clause.
SEARCHABLE
          Indicates that the column may be used in a WHERE clause with any comparison operator.
 
Method Summary
static Searchable getEnumByValue(int value)
          Get the Searchable that matches the input value.
 int getIntValue()
          Get the The Searchable number.
static Searchable valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Searchable[] 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

PREDICATE_NONE

public static final Searchable PREDICATE_NONE
Indicates that the column may not be used in a WHERE clause.


PREDICATE_CHAR

public static final Searchable PREDICATE_CHAR
Indicates that the column may be used in a WHERE clause only with the LIKE operator.


PREDICATE_BASIC

public static final Searchable PREDICATE_BASIC
Indicates that the column may be used in a WHERE clause with all of the comparison operators except LIKE.


SEARCHABLE

public static final Searchable SEARCHABLE
Indicates that the column may be used in a WHERE clause with any comparison operator.

Method Detail

values

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

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

valueOf

public static Searchable valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

getEnumByValue

public static Searchable getEnumByValue(int value)
Get the Searchable that matches the input value. An unknown input will result in a null Searchable being returned.

Parameters:
value - The value of the Searchable.
Returns:
The Searchable that matches the value.

getIntValue

public int getIntValue()
Get the The Searchable number.

Returns:
Searchable number.


Copyright © 2006-2014 Simba Technologies Incorporated. All Rights Reserved.