ICollection (com.entitystream-monsterDB 1.0.34 API)

All Known Implementing Classes:

Collection, CollectionLocal, CollectionRemote, MonsterCLI, MonsterClient, MonsterLoadCLI
```
public interface ICollection
```

Method Summary

All Methods Static Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addTrigger(String name)`
`Stream<Document>`	`aggregate(List<Document> pipeline)`
`Stream<Document>`	`aggregate(List<Document> pipeline, Document options)`
`Stream<Document>`	`aggregate(List<Document> in, List<Document> pipeline)`
`Document`	`aggregateMetadata(List<Document> pipeline)`
`Document`	`aggregateMetadata(List<Document> in, List<Document> pipeline)`
`DBCursor`	`aggregateTasks(ArrayList<Document> andlist)`
`Stream`	`analyse(Document asDocument, Stream<Document> in, Document options)`
`Stream`	`arrf(Document asDocument, Stream<Document> in, Document options)`
`Stream`	`between(Document asDocument, Stream<Document> in, Document options)`
`Stream`	`bucket(Document asDocument, Stream<Document> in, Document options)`
`Stream`	`classifierBuild(Document asDocument, Stream<Document> in, Document options)`
`Stream`	`classifierPredict(Document asDocument, Stream<Document> in, Document options)`
`Stream`	`classifierTree(Document asDocument, Stream<Document> in, Document options)`
`Stream`	`cluster(Document asDocument, Stream<Document> in, Document options)`
`Stream`	`coerce(Document asDocument, Stream<Document> in, Document options)`
`Stream`	`compare(Document asDocument, Stream<Document> in, Document options)`
`Document`	`conceptCount(String indexName)`
`long`	`count(Document query)`
`Stream`	`count(Document asDocument, Stream<Document> in, Document options)`
`void`	`createIndex(Document document)`
`void`	`createIndex(Document fields, Document options)`
`void`	`createUniqueIndex(Document fields)`
`void`	`deleteConcept(String purposeName, String purposeColumn)`
`void`	`deleteConceptGroup(String def)`
`void`	`deleteConceptMapping(Document def)`
`void`	`deleteFuzzyIndex(String def)`
`int`	`deleteMany(Document filter)`
`void`	`deleteMatchRule(long order)`
`Document`	`deleteOne(Document filter)`
`void`	`deleteRelationships(Document document)`
`void`	`deleteTable(String def)`
`void`	`deleteTasks(Document document)`
`void`	`disconnect()`
`<TResult> Iterable<TResult>`	`distinct(String fieldName, Class<TResult> resultClass)`
`<TResult> Iterable<TResult>`	`distinctRelationship(String string, Class<TResult> resultClass)`
`void`	`drop()`
`void`	`dropIndex(String name)`
`Stream`	`evaluate(Document asDocument, Stream<Document> in, Document options)`
`DBCursor`	`executeCommand(String command, User user, Session session)`
`static boolean`	`filter(Document doc, Document filter)`
`static Stream<Document>`	`filter(Document filter, Stream<Document> in, Document options)`
`DBCursor`	`find()`
`DBCursor`	`find(Document filter)`
`DBCursor`	`find(Document document, Document explain)`
`DBCursor`	`findFuzzy(Document filter)`
`DBCursor`	`findFuzzy(String textQuery)`
`Document`	`findOneAndDelete(Document filter)`
`Document`	`findOneAndReplace(Document filter, Document replacement)`
`Document`	`findOneAndReplace(Document filter, Document replacement, Document options)`
`Document`	`findOneAndUpdate(Document filter, Document amendments)`
`Document`	`findOneAndUpdate(Document filter, Document amendments, Document updateOpts)`
`DBCursor`	`findRelationships(Document filter)`
`Stream<Document>`	`findStream(Document filter)`
`DBCursor`	`findTasks(Document filter)`
`Stream`	`first(Document asDocument, Stream<Document> in, Document options)`
`Document`	`fuzzyMatch(Document matchNode, List<com.entitystream.identiza.entity.resolve.metadata.IIndex> matchIndexes)`
`Stream`	`fuzzyMatch(Document asDocument, Stream<Document> in, Document options)`
`Stream`	`fuzzySearch(String string, Stream<Document> in, Document options)`
`DBCursor`	`getBooks()`
`Database`	`getDatabase()`
`Document`	`getDefinition()`
`Stream<Document>`	`getDeltas()`
`Document`	`getDocument(Object pointer)`
`DBCursor`	`getFlow(String name)`
`DBCursor`	`getFlows()`
`Document`	`getIndexPrefixSubMap(String indexName, String key, boolean b)`
`DBCursor`	`getMatchTypes()`
`Stream<Document>`	`getNodes()`
`Stream`	`getRelated(Document asDocument, Stream<Document> in, Document options)`
`Map<Integer,ICollection>`	`getReplicaConnections()`
`Document`	`getStandardised(String indexName, String id)`
`Document`	`getTable(String def)`
`String`	`getTrigger()`
`Stream`	`group(Document asDocument, Stream<Document> in, Document options)`
`int`	`insertMany(List<Document> listRecs)`
`Document`	`insertOne(Document doc)`
`Stream`	`join(Document asDocument, Stream<Document> in, Document options)`
`Document`	`keyCount(String indexName)`
`Stream`	`last(Document asDocument, Stream<Document> in, Document options)`
`Stream`	`limit(long long1, Stream<Document> in, Document options)`
`DBCursor`	`listIndexes()`
`Stream`	`lookup(Document asDocument, Stream<Document> in, Document options)`
`Stream`	`match(Document asDocument, Stream<Document> in, Document options)`
`Stream`	`minus(Document asDocument, Stream<Document> in, Document options)`
`Stream`	`out(String string, Stream<Document> in, Document options)`
`DBCursor`	`peekQueue()`
`Stream`	`project(Document asDocument, Stream<Document> in, Document options)`
`void`	`rebuildIndex(String name)`
`Stream`	`rematch(Document asDocument, Stream<Document> in, Document options)`
`void`	`removeFuzzy()`
`void`	`resolveTask(Document taskData)`
`Document`	`save(Document doc)`
`void`	`saveConcept(Document def)`
`void`	`saveConceptGroup(Document def)`
`void`	`saveConceptMapping(Document def)`
`void`	`saveFuzzyIndex(Document def)`
`void`	`saveFuzzyIndexes(List<Document> def)`
`int`	`saveMany(List<Document> records)`
`void`	`saveMatchRule(Document def)`
`void`	`saveMatchRules(List<Document> defs)`
`Document`	`saveRelationship(Document relationship)`
`void`	`saveTable(Document def)`
`Document`	`saveTask(Document task)`
`Stream<Document>`	`script(Document scriptStatements, Stream<Document> in, Document stageoptions)`
`void`	`setAutoMatch(boolean a)`
`void`	`setExplaining(boolean explain)`
`Stream`	`skip(long long1, Stream<Document> in, Document options)`
`Stream`	`sort(Document asDocument, Stream<Document> in, Document options)`
`Stream`	`spinOut(Document asDocument, Stream<Document> in, Document options)`
`Map<Document,List<Document>>`	`split(List<Document> list, Stream<Document> in, Document options)`
`Stream<Document>`	`task(Document options, Stream<Document> in, Document globalOptions)`
`DBCursor`	`traverseTop(Document from, String relType)`
`Stream`	`unwind(Document asDocument, Stream<Document> in, Document options)`
`void`	`updateDefinition(Document def)`
`void`	`updateDelta(Document doc)`
`int`	`updateMany(Document filter, Document amendments)`
`int`	`updateMany(Document filter, Document amendments, Document options)`
`Document`	`updateOne(Document filter, Document amendments)`
`Document`	`updateOne(Document filter, Document amendments, Document options)`
`Document`	`updateRelationship(Document document, Document setUpdate, Document options)`
`Document`	`updateTask(String id, Document doc)`
`Stream<Document>`	`validate(String type, Stream<Document> in, Document stageoptions)`
`Stream<Document>`	`writeRel(Document options, Stream<Document> in, Document goptions)`

Method Detail

createIndex

void createIndex(Document fields,
                 Document options)

createIndex

void createIndex(Document document)

find
```
DBCursor find(Document filter)
```

find
```
DBCursor find()
```

findFuzzy

DBCursor findFuzzy(Document filter)

save
```
Document save(Document doc)
```

insertOne
```
Document insertOne(Document doc)
```

count
```
long count(Document query)
```

findOneAndReplace

Document findOneAndReplace(Document filter,
                           Document replacement,
                           Document options)

findOneAndReplace

Document findOneAndReplace(Document filter,
                           Document replacement)

findOneAndUpdate

Document findOneAndUpdate(Document filter,
                          Document amendments)

findOneAndUpdate

Document findOneAndUpdate(Document filter,
                          Document amendments,
                          Document updateOpts)

updateOne

Document updateOne(Document filter,
                   Document amendments)

updateOne

Document updateOne(Document filter,
                   Document amendments,
                   Document options)

updateMany

int updateMany(Document filter,
               Document amendments,
               Document options)

insertMany

int insertMany(List<Document> listRecs)

findOneAndDelete

Document findOneAndDelete(Document filter)

deleteOne

Document deleteOne(Document filter)

deleteMany
```
int deleteMany(Document filter)
```

aggregate

Stream<Document> aggregate(List<Document> pipeline,
                           Document options)

aggregate

Stream<Document> aggregate(List<Document> pipeline)

aggregate

Stream<Document> aggregate(List<Document> in,
                           List<Document> pipeline)

listIndexes
```
DBCursor listIndexes()
```

rebuildIndex
```
void rebuildIndex(String name)
```

dropIndex
```
void dropIndex(String name)
```

saveMany

int saveMany(List<Document> records)

disconnect

void disconnect()
         throws Exception

Throws:: Exception

setExplaining

void setExplaining(boolean explain)

find

DBCursor find(Document document,
              Document explain)

executeCommand

DBCursor executeCommand(String command,
                        User user,
                        Session session)

drop
```
void drop()
```

distinct

<TResult> Iterable<TResult> distinct(String fieldName,
                                     Class<TResult> resultClass)

getIndexPrefixSubMap

Document getIndexPrefixSubMap(String indexName,
                              String key,
                              boolean b)

getDocument

Document getDocument(Object pointer)

keyCount

Document keyCount(String indexName)

getStandardised

Document getStandardised(String indexName,
                         String id)

conceptCount

Document conceptCount(String indexName)

removeFuzzy
```
void removeFuzzy()
```

saveTable
```
void saveTable(Document def)
```

deleteTable
```
void deleteTable(String def)
```

saveConceptGroup

void saveConceptGroup(Document def)

deleteConceptGroup

void deleteConceptGroup(String def)

saveConcept
```
void saveConcept(Document def)
```

deleteConcept

void deleteConcept(String purposeName,
                   String purposeColumn)

saveConceptMapping

void saveConceptMapping(Document def)

deleteConceptMapping

void deleteConceptMapping(Document def)

saveMatchRule
```
void saveMatchRule(Document def)
```

deleteMatchRule
```
void deleteMatchRule(long order)
```

saveFuzzyIndex
```
void saveFuzzyIndex(Document def)
```

deleteFuzzyIndex
```
void deleteFuzzyIndex(String def)
```

getDefinition
```
Document getDefinition()
```

getTable
```
Document getTable(String def)
```

createUniqueIndex

void createUniqueIndex(Document fields)

updateDefinition

void updateDefinition(Document def)

findFuzzy

DBCursor findFuzzy(String textQuery)

findRelationships

DBCursor findRelationships(Document filter)

findTasks

DBCursor findTasks(Document filter)

saveRelationship

Document saveRelationship(Document relationship)

resolveTask

void resolveTask(Document taskData)

aggregateTasks

DBCursor aggregateTasks(ArrayList<Document> andlist)

updateTask

Document updateTask(String id,
                    Document doc)

distinctRelationship

<TResult> Iterable<TResult> distinctRelationship(String string,
                                                 Class<TResult> resultClass)

updateRelationship

Document updateRelationship(Document document,
                            Document setUpdate,
                            Document options)

peekQueue
```
DBCursor peekQueue()
```

setAutoMatch
```
void setAutoMatch(boolean a)
```

deleteTasks

void deleteTasks(Document document)

deleteRelationships

void deleteRelationships(Document document)

addTrigger
```
void addTrigger(String name)
```
Parameters:

name -

updateMany

int updateMany(Document filter,
               Document amendments)

Parameters:: filter -; amendments -
Returns:

findStream

Stream<Document> findStream(Document filter)

Parameters:: filter -
Returns:

getReplicaConnections

Map<Integer,ICollection> getReplicaConnections()

Returns:

match

Stream match(Document asDocument,
             Stream<Document> in,
             Document options)

Parameters:: asDocument -; in -; options -
Returns:

analyse

Stream analyse(Document asDocument,
               Stream<Document> in,
               Document options)

Parameters:: asDocument -; in -; options -
Returns:

limit

Stream limit(long long1,
             Stream<Document> in,
             Document options)

Parameters:: long1 -; in -; options -
Returns:

lookup

Stream lookup(Document asDocument,
              Stream<Document> in,
              Document options)

Parameters:: asDocument -; in -; options -
Returns:

join

Stream join(Document asDocument,
            Stream<Document> in,
            Document options)

Parameters:: asDocument -; in -; options -
Returns:

minus

Stream minus(Document asDocument,
             Stream<Document> in,
             Document options)

Parameters:: asDocument -; in -; options -
Returns:

skip

Stream skip(long long1,
            Stream<Document> in,
            Document options)

Parameters:: long1 -; in -; options -
Returns:

group

Stream group(Document asDocument,
             Stream<Document> in,
             Document options)

Parameters:: asDocument -; in -; options -
Returns:

out

Stream out(String string,
           Stream<Document> in,
           Document options)

Parameters:: string -; in -; options -
Returns:

sort

Stream sort(Document asDocument,
            Stream<Document> in,
            Document options)

Parameters:: asDocument -; in -; options -
Returns:

bucket

Stream bucket(Document asDocument,
              Stream<Document> in,
              Document options)

Parameters:: asDocument -; in -; options -
Returns:

fuzzySearch

Stream fuzzySearch(String string,
                   Stream<Document> in,
                   Document options)

Parameters:: string -; in -; options -
Returns:

fuzzyMatch

Stream fuzzyMatch(Document asDocument,
                  Stream<Document> in,
                  Document options)

Parameters:: asDocument -; in -; options -
Returns:

unwind

Stream unwind(Document asDocument,
              Stream<Document> in,
              Document options)

Parameters:: asDocument -; in -; options -
Returns:

spinOut

Stream spinOut(Document asDocument,
               Stream<Document> in,
               Document options)

Parameters:: asDocument -; in -; options -
Returns:

getRelated

Stream getRelated(Document asDocument,
                  Stream<Document> in,
                  Document options)

Parameters:: asDocument -; in -; options -
Returns:

rematch

Stream rematch(Document asDocument,
               Stream<Document> in,
               Document options)

Parameters:: asDocument -; in -; options -
Returns:

classifierBuild

Stream classifierBuild(Document asDocument,
                       Stream<Document> in,
                       Document options)

Parameters:: asDocument -; in -; options -
Returns:

classifierPredict

Stream classifierPredict(Document asDocument,
                         Stream<Document> in,
                         Document options)

Parameters:: asDocument -; in -; options -
Returns:

arrf

Stream arrf(Document asDocument,
            Stream<Document> in,
            Document options)

Parameters:: asDocument -; in -; options -
Returns:

classifierTree

Stream classifierTree(Document asDocument,
                      Stream<Document> in,
                      Document options)

Parameters:: asDocument -; in -; options -
Returns:

coerce

Stream coerce(Document asDocument,
              Stream<Document> in,
              Document options)

Parameters:: asDocument -; in -; options -
Returns:

compare

Stream compare(Document asDocument,
               Stream<Document> in,
               Document options)

Parameters:: asDocument -; in -; options -
Returns:

count

Stream count(Document asDocument,
             Stream<Document> in,
             Document options)

Parameters:: asDocument -; in -; options -
Returns:

first

Stream first(Document asDocument,
             Stream<Document> in,
             Document options)

Parameters:: asDocument -; in -; options -
Returns:

last

Stream last(Document asDocument,
            Stream<Document> in,
            Document options)

Parameters:: asDocument -; in -; options -
Returns:

between

Stream between(Document asDocument,
               Stream<Document> in,
               Document options)

Parameters:: asDocument -; in -; options -
Returns:

cluster

Stream cluster(Document asDocument,
               Stream<Document> in,
               Document options)

Parameters:: asDocument -; in -; options -
Returns:

project

Stream project(Document asDocument,
               Stream<Document> in,
               Document options)

Parameters:: asDocument -; in -; options -
Returns:

evaluate

Stream evaluate(Document asDocument,
                Stream<Document> in,
                Document options)

Parameters:: asDocument -; in -; options -
Returns:

split

Map<Document,List<Document>> split(List<Document> list,
                                   Stream<Document> in,
                                   Document options)

Parameters:: list -; in -; options -
Returns:

getDatabase
```
Database getDatabase()
```
Returns:

filter

static boolean filter(Document doc,
                      Document filter)

filter

static Stream<Document> filter(Document filter,
                               Stream<Document> in,
                               Document options)

getTrigger
```
String getTrigger()
```
Returns:

fuzzyMatch

Document fuzzyMatch(Document matchNode,
                    List<com.entitystream.identiza.entity.resolve.metadata.IIndex> matchIndexes)

Parameters:: matchNode -; matchIndexes -
Returns:

traverseTop

DBCursor traverseTop(Document from,
                     String relType)

Parameters:: from -; relType -
Returns:

writeRel

Stream<Document> writeRel(Document options,
                          Stream<Document> in,
                          Document goptions)

Parameters:: options -; in -; goptions -
Returns:

aggregateMetadata

Document aggregateMetadata(List<Document> in,
                           List<Document> pipeline)

Parameters:: in -; pipeline -
Returns:

aggregateMetadata

Document aggregateMetadata(List<Document> pipeline)

Parameters:: pipeline -
Returns:

script

Stream<Document> script(Document scriptStatements,
                        Stream<Document> in,
                        Document stageoptions)

Parameters:: scriptStatements -; in -; stageoptions -
Returns:

saveMatchRules

void saveMatchRules(List<Document> defs)

Parameters:: defs -

getMatchTypes
```
DBCursor getMatchTypes()
```

saveFuzzyIndexes

void saveFuzzyIndexes(List<Document> def)

Parameters:: def -

getFlows
```
DBCursor getFlows()
```
Returns:

getBooks
```
DBCursor getBooks()
```
Returns:

getFlow
```
DBCursor getFlow(String name)
```
Parameters:

name -

Returns:

validate

Stream<Document> validate(String type,
                          Stream<Document> in,
                          Document stageoptions)

Parameters:: type -; in -; stageoptions -
Returns:

task

Stream<Document> task(Document options,
                      Stream<Document> in,
                      Document globalOptions)

saveTask
```
Document saveTask(Document task)
```
Parameters:

task -

Returns:

getDeltas
```
Stream<Document> getDeltas()
```
Returns:

updateDelta
```
void updateDelta(Document doc)
```
Parameters:

doc -

getNodes
```
Stream<Document> getNodes()
```
Returns:

Interface ICollection

Method Summary

Method Detail

createIndex

createIndex

find

find

findFuzzy

save

insertOne

count

findOneAndReplace

findOneAndReplace

findOneAndUpdate

findOneAndUpdate

updateOne

updateOne

updateMany

insertMany

findOneAndDelete

deleteOne

deleteMany

aggregate

aggregate

aggregate

listIndexes

rebuildIndex

dropIndex

saveMany

disconnect

setExplaining

find

executeCommand

drop

distinct

getIndexPrefixSubMap

getDocument

keyCount

getStandardised

conceptCount

removeFuzzy

saveTable

deleteTable

saveConceptGroup

deleteConceptGroup

saveConcept

deleteConcept

saveConceptMapping

deleteConceptMapping

saveMatchRule

deleteMatchRule

saveFuzzyIndex

deleteFuzzyIndex

getDefinition

getTable

createUniqueIndex

updateDefinition

findFuzzy

findRelationships

findTasks

saveRelationship

resolveTask

aggregateTasks

updateTask

distinctRelationship

updateRelationship

peekQueue

setAutoMatch

deleteTasks

deleteRelationships

addTrigger

updateMany

findStream

getReplicaConnections

match

analyse

limit

lookup

join

minus