Package de.caluga.morphium.aggregation

Class AggregatorImpl<T,R>

java.lang.Object

de.caluga.morphium.aggregation.AggregatorImpl<T,R>

All Implemented Interfaces:

Aggregator<T,R>

public class AggregatorImpl<T,R>
extends Object
implements Aggregator<T,R>

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

Nested Class Summary

Nested classes/interfaces inherited from interface de.caluga.morphium.aggregation.Aggregator

Aggregator.BucketGranularity, Aggregator.GeoNearFields, Aggregator.MergeActionWhenMatched, Aggregator.MergeActionWhenNotMatched

Constructor Summary

Constructors

Constructor	Description
AggregatorImpl(Morphium morphium, Class<? extends T> type, Class<? extends R> resultType)

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)	Categorizes incoming documents into groups, called buckets, based on a specified expression and bucket boundaries and outputs a document per each bucket.
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> facets)
Aggregator<T,R>	facetExpr(Map<String,Expr> facets)
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<?> type, Expr startWith, Enum connectFromField, Enum connectToField, String as, Integer maxDepth, String depthField, Query restrictSearchWithMatch)
Aggregator<T,R>	graphLookup(Class<?> type, 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)	$lookup: { from: , localField: , foreignField: , as: }
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 collectionName)
Aggregator<T,R>	out(String db, String collectionName)
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 redact)	redact needs to resolve to $$DESCEND, $$PRUNE, or $$KEEP
Aggregator<T,R>	replaceRoot(Expr newRoot)
Aggregator<T,R>	replaceWith(Expr newDoc)	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)	Adds new fields to documents.
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 sortby)	The $sortByCount stage is equivalent to the following $group + $sort sequence:
Aggregator<T,R>	unionWith(Aggregator agg)
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)

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregatorImpl

public AggregatorImpl(Morphium morphium,
                      Class<? extends T> type,
                      Class<? extends R> resultType)

Method Detail

getCollation

public Collation getCollation()

Specified by:

getCollation in interface Aggregator<T,R>

isUseDisk

public boolean isUseDisk()

Specified by:

isUseDisk in interface Aggregator<T,R>

setUseDisk

public void setUseDisk(boolean useDisk)

Specified by:

setUseDisk in interface Aggregator<T,R>

isExplain

public boolean isExplain()

Specified by:

isExplain in interface Aggregator<T,R>

setExplain

public void setExplain(boolean explain)

Specified by:

setExplain in interface Aggregator<T,R>

getMorphium

public Morphium getMorphium()

Specified by:

getMorphium in interface Aggregator<T,R>

setMorphium

public void setMorphium(Morphium m)

Specified by:

setMorphium in interface Aggregator<T,R>

getSearchType

public Class<? extends T> getSearchType()

Specified by:

getSearchType in interface Aggregator<T,R>

setSearchType

public void setSearchType(Class<? extends T> type)

Specified by:

setSearchType in interface Aggregator<T,R>

getResultType

public Class<? extends R> getResultType()

Specified by:

getResultType in interface Aggregator<T,R>

setResultType

public void setResultType(Class<? extends R> type)

Specified by:

setResultType in interface Aggregator<T,R>

project

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

Specified by:

project in interface Aggregator<T,R>

project

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

Specified by:

project in interface Aggregator<T,R>

project

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

Specified by:

project in interface Aggregator<T,R>

addFields

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

Specified by:

addFields in interface Aggregator<T,R>

match

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

Specified by:

match in interface Aggregator<T,R>

matchSubQuery

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

Specified by:

matchSubQuery in interface Aggregator<T,R>

match

public Aggregator<T,R> match(Expr q)

Specified by:

match in interface Aggregator<T,R>

limit

public Aggregator<T,R> limit(int num)

Specified by:

limit in interface Aggregator<T,R>

skip

public Aggregator<T,R> skip(int num)

Specified by:

skip in interface Aggregator<T,R>

unwind

public Aggregator<T,R> unwind(Expr listField)

Specified by:

unwind in interface Aggregator<T,R>

unwind

public Aggregator<T,R> unwind(String listField)

Specified by:

unwind in interface Aggregator<T,R>

sort

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

Specified by:

sort in interface Aggregator<T,R>

sort

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

Specified by:

sort in interface Aggregator<T,R>

getCollectionName

public String getCollectionName()

Specified by:

getCollectionName in interface Aggregator<T,R>

setCollectionName

public void setCollectionName(String cn)

Specified by:

setCollectionName in interface Aggregator<T,R>

group

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

Specified by:

group in interface Aggregator<T,R>

group

public Group<T,R> group(Expr id)

Specified by:

group in interface Aggregator<T,R>

group

public Group<T,R> group(String id)

Specified by:

group in interface Aggregator<T,R>

addOperator

public void addOperator(Map<String,Object> o)

Specified by:

addOperator in interface Aggregator<T,R>

aggregate

public List<R> aggregate()

Specified by:

aggregate in interface Aggregator<T,R>

getCount

public long getCount()

Specified by:

getCount in interface Aggregator<T,R>

aggregateIterable

public MorphiumAggregationIterator<T,R> aggregateIterable()

Specified by:

aggregateIterable in interface Aggregator<T,R>

aggregate

public void aggregate(AsyncOperationCallback<R> callback)

Specified by:

aggregate in interface Aggregator<T,R>

aggregateMap

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

Specified by:

aggregateMap in interface Aggregator<T,R>

aggregateMap

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

Specified by:

aggregateMap in interface Aggregator<T,R>

getAggregateCmd

public AggregateMongoCommand getAggregateCmd()

Specified by:

getAggregateCmd in interface Aggregator<T,R>

getPipeline

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

Specified by:

getPipeline in interface Aggregator<T,R>

count

public Aggregator<T,R> count(String fld)

Specified by:

count in interface Aggregator<T,R>

count

public Aggregator<T,R> count(Enum fld)

Specified by:

count in interface Aggregator<T,R>

out

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

Specified by:

out in interface Aggregator<T,R>

bucket

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

Categorizes incoming documents into groups, called buckets, based on a specified expression and bucket boundaries and outputs a document per each bucket. Each output document contains an _id field whose value specifies the inclusive lower bound of the bucket. The output option specifies the fields included in each output document.

$bucket only produces output documents for buckets that contain at least one input document.

Specified by:

bucket in interface Aggregator<T,R>

Parameters:

groupBy - : Expression to group by, usually a field name

boundaries - : Boundaries for the buckets

preset - : the default, needs to be a literal

output - : definition of output documents and accumulator

Returns:

bucketAuto

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

Specified by:

bucketAuto in interface Aggregator<T,R>

collStats

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

Specified by:

collStats in interface Aggregator<T,R>

Parameters:

latencyHistograms - : if null, no latency stats

scale - : if null, no storageStats

Returns:

currentOp

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

Specified by:

currentOp in interface Aggregator<T,R>

facetExpr

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

Specified by:

facetExpr in interface Aggregator<T,R>

facet

public Aggregator<T,R> facet(Map<String,Aggregator> facets)

Specified by:

facet in interface Aggregator<T,R>

geoNear

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

Specified by:

geoNear in interface Aggregator<T,R>

graphLookup

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

Specified by:

graphLookup in interface Aggregator<T,R>

graphLookup

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

Specified by:

graphLookup in interface Aggregator<T,R>

graphLookup

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

Specified by:

graphLookup in interface Aggregator<T,R>

indexStats

public Aggregator<T,R> indexStats()

Specified by:

indexStats in interface Aggregator<T,R>

listLocalSessionsAllUsers

public Aggregator<T,R> listLocalSessionsAllUsers()

Specified by:

listLocalSessionsAllUsers in interface Aggregator<T,R>

listLocalSessions

public Aggregator<T,R> listLocalSessions()

Specified by:

listLocalSessions in interface Aggregator<T,R>

listLocalSessions

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

Specified by:

listLocalSessions in interface Aggregator<T,R>

listSessionsAllUsers

public Aggregator<T,R> listSessionsAllUsers()

Specified by:

listSessionsAllUsers in interface Aggregator<T,R>

listSessions

public Aggregator<T,R> listSessions()

Specified by:

listSessions in interface Aggregator<T,R>

listSessions

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

Specified by:

listSessions in interface Aggregator<T,R>

lookup

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

$lookup: { from: , localField: , foreignField: , as:

}

Specified by:

lookup in interface Aggregator<T,R>

Returns:

lookup

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

Specified by:

lookup in interface Aggregator<T,R>

merge

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

Specified by:

merge in interface Aggregator<T,R>

merge

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

Specified by:

merge in interface Aggregator<T,R>

merge

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

Specified by:

merge in interface Aggregator<T,R>

merge

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

Specified by:

merge in interface Aggregator<T,R>

merge

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

Specified by:

merge in interface Aggregator<T,R>

merge

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

Specified by:

merge in interface Aggregator<T,R>

merge

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

Specified by:

merge in interface Aggregator<T,R>

out

public Aggregator<T,R> out(String collectionName)

Specified by:

out in interface Aggregator<T,R>

out

public Aggregator<T,R> out(String db,
                                 String collectionName)

Specified by:

out in interface Aggregator<T,R>

planCacheStats

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

Specified by:

planCacheStats in interface Aggregator<T,R>

redact

public Aggregator<T,R> redact(Expr redact)

redact needs to resolve to $$DESCEND, $$PRUNE, or $$KEEP

System Variable Description $$DESCEND $redact returns the fields at the current document level, excluding embedded documents. To include embedded documents and embedded documents within arrays, apply the $cond expression to the embedded documents to determine access for these embedded documents. $$PRUNE $redact excludes all fields at this current document/embedded document level, without further inspection of any of the excluded fields. This applies even if the excluded field contains embedded documents that may have different access levels. $$KEEP $redact returns or keeps all fields at this current document/embedded document level, without further inspection of the fields at this level. This applies even if the included field contains embedded documents that may have different access levels.

Specified by:

redact in interface Aggregator<T,R>

Returns:

replaceRoot

public Aggregator<T,R> replaceRoot(Expr newRoot)

Specified by:

replaceRoot in interface Aggregator<T,R>

replaceWith

public Aggregator<T,R> replaceWith(Expr newDoc)

Description copied from interface: Aggregator

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.

Specified by:

replaceWith in interface Aggregator<T,R>

Returns:

sample

public Aggregator<T,R> sample(int sampleSize)

Description copied from interface: Aggregator

Randomly selects the specified number of documents from its input.

Specified by:

sample in interface Aggregator<T,R>

Returns:

set

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

Adds new fields to documents. $set outputs documents that contain all existing fields from the input documents and newly added fields.

The $set stage is an alias for $addFields.

Specified by:

set in interface Aggregator<T,R>

Parameters:

param -

Returns:

sortByCount

public Aggregator<T,R> sortByCount(Expr sortby)

The $sortByCount stage is equivalent to the following $group + $sort sequence:

{ $group: { _id: , count: { $sum: 1 } } }, { $sort: { count: -1 } }

Specified by:

sortByCount in interface Aggregator<T,R>

Parameters:

sortby -

Returns:

unionWith

public Aggregator<T,R> unionWith(String collection)

Specified by:

unionWith in interface Aggregator<T,R>

unionWith

public Aggregator<T,R> unionWith(Aggregator agg)

Specified by:

unionWith in interface Aggregator<T,R>

unset

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

Specified by:

unset in interface Aggregator<T,R>

unset

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

Specified by:

unset in interface Aggregator<T,R>

unset

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

Specified by:

unset in interface Aggregator<T,R>

genericStage

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

Specified by:

genericStage in interface Aggregator<T,R>

collation

public Aggregator<T,R> collation(Collation collation)

Specified by:

collation in interface Aggregator<T,R>