com.allanbank.mongodb.bson.element

Class RegularExpressionElement

java.lang.Object

com.allanbank.mongodb.bson.element.AbstractElement

com.allanbank.mongodb.bson.element.RegularExpressionElement

All Implemented Interfaces:

Element, ElementAssignable, Serializable, Comparable<Element>

public class RegularExpressionElement
extends AbstractElement

A wrapper for a BSON regular expression.

See Also:

Serialized Form

API Notice:

This class 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 ©:

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	CASE_INSENSITIVE Option for case insensitive matching.
static int	DOT_ALL Option for dotall mode ('.' matches everything).
static int	LOCALE_DEPENDENT Option to make \w, \W, etc.
static int	MULTILINE Option for multiline matching.
static int	OPTION_I Option for case insensitive matching.
static int	OPTION_L Option to make \w, \W, etc.
static int	OPTION_M Option for multiline matching.
static int	OPTION_MASK Option for verbose mode.
static int	OPTION_S Option for dotall mode ('.' matches everything).
static int	OPTION_U Option to make \w, \W, etc.
static int	OPTION_X Option for verbose mode.
protected static int	PATTERN_UNICODE Option to make \w, \W, etc.
static ElementType	TYPE The BSON type for a string.
static int	UNICODE Option to make \w, \W, etc.
static int	VERBOSE Option for verbose mode.

Fields inherited from class com.allanbank.mongodb.bson.element.AbstractElement

ELEMENT_TYPE

Constructor Summary

Constructors

Constructor and Description
RegularExpressionElement(String name, Pattern pattern) Constructs a new RegularExpressionElement.
RegularExpressionElement(String name, String pattern, int options) Constructs a new RegularExpressionElement.
RegularExpressionElement(String name, String pattern, int options, long size) Constructs a new RegularExpressionElement.
RegularExpressionElement(String name, String pattern, String options) Constructs a new RegularExpressionElement.
RegularExpressionElement(String name, String pattern, String options, long size) Constructs a new RegularExpressionElement.

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(Visitor visitor) Accepts the visitor and calls the Visitor.visitRegularExpression(java.lang.String, java.lang.String, java.lang.String) method.
int	compareTo(Element otherElement)
boolean	equals(Object object) Determines if the passed object is of this same type as this object and if so that its fields are equal.
int	getOptions() Returns the regular expression options.
String	getPattern() Returns the regular expression pattern.
ElementType	getType() Returns the type for the BSON type.
Pattern	getValueAsObject() Returns the value for BSON element as a Java Object type.
int	hashCode() Computes a reasonable hash code.
protected static int	optionsAsInt(Pattern pattern) Converts the pattern flags into a options value.
protected static int	optionsAsInt(String options) Converts the options string into a options value.
RegularExpressionElement	withName(String name) Creates a new element with the same type and value as this element but with the specified name.

Methods inherited from class com.allanbank.mongodb.bson.element.AbstractElement

asElement, find, find, findFirst, findFirst, getName, getValueAsString, nullSafeEquals, size, toString

Methods inherited from class java.lang.Object

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

Field Detail

CASE_INSENSITIVE

public static final int CASE_INSENSITIVE

Option for case insensitive matching.

DOT_ALL

public static final int DOT_ALL

Option for dotall mode ('.' matches everything).

LOCALE_DEPENDENT

public static final int LOCALE_DEPENDENT

Option to make \w, \W, etc. locale dependent.

MULTILINE

public static final int MULTILINE

Option for multiline matching.

OPTION_I

public static final int OPTION_I

Option for case insensitive matching.

OPTION_L

public static final int OPTION_L

Option to make \w, \W, etc. locale dependent.

OPTION_M

public static final int OPTION_M

Option for multiline matching.

OPTION_MASK

public static final int OPTION_MASK

Option for verbose mode.

OPTION_S

public static final int OPTION_S

Option for dotall mode ('.' matches everything).

OPTION_U

public static final int OPTION_U

Option to make \w, \W, etc. match unicode.

OPTION_X

public static final int OPTION_X

Option for verbose mode.

TYPE

public static final ElementType TYPE

The BSON type for a string.

UNICODE

public static final int UNICODE

Option to make \w, \W, etc. match unicode.

VERBOSE

public static final int VERBOSE

Option for verbose mode.

PATTERN_UNICODE

protected static final int PATTERN_UNICODE

Option to make \w, \W, etc. match unicode from the pattern class. Added in Java7

Constructor Detail

RegularExpressionElement

public RegularExpressionElement(String name,
                        Pattern pattern)

Constructs a new RegularExpressionElement.

Parameters:

name - The name for the BSON string.

pattern - The regular expression Pattern.

Throws:

IllegalArgumentException - If the name or pattern is null.

RegularExpressionElement

public RegularExpressionElement(String name,
                        String pattern,
                        int options)

Constructs a new RegularExpressionElement.

Parameters:

name - The name for the BSON string.

pattern - The BSON regular expression pattern.

options - The BSON regular expression options.

Throws:

IllegalArgumentException - If the name or pattern is null.

RegularExpressionElement

public RegularExpressionElement(String name,
                        String pattern,
                        int options,
                        long size)

Constructs a new RegularExpressionElement.

Parameters:

name - The name for the BSON string.

pattern - The BSON regular expression pattern.

options - The BSON regular expression options.

size - The size of the element when encoded in bytes. If not known then use the RegularExpressionElement(String, String, int) constructor instead.

Throws:

IllegalArgumentException - If the name or pattern is null.

RegularExpressionElement

public RegularExpressionElement(String name,
                        String pattern,
                        String options)

Constructs a new RegularExpressionElement.

Parameters:

name - The name for the BSON string.

pattern - The BSON regular expression pattern.

options - The BSON regular expression options.

Throws:

IllegalArgumentException - If the name or pattern is null.

RegularExpressionElement

public RegularExpressionElement(String name,
                        String pattern,
                        String options,
                        long size)

Constructs a new RegularExpressionElement.

Parameters:

name - The name for the BSON string.

pattern - The BSON regular expression pattern.

options - The BSON regular expression options.

size - The size of the element when encoded in bytes. If not known then use the RegularExpressionElement(String, String, String) constructor instead.

Throws:

IllegalArgumentException - If the name or pattern is null.

Method Detail

optionsAsInt

protected static int optionsAsInt(Pattern pattern)

Converts the pattern flags into a options value.

Note that the VERBOSE and LOCALE_DEPENDENT do not have Pattern equivalent flags.

 Pattern.CASE_INSENSITIVE ==> CASE_INSENSITIVE
 Pattern.MULTILINE ==> MULTILINE
 Pattern.DOTALL ==> DOT_ALL
 Pattern.UNICODE_CHARACTER_CLASS ==> UNICODE
 

Parameters:

pattern - The pattern to extract the options from.

Returns:

The options integer value.

optionsAsInt

protected static int optionsAsInt(String options)

Converts the options string into a options value.

Parameters:

options - The possibly non-normalized options string.

Returns:

The options integer value.

accept

public void accept(Visitor visitor)

Accepts the visitor and calls the Visitor.visitRegularExpression(java.lang.String, java.lang.String, java.lang.String) method.

Parameters:

visitor - The visitor for the element.

See Also:

Element.accept(Visitor)

compareTo

public int compareTo(Element otherElement)

Overridden to compare the elements based on the tuple (name, type, value).

Overridden to compare the elements based on the tuple (name, type). Derived classes are responsible for the value portion of the full comparison.

Overridden to compare the expressions (as strings) if the base class comparison is equals.

Specified by:

compareTo in interface Element

Specified by:

compareTo in interface Comparable<Element>

Overrides:

compareTo in class AbstractElement

equals

public boolean equals(Object object)

Determines if the passed object is of this same type as this object and if so that its fields are equal.

Overrides:

equals in class AbstractElement

Parameters:

object - The object to compare to.

See Also:

Object.equals(java.lang.Object)

getOptions

public int getOptions()

Returns the regular expression options.

Returns:

The regular expression options.

getPattern

public String getPattern()

Returns the regular expression pattern.

Returns:

The regular expression pattern.

getType

public ElementType getType()

Returns the type for the BSON type.

Returns:

The type for the BSON type.

getValueAsObject

public Pattern getValueAsObject()

Returns the value for BSON element as a Java Object type.

Automatic conversion from the Object-ified value to an element is provided via the DocumentBuilder.add(String, Object) method. Not all element types will be successfully converted to the same element duing a Element-->Object value-->Element conversion. This cases are noted in the appropriate sub-type's JavaDoc.

Sub-types will also overload this method with the appropriate type returned. e.g., The StringElement.getValueAsObject() method signature returns a String.

Returns the Pattern.

Returns:

The value for BSON element as a Java Object type.

hashCode

public int hashCode()

Computes a reasonable hash code.

Overrides:

hashCode in class AbstractElement

Returns:

The hash code value.

withName

public RegularExpressionElement withName(String name)

Creates a new element with the same type and value as this element but with the specified name. This is useful when creating a query across a set of collections where the filed name changes in the collections but the values must be identical.

Returns a new RegularExpressionElement.

Parameters:

name - The new name for the element.

Returns:

The created element.