io.toro.martini.database

Class QueryConfiguration

java.lang.Object

io.toro.martini.database.QueryConfiguration

public abstract class QueryConfiguration
extends Object

Represents a MongoDB query.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryConfiguration.Builder
static class	QueryConfiguration.Type

Constructor Summary

Constructors

Constructor and Description
QueryConfiguration()

Method Summary

Modifier and Type	Method and Description
abstract String	aggregation() Provided if type() is AGGREGATE.
static QueryConfiguration.Builder	builder()
abstract String	filter() Provided if type() is FIND, UPDATE_ONE, UPDATE_MANY, DELETE_ONE, or DELETE_MANY.
abstract String	insert() Provided if type() is INSERT.
abstract String	projection() Provided if type() is FIND.
QueryConfiguration.Builder	toBuilder()
abstract QueryConfiguration.Type	type()
abstract String	update() Provided if type() is UPDATE_ONE or UPDATE_MANY.
abstract boolean	upsert()

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryConfiguration

public QueryConfiguration()

Method Detail

type

public abstract QueryConfiguration.Type type()

Returns:

the type of query to execute

filter

@Nullable
public abstract String filter()

Provided if type() is FIND, UPDATE_ONE, UPDATE_MANY, DELETE_ONE, or DELETE_MANY.

Returns:

query selection criteria using query operators

See Also:

db.collection.find

projection

@Nullable
public abstract String projection()

Provided if type() is FIND.

Returns:

fields to return in the documents that match the query filter

See Also:

db.collection.find

insert

@Nullable
public abstract String insert()

Provided if type() is INSERT.

Returns:

document or array of documents to insert into the collection

See Also:

db.collection.insert

update

@Nullable
public abstract String update()

Provided if type() is UPDATE_ONE or UPDATE_MANY.

Returns:

modifications to apply

See Also:

db.collection.update()

aggregation

@Nullable
public abstract String aggregation()

Provided if type() is AGGREGATE.

Returns:

sequence of data aggregation operations or stages

See Also:

db.collection.aggregate

upsert

public abstract boolean upsert()

Returns:

should be true if a new document should be inserted if there are no matches to the query filter

builder

public static QueryConfiguration.Builder builder()

toBuilder

public QueryConfiguration.Builder toBuilder()