com.allanbank.mongodb.builder

Enum MiscellaneousOperator

java.lang.Object

java.lang.Enum<MiscellaneousOperator>

com.allanbank.mongodb.builder.MiscellaneousOperator

All Implemented Interfaces:

Operator, Serializable, Comparable<MiscellaneousOperator>

public enum MiscellaneousOperator
extends Enum<MiscellaneousOperator>
implements Operator

MiscellaneousOperator provides the set of miscellaneous operators.

API Notice:

This enumeration is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2012-2013, Allanbank Consulting, Inc., All Rights Reserved

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Operator to ensure that all values provided in the operand existing in the array field.
COMMENT A pseudo-operator to add a comment to a query.
ELEMENT_MATCH Provides the ability to match an entire array element at once.
EXISTS Check to see if a field exists or not.
IN Checks if a value for a field is present in the operand array.
MOD Performs a modulo operation on a field and is equivalent to the where statement field % d == m.
NIN Checks if a value for a field is not present in the operand array.
REG_EX Test if a field matches a specified regular expression.
SIZE Compares the length of the array field.
TEXT Support for text searches.
TYPE Check if a value's type matches the expected type.
WHERE Support for an ad-hoc JavaScript expression.

Field Summary

Fields

Modifier and Type	Field and Description
static String	LANGUAGE_MODIFIER The modifier for the TEXT operator to specify the language of the query terms.
static String	SEARCH_MODIFIER The modifier for the TEXT operator to specify the the query terms.

Method Summary

Methods

Modifier and Type	Method and Description
String	getToken() The token for the operator that can be sent to the server.
Version	getVersion() Returns the first MongoDB version to support the operator.
static MiscellaneousOperator	valueOf(String name) Returns the enum constant of this type with the specified name.
static MiscellaneousOperator[]	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

ALL

public static final MiscellaneousOperator ALL

Operator to ensure that all values provided in the operand existing in the array field.

COMMENT

public static final MiscellaneousOperator COMMENT

A pseudo-operator to add a comment to a query.

Since:

MongoDB 2.2

ELEMENT_MATCH

public static final MiscellaneousOperator ELEMENT_MATCH

Provides the ability to match an entire array element at once.

EXISTS

public static final MiscellaneousOperator EXISTS

Check to see if a field exists or not.

IN

public static final MiscellaneousOperator IN

Checks if a value for a field is present in the operand array.

MOD

public static final MiscellaneousOperator MOD

Performs a modulo operation on a field and is equivalent to the where statement field % d == m.

NIN

public static final MiscellaneousOperator NIN

Checks if a value for a field is not present in the operand array.

REG_EX

public static final MiscellaneousOperator REG_EX

Test if a field matches a specified regular expression.

SIZE

public static final MiscellaneousOperator SIZE

Compares the length of the array field.

TEXT

public static final MiscellaneousOperator TEXT

Support for text searches.

Since:

MongoDB 2.6

TYPE

public static final MiscellaneousOperator TYPE

Check if a value's type matches the expected type.

WHERE

public static final MiscellaneousOperator WHERE

Support for an ad-hoc JavaScript expression.

Field Detail

LANGUAGE_MODIFIER

public static final String LANGUAGE_MODIFIER

The modifier for the TEXT operator to specify the language of the query terms.

Since:

MongoDB 2.6

See Also:

Constant Field Values

SEARCH_MODIFIER

public static final String SEARCH_MODIFIER

The modifier for the TEXT operator to specify the the query terms.

Since:

MongoDB 2.6

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getToken

public String getToken()

The token for the operator that can be sent to the server.

Specified by:

getToken in interface Operator

Returns:

The token for the operator.

getVersion

public Version getVersion()

Returns the first MongoDB version to support the operator.

Specified by:

getVersion in interface Operator

Returns:

The first MongoDB version to support the operator. If null then the version is not known and can be assumed to be all currently supported versions.