Package org.apache.jackrabbit.commons.query.qom

Enum Operator

java.lang.Object

java.lang.Enum<Operator>

org.apache.jackrabbit.commons.query.qom.Operator

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Operator>

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

Enumeration of the JCR 2.0 query operators.

Since:

Apache Jackrabbit 2.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
EQ
GE
GT
LE
LIKE
LT
NE

Method Summary

Modifier and Type	Method	Description
Comparison	comparison(QueryObjectModelFactory factory, DynamicOperand left, StaticOperand right)	Returns a comparison between the given operands using this operator.
java.lang.String	formatSql(java.lang.String a, java.lang.String b)	Formats an SQL constraint with this operator and the given operands.
java.lang.String	formatXpath(java.lang.String a, java.lang.String b)	Formats an XPath constraint with this operator and the given operands.
static java.lang.String[]	getAllQueryOperators()	Returns an array of the names of all the JCR 2.0 query operators.
static Operator	getOperatorByName(java.lang.String name)	Returns the operator with the given JCR name.
java.lang.String	toString()	Returns the JCR 2.0 name of this query operator.
static Operator	valueOf(java.lang.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

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EQ

public static final Operator EQ

NE

public static final Operator NE

GT

public static final Operator GT

GE

public static final Operator GE

LT

public static final Operator LT

LE

public static final Operator LE

LIKE

public static final Operator LIKE

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(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

comparison

public Comparison comparison(QueryObjectModelFactory factory,
                             DynamicOperand left,
                             StaticOperand right)
                      throws RepositoryException

Returns a comparison between the given operands using this operator.

Parameters:

factory - factory for creating the comparison

left - operand on the left hand side

right - operand on the right hand side

Returns:

comparison

Throws:

RepositoryException - if the comparison can not be created

formatXpath

public java.lang.String formatXpath(java.lang.String a,
                                    java.lang.String b)

Formats an XPath constraint with this operator and the given operands. The operands are simply used as-is, without any quoting or escaping.

Parameters:

a - first operand

b - second operand

Returns:

XPath constraint, a op b or jcr:like(a, b) for LIKE

formatSql

public java.lang.String formatSql(java.lang.String a,
                                  java.lang.String b)

Formats an SQL constraint with this operator and the given operands. The operands are simply used as-is, without any quoting or escaping.

Parameters:

a - first operand

b - second operand

Returns:

SQL constraint, a op b

toString

public java.lang.String toString()

Returns the JCR 2.0 name of this query operator.

Overrides:

toString in class java.lang.Enum<Operator>

Returns:

JCR name of this operator

See Also:

QueryObjectModelConstants

getAllQueryOperators

public static java.lang.String[] getAllQueryOperators()

Returns an array of the names of all the JCR 2.0 query operators.

Returns:

names of all query operators

getOperatorByName

public static Operator getOperatorByName(java.lang.String name)
                                  throws RepositoryException

Returns the operator with the given JCR name.

Parameters:

name - JCR name of an operator

Returns:

operator with the given name

Throws:

RepositoryException - if the given name is unknown