net.sf.basedb.core
Enum Operator

java.lang.Object
  java.lang.Enum<Operator>
      net.sf.basedb.core.Operator

All Implemented Interfaces:

Serializable, Comparable<Operator>

public enum Operator
extends Enum<Operator>

Version:

2.0

Author:

Nicklas, Martin

Enum Constant Summary

AND

EQ

GT

GTEQ

IN

LIKE

LIKE_IN

LT

LTEQ

NEQ

NOT

NOTIN

NOTLIKE

NOTLIKE_IN

OR

RLIKE

Field Summary

private boolean	expressionOperator
private boolean	isListOperator
private String	sqlSymbol
private String	symbol
private int	value
private static Map<Integer,Operator>	valueMapping

Method Summary

static Operator	fromValue(int value) Get the Operator object when you know the integer code.
abstract Restriction	getRestriction(Expression lvalue, Expression rvalue)
abstract Restriction	getRestriction(Expression lvalue, Expression[] rvalues)
String	getSqlSymbol() Get the SQL symbol for this operator.
String	getSymbol() Get the symbol for this operator, useful for display in client applications.
int	getValue() Get the integer value that is used when storing an operator in the database.
boolean	isExpressionOperator()
boolean	isListOperator() Gets if the operator should be used with a list or not.
String	toString()
static Operator	valueOf(String name) Returns the enum constant of this type with the specified name.
static Operator[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AND

public static final Operator AND

OR

public static final Operator OR

NOT

public static final Operator NOT

EQ

public static final Operator EQ

NEQ

public static final Operator NEQ

LT

public static final Operator LT

LTEQ

public static final Operator LTEQ

GT

public static final Operator GT

GTEQ

public static final Operator GTEQ

LIKE

public static final Operator LIKE

NOTLIKE

public static final Operator NOTLIKE

IN

public static final Operator IN

Since:

2.6

NOTIN

public static final Operator NOTIN

Since:

2.6

LIKE_IN

public static final Operator LIKE_IN

Since:

2.6

NOTLIKE_IN

public static final Operator NOTLIKE_IN

Since:

2.6

RLIKE

public static final Operator RLIKE

Since:

2.8

Field Detail

valueMapping

private static final Map<Integer,Operator> valueMapping

value

private final int value

symbol

private final String symbol

sqlSymbol

private final String sqlSymbol

expressionOperator

private final boolean expressionOperator

isListOperator

private final boolean isListOperator

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Overrides:

toString in class Enum<Operator>

getValue

public int getValue()

Get the integer value that is used when storing an operator in the database.

Returns:

an Integer

getSymbol

public String getSymbol()

Get the symbol for this operator, useful for display in client applications.

Returns:

a String object

getSqlSymbol

public String getSqlSymbol()

Get the SQL symbol for this operator. This can be used when creating SQL/HQL queries.

Returns:

A String object

isExpressionOperator

public boolean isExpressionOperator()

getRestriction

public abstract Restriction getRestriction(Expression lvalue,
                                           Expression rvalue)
                                    throws InvalidDataException

Throws:

InvalidDataException

getRestriction

public abstract Restriction getRestriction(Expression lvalue,
                                           Expression[] rvalues)
                                    throws InvalidDataException

Throws:

InvalidDataException

fromValue

public static Operator fromValue(int value)

Get the Operator object when you know the integer code.

Parameters:

value - The integer code

Returns:

an Operator object.

isListOperator

public boolean isListOperator()

Gets if the operator should be used with a list or not. The list items should be separated with '|'.

Returns:

TRUE if it should, FALSE otherwise.

Since:

2,6