Package dev.morphia.query.filters

Class Filter

java.lang.Object

dev.morphia.query.filters.Filter

Direct Known Subclasses:

GeoIntersectsFilter, GeoWithinFilter, LogicalFilter, NearFilter, RegexFilter, TextSearchFilter

public class Filter
extends Object

Base class for query filters

Since:

2.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Filter(String name)
protected	Filter(String name, String field, Object value)

Method Summary

Modifier and Type	Method	Description
void	encode(Datastore datastore, BsonWriter writer, EncoderContext context)
Filter	entityType(Class<?> type)	Sets the query entity type on the filter
String	getField()
String	getName()
Object	getValue()
protected Object	getValue(Datastore datastore)
boolean	isNot()
Filter	isValidating(boolean validate)	Sets whether to validate field names or not
Filter	not()	Negates this filter by wrapping in "$not: {}"
protected String	path(Mapper mapper)
String	toString()
protected void	writeNamedValue(String name, Object value, Datastore datastore, BsonWriter writer, EncoderContext encoderContext)
protected void	writeUnnamedValue(Object value, Datastore datastore, BsonWriter writer, EncoderContext encoderContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Filter

protected Filter(String name)

Filter

protected Filter(String name,
                 @Nullable
                 String field,
                 @Nullable
                 Object value)

Method Detail

isNot

@MorphiaInternal
public boolean isNot()

Returns:

true if this filter has been notted

See Also:

not()

Developer note.

This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.

encode

@MorphiaInternal
public void encode(Datastore datastore,
                   BsonWriter writer,
                   EncoderContext context)

Parameters:

datastore - the datastore

writer - the writer

context - the context

Developer note.

This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.

entityType

@MorphiaInternal
public Filter entityType(Class<?> type)

Sets the query entity type on the filter

Parameters:

type - the type

Returns:

this

Developer note.

This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.

getField

@Nullable
@MorphiaInternal
public String getField()

Returns:

the filter field

Developer note.

This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.

not

public Filter not()

Negates this filter by wrapping in "$not: {}"

Returns:

this

MongoDB documentation

Query Filter: $not

getName

@Nullable
@MorphiaInternal
public String getName()

Returns:

the filter name

Developer note.

This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.

getValue

@Nullable
@MorphiaInternal
public Object getValue()

Returns:

the filter value

Developer note.

This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.

isValidating

@MorphiaInternal
public Filter isValidating(boolean validate)

Sets whether to validate field names or not

Parameters:

validate - true to validate

Returns:

this

Developer note.

This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.

getValue

@Nullable
protected Object getValue(Datastore datastore)

toString

public String toString()

Overrides:

toString in class Object

path

protected String path(Mapper mapper)

writeNamedValue

protected void writeNamedValue(@Nullable
                               String name,
                               @Nullable
                               Object value,
                               Datastore datastore,
                               BsonWriter writer,
                               EncoderContext encoderContext)

writeUnnamedValue

protected void writeUnnamedValue(@Nullable
                                 Object value,
                                 Datastore datastore,
                                 BsonWriter writer,
                                 EncoderContext encoderContext)