Package de.caluga.morphium.aggregation

Interface Aggregator<T,R>

All Known Implementing Classes:

AggregatorImpl, InMemAggregator

public interface Aggregator<T,R>

User: Stephan Bösebeck Date: 30.08.12 Time: 16:23

Aggregator Framework: represents the aggregator of Mongo 2.2.x. and above $project $match $limit $skip $unwind $group $sort $geoNear - implementation still missing

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Aggregator.BucketGranularity
static class	Aggregator.GeoNearFields
static class	Aggregator.MergeActionWhenMatched
static class	Aggregator.MergeActionWhenNotMatched

Method Summary

Modifier and Type	Method	Description
Aggregator<T,R>	addFields(Map<String,Object> m)
void	addOperator(Map<String,Object> o)
List<R>	aggregate()
void	aggregate(AsyncOperationCallback<R> callback)
MorphiumAggregationIterator<T,R>	aggregateIterable()
List<Map<String,Object>>	aggregateMap()
void	aggregateMap(AsyncOperationCallback<Map<String,Object>> callback)
Aggregator<T,R>	bucket(Expr groupBy, List<Expr> boundaries, Expr preset, Map<String,Expr> output)
Aggregator<T,R>	bucketAuto(Expr groupBy, int numBuckets, Map<String,Expr> output, Aggregator.BucketGranularity granularity)
Aggregator<T,R>	collation(Collation collation)
Aggregator<T,R>	collStats(Boolean latencyHistograms, Double scale, boolean count, boolean queryExecStats)
Aggregator<T,R>	count(Enum fld)
Aggregator<T,R>	count(String fld)
Aggregator<T,R>	currentOp(boolean allUsers, boolean idleConnections, boolean idleCursors, boolean idleSessions, boolean localOps)
Aggregator<T,R>	facet(Map<String,Aggregator> pipeline)
Aggregator<T,R>	facetExpr(Map<String,Expr> param)
Aggregator<T,R>	genericStage(String stageName, Object param)
Aggregator<T,R>	geoNear(Map<Aggregator.GeoNearFields,Object> param)
AggregateMongoCommand	getAggregateCmd()
Collation	getCollation()
String	getCollectionName()
long	getCount()
Morphium	getMorphium()
List<Map<String,Object>>	getPipeline()
Class<? extends R>	getResultType()
Class<? extends T>	getSearchType()
Aggregator<T,R>	graphLookup(Class<?> fromType, Expr startWith, Enum connectFromField, Enum connectToField, String as, Integer maxDepth, String depthField, Query restrictSearchWithMatch)
Aggregator<T,R>	graphLookup(Class<?> fromType, Expr startWith, String connectFromField, String connectToField, String as, Integer maxDepth, String depthField, Query restrictSearchWithMatch)
Aggregator<T,R>	graphLookup(String fromCollection, Expr startWith, String connectFromField, String connectToField, String as, Integer maxDepth, String depthField, Query restrictSearchWithMatch)
Group<T,R>	group(Expr id)
Group<T,R>	group(String id)
Group<T,R>	group(Map<String,Object> id)
Aggregator<T,R>	indexStats()
boolean	isExplain()
boolean	isUseDisk()
Aggregator<T,R>	limit(int num)
Aggregator<T,R>	listLocalSessions()
Aggregator<T,R>	listLocalSessions(List<String> users, List<String> dbs)
Aggregator<T,R>	listLocalSessionsAllUsers()
Aggregator<T,R>	listSessions()
Aggregator<T,R>	listSessions(List<String> users, List<String> dbs)
Aggregator<T,R>	listSessionsAllUsers()
Aggregator<T,R>	lookup(Class fromType, Enum localField, Enum foreignField, String outputArray, List<Expr> pipeline, Map<String,Expr> let)
Aggregator<T,R>	lookup(String fromCollection, String localField, String foreignField, String outputArray, List<Expr> pipeline, Map<String,Expr> let)
Aggregator<T,R>	match(Expr q)
Aggregator<T,R>	match(Query<T> q)
Aggregator<T,R>	matchSubQuery(Query<?> q)
Aggregator<T,R>	merge(Class<?> intoCollection)
Aggregator<T,R>	merge(Class<?> intoCollection, Map<String,Expr> let, List<Map<String,Expr>> machedPipeline, Aggregator.MergeActionWhenMatched matchAction, Aggregator.MergeActionWhenNotMatched notMatchedAction, String... onFields)
Aggregator<T,R>	merge(String intoCollection)
Aggregator<T,R>	merge(String intoCollection, Aggregator.MergeActionWhenMatched matchAction, Aggregator.MergeActionWhenNotMatched notMatchedAction, String... onFields)
Aggregator<T,R>	merge(String intoDb, String intoCollection)
Aggregator<T,R>	merge(String intoDb, String intoCollection, Aggregator.MergeActionWhenMatched matchAction, Aggregator.MergeActionWhenNotMatched notMatchedAction, String... onFields)
Aggregator<T,R>	merge(String intoCollection, Map<String,Expr> let, List<Map<String,Expr>> machedPipeline, Aggregator.MergeActionWhenNotMatched notMatchedAction, String... onFields)
Aggregator<T,R>	out(Class<?> type)
Aggregator<T,R>	out(String collection)
Aggregator<T,R>	out(String db, String collection)
Aggregator<T,R>	planCacheStats(Map<String,Object> param)
Aggregator<T,R>	project(String... m)
Aggregator<T,R>	project(String fld, Expr e)
Aggregator<T,R>	project(Map<String,Object> m)
Aggregator<T,R>	redact(Expr expr)	see https://docs.mongodb.com/manual/reference/operator/aggregation/redact/
Aggregator<T,R>	replaceRoot(Expr newRoot)
Aggregator<T,R>	replaceWith(Expr replacement)	Replaces the input document with the specified document.
Aggregator<T,R>	sample(int sampleSize)	Randomly selects the specified number of documents from its input.
Aggregator<T,R>	set(Map<String,Expr> param)
void	setCollectionName(String cn)
void	setExplain(boolean explain)
void	setMorphium(Morphium m)
void	setResultType(Class<? extends R> type)
void	setSearchType(Class<? extends T> type)
void	setUseDisk(boolean useDisk)
Aggregator<T,R>	skip(int num)
Aggregator<T,R>	sort(String... prefixed)
Aggregator<T,R>	sort(Map<String,Integer> sort)
Aggregator<T,R>	sortByCount(Expr countBy)
Aggregator<T,R>	unionWith(Aggregator aggregator)
Aggregator<T,R>	unionWith(String collection)
Aggregator<T,R>	unset(Enum... field)
Aggregator<T,R>	unset(String... param)
Aggregator<T,R>	unset(List<String> field)
Aggregator<T,R>	unwind(Expr listField)
Aggregator<T,R>	unwind(String listField)

Method Detail

getMorphium

Morphium getMorphium()

setMorphium

void setMorphium(Morphium m)

getSearchType

Class<? extends T> getSearchType()

setSearchType

void setSearchType(Class<? extends T> type)

getResultType

Class<? extends R> getResultType()

setResultType

void setResultType(Class<? extends R> type)

project

Aggregator<T,R> project(Map<String,Object> m)

addFields

Aggregator<T,R> addFields(Map<String,Object> m)

project

Aggregator<T,R> project(String... m)

project

Aggregator<T,R> project(String fld,
                              Expr e)

match

Aggregator<T,R> match(Query<T> q)

matchSubQuery

Aggregator<T,R> matchSubQuery(Query<?> q)

match

Aggregator<T,R> match(Expr q)

count

Aggregator<T,R> count(String fld)

count

Aggregator<T,R> count(Enum fld)

bucket

Aggregator<T,R> bucket(Expr groupBy,
                             List<Expr> boundaries,
                             Expr preset,
                             Map<String,Expr> output)

bucketAuto

Aggregator<T,R> bucketAuto(Expr groupBy,
                                 int numBuckets,
                                 Map<String,Expr> output,
                                 Aggregator.BucketGranularity granularity)

collStats

Aggregator<T,R> collStats(Boolean latencyHistograms,
                                Double scale,
                                boolean count,
                                boolean queryExecStats)

Parameters:

latencyHistograms - : if null, no latency stats

scale - : if null, no storageStats

count -

queryExecStats -

Returns:

currentOp

Aggregator<T,R> currentOp(boolean allUsers,
                                boolean idleConnections,
                                boolean idleCursors,
                                boolean idleSessions,
                                boolean localOps)

facetExpr

Aggregator<T,R> facetExpr(Map<String,Expr> param)

facet

Aggregator<T,R> facet(Map<String,Aggregator> pipeline)

geoNear

Aggregator<T,R> geoNear(Map<Aggregator.GeoNearFields,Object> param)

graphLookup

Aggregator<T,R> graphLookup(Class<?> fromType,
                                  Expr startWith,
                                  Enum connectFromField,
                                  Enum connectToField,
                                  String as,
                                  Integer maxDepth,
                                  String depthField,
                                  Query restrictSearchWithMatch)

graphLookup

Aggregator<T,R> graphLookup(Class<?> fromType,
                                  Expr startWith,
                                  String connectFromField,
                                  String connectToField,
                                  String as,
                                  Integer maxDepth,
                                  String depthField,
                                  Query restrictSearchWithMatch)

graphLookup

Aggregator<T,R> graphLookup(String fromCollection,
                                  Expr startWith,
                                  String connectFromField,
                                  String connectToField,
                                  String as,
                                  Integer maxDepth,
                                  String depthField,
                                  Query restrictSearchWithMatch)

indexStats

Aggregator<T,R> indexStats()

listLocalSessions

Aggregator<T,R> listLocalSessions()

listLocalSessionsAllUsers

Aggregator<T,R> listLocalSessionsAllUsers()

listLocalSessions

Aggregator<T,R> listLocalSessions(List<String> users,
                                        List<String> dbs)

listSessions

Aggregator<T,R> listSessions()

listSessionsAllUsers

Aggregator<T,R> listSessionsAllUsers()

listSessions

Aggregator<T,R> listSessions(List<String> users,
                                   List<String> dbs)

collation

Aggregator<T,R> collation(Collation collation)

getCollation

Collation getCollation()

lookup

Aggregator<T,R> lookup(Class fromType,
                             Enum localField,
                             Enum foreignField,
                             String outputArray,
                             List<Expr> pipeline,
                             Map<String,Expr> let)

lookup

Aggregator<T,R> lookup(String fromCollection,
                             String localField,
                             String foreignField,
                             String outputArray,
                             List<Expr> pipeline,
                             Map<String,Expr> let)

merge

Aggregator<T,R> merge(String intoDb,
                            String intoCollection,
                            Aggregator.MergeActionWhenMatched matchAction,
                            Aggregator.MergeActionWhenNotMatched notMatchedAction,
                            String... onFields)

merge

Aggregator<T,R> merge(String intoCollection,
                            Aggregator.MergeActionWhenMatched matchAction,
                            Aggregator.MergeActionWhenNotMatched notMatchedAction,
                            String... onFields)

merge

Aggregator<T,R> merge(String intoCollection,
                            Map<String,Expr> let,
                            List<Map<String,Expr>> machedPipeline,
                            Aggregator.MergeActionWhenNotMatched notMatchedAction,
                            String... onFields)

merge

Aggregator<T,R> merge(Class<?> intoCollection,
                            Map<String,Expr> let,
                            List<Map<String,Expr>> machedPipeline,
                            Aggregator.MergeActionWhenMatched matchAction,
                            Aggregator.MergeActionWhenNotMatched notMatchedAction,
                            String... onFields)

merge

Aggregator<T,R> merge(String intoDb,
                            String intoCollection)

merge

Aggregator<T,R> merge(Class<?> intoCollection)

merge

Aggregator<T,R> merge(String intoCollection)

out

Aggregator<T,R> out(String collection)

out

Aggregator<T,R> out(Class<?> type)

out

Aggregator<T,R> out(String db,
                          String collection)

planCacheStats

Aggregator<T,R> planCacheStats(Map<String,Object> param)

redact

Aggregator<T,R> redact(Expr expr)

see https://docs.mongodb.com/manual/reference/operator/aggregation/redact/

Parameters:

expr -

Returns:

replaceRoot

Aggregator<T,R> replaceRoot(Expr newRoot)

replaceWith

Aggregator<T,R> replaceWith(Expr replacement)

Replaces the input document with the specified document. The operation replaces all existing fields in the input document, including the _id field. With $replaceWith, you can promote an embedded document to the top-level. You can also specify a new document as the replacement.

Parameters:

replacement -

Returns:

sample

Aggregator<T,R> sample(int sampleSize)

Randomly selects the specified number of documents from its input.

Parameters:

sampleSize -

Returns:

set

Aggregator<T,R> set(Map<String,Expr> param)

sortByCount

Aggregator<T,R> sortByCount(Expr countBy)

unionWith

Aggregator<T,R> unionWith(String collection)

unionWith

Aggregator<T,R> unionWith(Aggregator aggregator)

unset

Aggregator<T,R> unset(List<String> field)

unset

Aggregator<T,R> unset(String... param)

unset

Aggregator<T,R> unset(Enum... field)

genericStage

Aggregator<T,R> genericStage(String stageName,
                                   Object param)

limit

Aggregator<T,R> limit(int num)

skip

Aggregator<T,R> skip(int num)

unwind

Aggregator<T,R> unwind(Expr listField)

unwind

Aggregator<T,R> unwind(String listField)

sort

Aggregator<T,R> sort(String... prefixed)

sort

Aggregator<T,R> sort(Map<String,Integer> sort)

getCollectionName

String getCollectionName()

setCollectionName

void setCollectionName(String cn)

group

Group<T,R> group(Map<String,Object> id)

group

Group<T,R> group(String id)

group

Group<T,R> group(Expr id)

getPipeline

List<Map<String,Object>> getPipeline()

addOperator

void addOperator(Map<String,Object> o)

aggregate

List<R> aggregate()

getCount

long getCount()

aggregateIterable

MorphiumAggregationIterator<T,R> aggregateIterable()

aggregate

void aggregate(AsyncOperationCallback<R> callback)

aggregateMap

List<Map<String,Object>> aggregateMap()

aggregateMap

void aggregateMap(AsyncOperationCallback<Map<String,Object>> callback)

isExplain

boolean isExplain()

setExplain

void setExplain(boolean explain)

isUseDisk

boolean isUseDisk()

setUseDisk

void setUseDisk(boolean useDisk)

getAggregateCmd

AggregateMongoCommand getAggregateCmd()