Index (Crafter Commons Mongo 4.1.3 API)

A C D E F G H I J L M O P Q R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractJongoRepository<T> - Class in org.craftercms.commons.mongo: Simple interface to interact with Jongo/MongoDB.
Changes MongoException in to MongoRepositoryException (which is a checked exception).As well if Command result is not ok (CommandResult#isOk) return false a exception will be thrown the message for that exception will be CommandResult#getErrorMessage.
Some of the find and insert methods use a template queryName.
AbstractJongoRepository() - Constructor for class org.craftercms.commons.mongo.AbstractJongoRepository
add(Map<String, Object>, String, Object) - Method in class org.craftercms.commons.mongo.UpdateHelper
afterPropertiesSet() - Method in class org.craftercms.commons.mongo.MongoScriptRunner

C

clazz - Variable in class org.craftercms.commons.mongo.AbstractJongoRepository
collectionName - Variable in class org.craftercms.commons.mongo.AbstractJongoRepository
collectionName() - Element in annotation interface org.craftercms.commons.mongo.Document: Name where all Documents will be save.
count() - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
count() - Method in interface org.craftercms.commons.mongo.CrudRepository: Returns the number of all documents in the collection.
count(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
count(String) - Method in interface org.craftercms.commons.mongo.CrudRepository: Returns the number of documents that match the query
count(String, Object...) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
count(String, Object...) - Method in interface org.craftercms.commons.mongo.CrudRepository: Returns the number of documents that match the query
createInstance() - Method in class org.craftercms.commons.mongo.JongoFactoryBean
createInstance() - Method in class org.craftercms.commons.mongo.MongoClientFactory
createInstance() - Method in class org.craftercms.commons.mongo.MongoClientFromUriFactoryBean
createInstance() - Method in class org.craftercms.commons.mongo.MongoClientOptionsFactory
createSortQuery(List<DefaultKeyValue<String, Boolean>>) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository: Creates a Sort query based on the fields.
Key of the map is the field False=Desc,True=asc for the field, Respect order of the keys
CrudRepository<T> - Interface in org.craftercms.commons.mongo

D

DEFAULT_MONGO_HOST - Static variable in class org.craftercms.commons.mongo.MongoClientFactory
DEFAULT_MONGO_PORT - Static variable in class org.craftercms.commons.mongo.MongoClientFactory
deleteFile(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
deleteFile(String) - Method in interface org.craftercms.commons.mongo.CrudRepository: Deletes the File with the given name.
deleteFile(ObjectId) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
deleteFile(ObjectId) - Method in interface org.craftercms.commons.mongo.CrudRepository: Deletes the File with the given Id.
destroyInstance(MongoClient) - Method in class org.craftercms.commons.mongo.MongoClientFromUriFactoryBean
Document - Annotation Interface in org.craftercms.commons.mongo
DuplicateKeyException - Exception in org.craftercms.commons.mongo: Mongo exception thrown when a document can't be inserted because there's already a document with the same key.
DuplicateKeyException() - Constructor for exception org.craftercms.commons.mongo.DuplicateKeyException
DuplicateKeyException(String) - Constructor for exception org.craftercms.commons.mongo.DuplicateKeyException
DuplicateKeyException(String, Throwable) - Constructor for exception org.craftercms.commons.mongo.DuplicateKeyException
DuplicateKeyException(String, Throwable, boolean, boolean) - Constructor for exception org.craftercms.commons.mongo.DuplicateKeyException
DuplicateKeyException(Throwable) - Constructor for exception org.craftercms.commons.mongo.DuplicateKeyException

E

equals(Object) - Method in class org.craftercms.commons.mongo.FileInfo
executeUpdate(String, CrudRepository<?>) - Method in class org.craftercms.commons.mongo.UpdateHelper

F

FileInfo - Class in org.craftercms.commons.mongo: Grid Fs File Information
FileInfo() - Constructor for class org.craftercms.commons.mongo.FileInfo
find(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
find(String) - Method in interface org.craftercms.commons.mongo.CrudRepository: Search all documents in the given collection that match the query.
find(String, Object...) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
find(String, Object...) - Method in interface org.craftercms.commons.mongo.CrudRepository: Finds all documents of the given collection that match the template query
§§
findAll() - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
findAll() - Method in interface org.craftercms.commons.mongo.CrudRepository: Gets all documents of a the given collection.
findById(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
findById(String) - Method in interface org.craftercms.commons.mongo.CrudRepository: Finds by the Id.
findByStringId(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
findByStringId(String) - Method in interface org.craftercms.commons.mongo.CrudRepository: Finds by the Id.
findOne(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
findOne(String) - Method in interface org.craftercms.commons.mongo.CrudRepository: Search for documents of the given collection that match the query.
In only return the first Document
findOne(String, Object...) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
findOne(String, Object...) - Method in interface org.craftercms.commons.mongo.CrudRepository: Search for documents of the given collection that match the query.
In only return the first Document

G

getAttributes() - Method in class org.craftercms.commons.mongo.FileInfo
getCollection() - Method in class org.craftercms.commons.mongo.AbstractJongoRepository: Gets the Jongo Document.
getContentType() - Method in class org.craftercms.commons.mongo.FileInfo
getFileId() - Method in class org.craftercms.commons.mongo.FileInfo
getFileInfo(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
getFileInfo(String) - Method in interface org.craftercms.commons.mongo.CrudRepository: Gets the file information based on its name..
getFileInfo(ObjectId) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
getFileInfo(ObjectId) - Method in interface org.craftercms.commons.mongo.CrudRepository: Gets the file information based on its id..
getFileName() - Method in class org.craftercms.commons.mongo.FileInfo
getFileSize() - Method in class org.craftercms.commons.mongo.FileInfo
getFileSizeBytes() - Method in class org.craftercms.commons.mongo.FileInfo
getInputStream() - Method in class org.craftercms.commons.mongo.FileInfo
getMd5() - Method in class org.craftercms.commons.mongo.FileInfo
getObjectType() - Method in class org.craftercms.commons.mongo.JongoFactoryBean
getObjectType() - Method in class org.craftercms.commons.mongo.MongoClientFactory
getObjectType() - Method in class org.craftercms.commons.mongo.MongoClientFromUriFactoryBean
getObjectType() - Method in class org.craftercms.commons.mongo.MongoClientOptionsFactory
getQueryFor(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository: Get the query string for a given key
getSavedDate() - Method in class org.craftercms.commons.mongo.FileInfo
getStoreName() - Method in class org.craftercms.commons.mongo.FileInfo
gridfs - Variable in class org.craftercms.commons.mongo.AbstractJongoRepository

H

hashCode() - Method in class org.craftercms.commons.mongo.FileInfo

I

init() - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
insert(T) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
insert(T) - Method in interface org.craftercms.commons.mongo.CrudRepository: Inserts the document into the collection.
insert(T...) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
insert(T...) - Method in interface org.craftercms.commons.mongo.CrudRepository: Inserts multiple documents into the collection.

J

jongo - Variable in class org.craftercms.commons.mongo.AbstractJongoRepository
JongoFactoryBean - Class in org.craftercms.commons.mongo: Creates a Jongo singleton for application wide use.
JongoFactoryBean() - Constructor for class org.craftercms.commons.mongo.JongoFactoryBean
JongoQueries - Class in org.craftercms.commons.mongo: Holds a Map of all the register MongoQueries.
JongoQueries() - Constructor for class org.craftercms.commons.mongo.JongoQueries

L

listFilesByName(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
listFilesByName(String) - Method in interface org.craftercms.commons.mongo.CrudRepository

M

MongoClientFactory - Class in org.craftercms.commons.mongo: Creates a Mongo Client based on a connection String
MongoClientFactory() - Constructor for class org.craftercms.commons.mongo.MongoClientFactory
MongoClientFromUriFactoryBean - Class in org.craftercms.commons.mongo: FactoryBean that besides creating a MongoClient from a Mongo URI, closes the client when it's destroyed.
MongoClientFromUriFactoryBean() - Constructor for class org.craftercms.commons.mongo.MongoClientFromUriFactoryBean
MongoClientOptionsFactory - Class in org.craftercms.commons.mongo: Spring helper for Create a MongoClient
MongoClientOptionsFactory() - Constructor for class org.craftercms.commons.mongo.MongoClientOptionsFactory
MongoDataException - Exception in org.craftercms.commons.mongo: Checked Exception to wrap around MongoException.
MongoDataException() - Constructor for exception org.craftercms.commons.mongo.MongoDataException
MongoDataException(String) - Constructor for exception org.craftercms.commons.mongo.MongoDataException
MongoDataException(String, Throwable) - Constructor for exception org.craftercms.commons.mongo.MongoDataException
MongoDataException(String, Throwable, boolean, boolean) - Constructor for exception org.craftercms.commons.mongo.MongoDataException
MongoDataException(Throwable) - Constructor for exception org.craftercms.commons.mongo.MongoDataException
MongoScriptRunner - Class in org.craftercms.commons.mongo: Utility class for running Mongo scripts in JS.
MongoScriptRunner() - Constructor for class org.craftercms.commons.mongo.MongoScriptRunner

O

org.craftercms.commons.mongo - package org.craftercms.commons.mongo

P

pull(String, Object) - Method in class org.craftercms.commons.mongo.UpdateHelper
pullAll(String, Collection<?>) - Method in class org.craftercms.commons.mongo.UpdateHelper
pullAllDocuments(String, String, Collection<?>) - Method in class org.craftercms.commons.mongo.UpdateHelper
pullValues - Variable in class org.craftercms.commons.mongo.UpdateHelper
push(String, Object) - Method in class org.craftercms.commons.mongo.UpdateHelper
pushAll(String, Collection<?>) - Method in class org.craftercms.commons.mongo.UpdateHelper
pushValues - Variable in class org.craftercms.commons.mongo.UpdateHelper

Q

queries - Variable in class org.craftercms.commons.mongo.AbstractJongoRepository

R

readFile(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
readFile(String) - Method in interface org.craftercms.commons.mongo.CrudRepository: Returns the InputStream of the file with the given name.
readFile(ObjectId) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
readFile(ObjectId) - Method in interface org.craftercms.commons.mongo.CrudRepository: Returns the InputStream of the file with the given id.
readPropertyFile(InputStream) - Method in class org.craftercms.commons.mongo.JongoQueries
remove(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
remove(String) - Method in interface org.craftercms.commons.mongo.CrudRepository: Removes all Documents that are found using the given query.
remove(String, Object...) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
remove(String, Object...) - Method in interface org.craftercms.commons.mongo.CrudRepository: Removes all Documents that are found using the given query.
removeById(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
removeById(String) - Method in interface org.craftercms.commons.mongo.CrudRepository: Removes a Document with the given id
removeByStringId(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
removeByStringId(String) - Method in interface org.craftercms.commons.mongo.CrudRepository: Removes by the Id.
returnList(Find) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository: Actually makes the transformation form Jongo to List of Objects.
returnSimple(FindOne) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository: Actually makes the transformation form Jongo to the Object.

S

save(String, Object...) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
save(String, Object...) - Method in interface org.craftercms.commons.mongo.CrudRepository: Inserts in the given collection the json "As Is"
Json String can contain placeholders this will allow the user to have predefine json strings
that will be substitute with the given queryParams.Params are not Name therefor if the same value is needed multiple times for now it has to be send multiple times.Order of the queryParams should match the same in the json string.
Example
String Json ="{name:#,address: #,age:#}" save("testCollection",Json,"Dr.John Z.", new Address(), 125);
save(T) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
save(T) - Method in interface org.craftercms.commons.mongo.CrudRepository: Saves the document into the collection.
saveFile(InputStream, String, String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
saveFile(InputStream, String, String) - Method in interface org.craftercms.commons.mongo.CrudRepository: Saves the given InputStream as with the given name.
saveFile(InputStream, String, String, ObjectId) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
saveFile(InputStream, String, String, ObjectId) - Method in interface org.craftercms.commons.mongo.CrudRepository: Saves the given InputStream as with the given name.
set(String, Object) - Method in class org.craftercms.commons.mongo.UpdateHelper
setAttribute(String, Object) - Method in class org.craftercms.commons.mongo.FileInfo
setAttributes(Map<String, Object>) - Method in class org.craftercms.commons.mongo.FileInfo
setConnectionsPerHost(int) - Method in class org.craftercms.commons.mongo.MongoClientOptionsFactory
setConnectionStr(String) - Method in class org.craftercms.commons.mongo.MongoScriptRunner
setConnectionString(String) - Method in class org.craftercms.commons.mongo.MongoClientFactory
setConnectTimeout(int) - Method in class org.craftercms.commons.mongo.MongoClientOptionsFactory
setContentType(String) - Method in class org.craftercms.commons.mongo.FileInfo
setCursorFinalizerEnabled(boolean) - Method in class org.craftercms.commons.mongo.MongoClientOptionsFactory
setDbName(String) - Method in class org.craftercms.commons.mongo.JongoFactoryBean
setDbName(String) - Method in class org.craftercms.commons.mongo.MongoScriptRunner
setDeserializers(Map<Class<?>, JsonDeserializer<?>>) - Method in class org.craftercms.commons.mongo.JongoFactoryBean
setFileId(ObjectId) - Method in class org.craftercms.commons.mongo.FileInfo
setFileName(String) - Method in class org.craftercms.commons.mongo.FileInfo
setFileSize(String) - Method in class org.craftercms.commons.mongo.FileInfo
setFileSizeBytes(long) - Method in class org.craftercms.commons.mongo.FileInfo
setJongo(Jongo) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
setMaxWaitTime(int) - Method in class org.craftercms.commons.mongo.MongoClientOptionsFactory
setMd5(String) - Method in class org.craftercms.commons.mongo.FileInfo
setMongo(MongoClient) - Method in class org.craftercms.commons.mongo.JongoFactoryBean
setMongo(MongoClient) - Method in class org.craftercms.commons.mongo.MongoScriptRunner
setOptions(MongoClientOptions) - Method in class org.craftercms.commons.mongo.MongoClientFactory
setPassword(String) - Method in class org.craftercms.commons.mongo.JongoFactoryBean
setPassword(String) - Method in class org.craftercms.commons.mongo.MongoClientFactory
setPassword(String) - Method in class org.craftercms.commons.mongo.MongoScriptRunner
setQueries(JongoQueries) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
setReadPreference(int) - Method in class org.craftercms.commons.mongo.MongoClientOptionsFactory
setRunOnInit(boolean) - Method in class org.craftercms.commons.mongo.MongoScriptRunner
setSavedDate(Date) - Method in class org.craftercms.commons.mongo.FileInfo
setScriptPaths(List<Resource>) - Method in class org.craftercms.commons.mongo.MongoScriptRunner
setSerializers(List<JsonSerializer<?>>) - Method in class org.craftercms.commons.mongo.JongoFactoryBean
setStoreName(String) - Method in class org.craftercms.commons.mongo.FileInfo
setUri(String) - Method in class org.craftercms.commons.mongo.MongoClientFromUriFactoryBean
setUsername(String) - Method in class org.craftercms.commons.mongo.JongoFactoryBean
setUsername(String) - Method in class org.craftercms.commons.mongo.MongoClientFactory
setUsername(String) - Method in class org.craftercms.commons.mongo.MongoScriptRunner
setValues - Variable in class org.craftercms.commons.mongo.UpdateHelper
setWriteConcern(String) - Method in class org.craftercms.commons.mongo.MongoClientOptionsFactory

T

toString() - Method in class org.craftercms.commons.mongo.FileInfo

U

unset(String) - Method in class org.craftercms.commons.mongo.UpdateHelper
unsetValues - Variable in class org.craftercms.commons.mongo.UpdateHelper
update(String, Object) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
update(String, Object) - Method in interface org.craftercms.commons.mongo.CrudRepository: Updates the object with the given id with the given Object information.
update(String, Object, boolean, boolean) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
update(String, Object, boolean, boolean) - Method in interface org.craftercms.commons.mongo.CrudRepository: Updates the object with the given id with the given Object information.
update(String, String, boolean, boolean) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
update(String, String, boolean, boolean) - Method in interface org.craftercms.commons.mongo.CrudRepository: Updates the given
update(String, String, boolean, boolean, Object...) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
update(String, String, boolean, boolean, Object...) - Method in interface org.craftercms.commons.mongo.CrudRepository: Updates the given
updateFile(InputStream, String, String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
updateFile(InputStream, String, String) - Method in interface org.craftercms.commons.mongo.CrudRepository: "Updates" the file with the new information (A name change is NOT valid )
updateFile(ObjectId, InputStream, String, String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
updateFile(ObjectId, InputStream, String, String) - Method in interface org.craftercms.commons.mongo.CrudRepository: "Updates" the file with the new information (A name change is valid as long a file with new name does not exists)
updateFile(ObjectId, InputStream, String, String, boolean) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
updateFile(ObjectId, InputStream, String, String, boolean) - Method in interface org.craftercms.commons.mongo.CrudRepository: "Updates" the file with the new information (A name change is valid as long a file with new name does not exists)
UpdateHelper - Class in org.craftercms.commons.mongo: Created by alfonsovasquez on 13/6/16.
UpdateHelper() - Constructor for class org.craftercms.commons.mongo.UpdateHelper
uri - Variable in class org.craftercms.commons.mongo.MongoClientFromUriFactoryBean

V

validateObject(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
validateObject(ObjectId) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository

A C D E F G H I J L M O P Q R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form