CFMongoDB

cfmongodb.core
Class SearchBuilder

WEB-INF.cftags.component
        extended by cfmongodb.core.SearchBuilder

public class SearchBuilder
extends WEB-INF.cftags.component

Creates a Domain Specific Language (DSL) for querying MongoDB collections.


Constructor Summary
init([any DBCollection])
 
Method Summary
 any $eq([any element], [any val])
 any $exists([any element], [any exists='true'])
 any $gt([any element], [any val])
 any $gte([any element], [any val])
 any $in([any element], [any vals])
 any $lt([any element], [any val])
 any $lte([any element], [any val])
 any $ne([any element], [any val])
 any $nin([any element], [any vals])
 any add([any key], [any value])
 any addArrayCriteria([string element], [array val], [string type])
 any after([string element], [date val])
 any before([string element], [date val])
 any between([any element], [any lower], [any upper])
 any betweenExclusive([any element], [any lower], [any upper])
 any builder()
 any count()
 any endsWith([any element], [any val])
 any find([string keys=''], [numeric skip='0'], [numeric limit='0'], [any sort='[runtime expression]'])
 any get()
 any inArray([any element], [any val])
 any like([any element], [any val])
 any regex([any element], [any val])
 any search([string keys=''], [numeric skip='0'], [numeric limit='0'], [any sort='[runtime expression]'])
          DEPRECATED
 any start()
 any startsWith([any element], [any val])
 any where([any js_expression])
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init([any DBCollection])

Parameters:
DBCollection
Method Detail

$eq

public any $eq([any element], [any val])

Parameters:
element
val

$exists

public any $exists([any element], [any exists='true'])

Parameters:
element
exists

$gt

public any $gt([any element], [any val])

Parameters:
element
val

$gte

public any $gte([any element], [any val])

Parameters:
element
val

$in

public any $in([any element], [any vals])

Parameters:
element
vals

$lt

public any $lt([any element], [any val])

Parameters:
element
val

$lte

public any $lte([any element], [any val])

Parameters:
element
val

$ne

public any $ne([any element], [any val])

Parameters:
element
val

$nin

public any $nin([any element], [any vals])

Parameters:
element
vals

add

public any add([any key], [any value])

Parameters:
key
value

addArrayCriteria

public any addArrayCriteria([string element], [array val], [string type])

Parameters:
element - The array element in the document we're searching
val - The value(s) of an element in the array
type - $in,$nin,etc.

after

public any after([string element], [date val])

Parameters:
element
val

before

public any before([string element], [date val])

Parameters:
element
val

between

public any between([any element], [any lower], [any upper])

Parameters:
element
lower
upper

betweenExclusive

public any betweenExclusive([any element], [any lower], [any upper])

Parameters:
element
lower
upper

builder

public any builder()


count

public any count()


endsWith

public any endsWith([any element], [any val])

Parameters:
element
val

find

public any find([string keys=''], [numeric skip='0'], [numeric limit='0'], [any sort='[runtime expression]'])

Parameters:
keys - A list of keys to return
skip - the number of items to skip
limit - Number of the maximum items to return
sort - A struct or string representing how the items are to be sorted

get

public any get()


inArray

public any inArray([any element], [any val])

Parameters:
element
val

like

public any like([any element], [any val])

Parameters:
element
val

regex

public any regex([any element], [any val])

Parameters:
element
val

search

public any search([string keys=''], [numeric skip='0'], [numeric limit='0'], [any sort='[runtime expression]'])
DEPRECATED. Use find() instead

Parameters:
keys
skip
limit
sort

start

public any start()


startsWith

public any startsWith([any element], [any val])

Parameters:
element
val

where

public any where([any js_expression])

Parameters:
js_expression

CFMongoDB