This XML file should only be used for documentation purposes. 0 DocumentUtils_Static DocumentUtils_Static CreateUniqueFilter Create unique filter to identify the document. Filter Document NitriteDocument GetFields Gets all first level fields of a document. List Document NitriteDocument GetFieldValue Gets the value of a value inside a document. Object Document NitriteDocument Field String IsRecent Determines whether a document has recently been updated/created than the other. Boolean Recent NitriteDocument Older NitriteDocument Exporter Exporter Initialize Initializes the object. You can add parameters to this method if needed. SetObject Class is a subclass with no constructor, we need to set the object on which JavaObject will operate. Target JavaObject AsJavaObject Returns the wrapped object as JavaObject JavaObject ExportTo Exports data to a File. DirName String FileName String ExportTo2 Exports data to an OutputStream. Stream OutputStream ExportTo4 Exports data to a file. TFile String GetObject Returns the wrapped object as Object Object WithOptions Sets ExportOptions to customize data export. Exporter Options ExportOptions Exporter_Static Exporter_Static ExporterOf Creates a new Exporter instance. Exporter Db Nitrite ExportOptions ExportOptions Initialize * AsJavaObject Returns the wrapped object as JavaObject JavaObject GetCollections Specifies a list of PersistentCollections to be exported. List GetObject Returns the wrapped object as Object Object IsExportData Indicates if the export operation exports collection data. Boolean IsExportIndices Indicates if the export operation exports indices information. Boolean SetCollections Specifies a list of PersistentCollections to be exported. Collections List SetExportData Indicates if the export operation exports collection data. ExportData Boolean SetExportIndices Indicates if the export operation exports indices information. ExportIndices Boolean SetObject Comment if not needed Set the underlying Object, must be of correct type Obj Object Filter Filter Initialize Initializes the object. You can add parameters to this method if needed. AsJavaObject Filters a document map and returns the set of NitriteIds of matching Documents. Public Sub Apply(DocumentMap As Map) As JavaObject Return TJO.RunMethod("apply",Array As Object(DocumentMap)) End Sub Returns the wrapped object as JavaObject JavaObject GetObject Returns the wrapped object as Object Object SetObject Comment if not needed Set the underlying Object, must be of correct type Obj Object Tag Tag Object Filters Filters Initialize Initializes the object. You can add parameters to this method if needed. SetObject Class is a subclass with no constructor, we need to set the object on which JavaObject will operate. Target JavaObject ALL A filter to select all elements. Filter And_ Creates an and filter which performs a logical AND operation on two filters and selects the documents that satisfy both filters. Filter TFilters Object Btw return a filter that matches between values Exclusive Filter FieldName String Value1 Object Value2 Object BtwI return a filter that matches between values Inclusive Filter FieldName String Value1 Object Value2 Object AsJavaObject Returns the wrapped object as JavaObject JavaObject ElemMatch Creates an element match filter that matches documents that contain an array value with at least one element that matches the specified filter. Filter Field String TFilter Filter Eq Creates an equality filter which matches documents where the value of a field equals the specified value. Filter Field String Value Object GetObject Returns the wrapped object as Object Object Gt Creates a greater than filter which matches those documents where the value of the value is greater than (i.e. Filter Field String Value Object Gte Creates a greater equal filter which matches those documents where the value of the value is greater than or equals to (i.e. Filter Field String Value Object IsIn Creates an in filter which matches the documents where the value of a field equals the specified value. Filter Field String Values Object Lt Creates a lesser than filter which matches those documents where the value of the value is less than (i.e. Filter Field String Value Object Lte Creates a lesser equal filter which matches those documents where the value of the value is lesser than or equals to (i.e. Filter Field String Value Object Not_ Creates a not filter which performs a logical NOT operation on a filter and selects the documents that do not satisfy the filter. Filter TFilter Filter NotIn Creates a notIn filter which matches the documents where the value of a field not equals any value in the specified array. Filter Field String Values Object Or_ Creates an or filter which performs a logical OR operation on two filters and selects the documents that satisfy at least one of the filter. Filter TFilters Object Regex_ Creates a string filter which provides regular expression capabilities for pattern matching strings in documents. Filter Field String Value String Text Creates a text filter which performs a text search on the content of the fields indexed with a full-text index. Filter Field String Value String FindOptions FindOptions Initialize Initializes the object. You can add parameters to this method if needed. Create Instantiates a new find options with pagination criteria. Offset Int Size Int Create2 Instantiates a new find options with sorting criteria. Field String Ascending Boolean Create3 Instantiates a new find options with sorting criteria. Field String Ascending Boolean Collator RuleBasedCollator Create4 Instantiates a new find options with sorting criteria and null value order. NullOrder should be one of "Default", "First" or "Last" Field String Ascending Boolean Collator RuleBasedCollator NullOrder String Create5 Instantiates a new find options with sorting criteria and null value order. NullOrder should be one of "Default", "First" or "Last" Field String Ascending Boolean NullOrder String AsJavaObject Returns the wrapped object as JavaObject JavaObject GetCollator Gets the collator instance for sorting of String. RuleBasedCollator GetField Gets the target value name for sorting the find results. String GetNullOrder Gets the null values order of the find result. String GetObject Returns the wrapped object as Object Object GetOffset Gets the offset for pagination in find operation. Int GetSize Gets the number of records in each page for pagination in find operation results. Int GetAscending Gets the sort order of the find result. Boolean ThenLimit Sets the pagination criteria of a @FindOptions with sorting updateOptions. FindOptions Offset Int Size Int SetObject Comment if not needed Set the underlying Object, must be of correct type Obj Object FindOptions_Static FindOptions_Static Limit Creates a find options with pagination criteria. FindOptions Offset Int Size Int Sort Creates a find options with sorting criteria. FindOptions Field String Ascending Boolean Sort2 Creates a find options with sorting criteria. FindOptions Field String Ascending Boolean Collator RuleBasedCollator Sort3 Creates a find options with sorting criteria. FindOptions Field String Ascending Boolean Collator RuleBasedCollator NullOrder JavaObject Sort4 Creates a find options with sorting criteria. NullOrder should be one of "Default", "First" or "Last" FindOptions Field String Ascending Boolean NullOrder String Importer Importer Initialize Initializes the object. You can add parameters to this method if needed. SetObject Class is a subclass with no constructor, we need to set the object on which JavaObject will operate. Target JavaObject AsJavaObject Returns the wrapped object as JavaObject JavaObject GetObject Returns the wrapped object as Object Object ImportFrom Imports data from a file. DirName String FileName String ImportFrom2 Imports data from an InputStream. Stream InputStream ImportFrom4 Imports data from a file path. TFile String Importer_Static Importer_Static ImporterOf Creates a new Importer instance. Importer Db Nitrite IndexOptions IndexOptions Initialize AsJavaObject Returns the wrapped object as JavaObject JavaObject GetIndexType Specifies the type of an index to create. JavaObject GetObject Returns the wrapped object as Object Object IndexOptions2 Creates an IndexOptions with the specified indexType and async flag. IndexOption - One of the IndexType_ Constants IndexOptions IndexType String Async Boolean IsAsync Indicates whether an index to be created in a non-blocking way. Boolean SetAsync Indicates whether an index to be created in a non-blocking way. Async Boolean SetIndexType Specifies the type of an index to create. IndexType String SetObject Comment if not needed Set the underlying Object, must be of correct type Obj Object IndexOptions_Static IndexOptions_Static NewIndexOptions Creates an IndexOptions with the specified indexType. Index type is one of the PresistantCollection INDEXTYPE constants IndexOptions IndexType String Lookup Lookup Initialize * AsJavaObject Returns the wrapped object as JavaObject JavaObject GetForeignField Specifies the field from the foreign records. String GetLocalField Specifies the field from the records input to the join. String GetObject Returns the wrapped object as Object Object GetTargetField Specifies the new field of the joined records. String SetForeignField Specifies the field from the foreign records. ForeignField String SetLocalField Specifies the field from the records input to the join. LocalField String SetTargetField Specifies the new field of the joined records. TargetField String SetObject Comment if not needed Set the underlying Object, must be of correct type Obj Object SetTag Set the Tag for this object Tag Object GetTag Get the Tag for this object Object Nitrite Nitrite Initialize Initializes the object. You can add parameters to this method if needed. AsJavaObject Returns the wrapped object as JavaObject JavaObject Close Closes the database. Commit Commits the changes. Compact Compacts store by moving all chunks next to each other. GetCollection Opens a named collection from the store. NitriteCollection Name String GetContext Provides contextual information for the nitrite database instance. NitriteContext GetObject Returns the wrapped object as Object Object HasCollection Checks whether a particular NitriteCollection exists in the store. Boolean Name String HasUnsavedChanges Checks whether the store has any unsaved changes. Boolean IsClosed Checks whether the store is closed. Boolean ListCollectionNames Gets the set of all NitriteCollections' names saved in the store. List ValidateUser Checks if a specific username and password combination is valid to access the database. Boolean UserId String Password String SetObject Comment if not needed Set the underlying Object, must be of correct type Obj Object NitriteBuilder NitriteBuilder Initialize Initializes the object. You can add parameters to this method if needed. AsJavaObject Returns the wrapped object as JavaObject JavaObject AutoCommitBufferSize Sets the size of the write buffer, in KB disk space (for file-based stores). NitriteBuilder Size Int Compressed Compresses data before writing using the LZF algorithm. NitriteBuilder DisableAutoCommit Disables auto commit. NitriteBuilder DisableAutoCompact Disables auto compact before close. NitriteBuilder DisableShutdownHook Disables JVM shutdown hook for closing the database gracefully. NitriteBuilder EnableOffHeapStorage Enables off-heap storage for in-memory database. NitriteBuilder FilePath Sets file name for the file based store. NitriteBuilder DirName String FileName String FilePath2 Sets file name for the file based store. NitriteBuilder Path String GetObject Returns the wrapped object as Object Object NitriteMapper Sets a custom NitriteMapper implementation. NitriteBuilder TNitriteMapper JavaObject OpenOrCreate Opens or creates a new database. Nitrite OpenOrCreate2 Opens or creates a new database. JavaObject UserId String Password String ReadOnly Opens the file in read-only mode. NitriteBuilder RegisterModule Registers a jackson Module to the JacksonFacade. NitriteBuilder Module JavaObject TextIndexingService Sets a custom TextIndexingService implementation to be used during full text indexing and full text search. NitriteBuilder TTextIndexingService JavaObject TextTokenizer Sets a custom TextTokenizer for the in-built TextIndexingService. NitriteBuilder TTextTokenizer JavaObject SetObject Comment if not needed Set the underlying Object, must be of correct type Obj Object NitriteCollection NitriteCollection Initialize Initializes the object. You can add parameters to this method if needed. AsJavaObject Returns the wrapped object as JavaObject JavaObject Find Returns a Curser of all documents in the collection. NitriteCursor Find2 Applies a filter on the collection and returns a Cursor of the selected documents. NitriteCursor TFilter Filter Find3 Applies a filter on the collection and returns a Cursor of the selected documents. NitriteCursor TFilter Filter TFindOptions FindOptions Find4 Returns a Cursor of all documents in the collection. NitriteCursor TFindOptions FindOptions GetObject Returns the wrapped object as Object Object Insert Inserts documents into a collection. Returns a list of NitriteId's of affected documents WriteResult Document NitriteDocument Insert2 Inserts documents into a collection. Returns a list of NitriteId's of affected documents WriteResult Documents List Remove Deletes the element from the collection. WriteResult Document NitriteDocument Remove2 Removes matching elements from the collection. Returns a list of NitriteId's of affected documents WriteResult TFilter Filter Remove3 Removes document from a collection. Returns a list of NitriteId's of affected documents WriteResult TFilter Filter TRemoveOptions RemoveOptions Update Updates element in the collection. WriteResult Document NitriteDocument Update2 Updates element in the collection. WriteResult Document NitriteDocument Upsert Boolean Update3 Updates documents in the collection. Returns a list of NitriteId's of affected documents WriteResult TFilter Filter UpdateDoc NitriteDocument Update4 Updates documents in the collection. Returns a list of NitriteId's of affected documents WriteResult TFilter Filter UpdateDoc NitriteDocument TUpdateOptions UpdateOptions UpdateMap3 Updates documents in the collection. Returns a list of NitriteId's of affected documents WriteResult TFilter Filter UpdateMap Map UpdateMap4 Updates documents in the collection. Returns a list of NitriteId's of affected documents WriteResult TFilter Filter UpdateMap Map TUpdateOptions UpdateOptions SetObject Comment if not needed Set the underlying Object, must be of correct type Obj Object Close Closes the collection for further access. CreateIndex Creates an index on value, if not already exists. IndexOptions Field String IndexOption IndexOptions Drop Drops the collection and all of its indices. DropAllIndices Drops all indices from the collection. DropIndex Drops the index on a field. Field String GetById Gets a single document from the collection by its id. NitriteDocument TNitriteId NitriteId GetName Returns the name of the PersistentCollection. String HasIndex Checks if a value is already indexed or not. Boolean Field String IsClosed Returns true if the collection is closed; otherwise, false. Boolean IsDropped Returns true if the collection is dropped; otherwise, false. Boolean IsIndexing Checks if indexing operation is currently ongoing for a field. Boolean Field String ListIndices Gets a set of all indices in the collection. List RebuildIndex Rebuilds index on field if it exists. Field String Async Boolean Size Returns the size of the PersistentCollection. Long NitriteContext NitriteContext Initialize Initializes the object. You can add parameters to this method if needed. AsJavaObject Returns the wrapped object as JavaObject JavaObject DropCollection Name String GetAutoCommitBufferSize Gets the size of the auto-commit buffer. Int GetFilePath Gets the database file path. String GetObject Returns the wrapped object as Object Object IsAutoCommitEnabled Indicates if auto commit is enabled or not. Boolean IsAutoCompactEnabled Indicates if auto compact is enabled or not before close. Boolean IsCompressed Indicates if this is a compressed database or not. Boolean IsInMemory Indicates if this is an in-memory database or not. Boolean IsReadOnly Indicates if this is a readonly database or not. Boolean SetObject Comment if not needed Set the underlying Object, must be of correct type Obj Object NitriteCursor NitriteCursor Initialize Initializes the object. You can add parameters to this method if needed. AsJavaObject Returns the wrapped object as JavaObject JavaObject FirstOrDefault Gets the first element of the result or uninitialized document if it is empty. NitriteDocument FirstOrDefaultRaw Object GetObject Returns the wrapped object as Object Object HasMore Specifies if there are more elements in the database that has not been retrieved yet. Boolean IdSet Gets the set of all NitriteIds from the find() results. JavaObject GetIterator NitriteIterator Join Performs a left outer join with a foreign cursor with the specified lookup parameters. RecordIterable ForeignCursor NitriteCursor TLookup Lookup Project Gets a lazy iterable containing all the selected keys of the result documents. RecordIterable Projection NitriteDocument Size Gets the size of the current record set. Int ToList Returns a list of all elements. List TotalCount Gets the total count of the records in the database matching a filter criteria. Int SetObject Comment if not needed Set the underlying Object, must be of correct type Obj Object NitriteDocument NitriteDocument Initialize Initializes the object. You can add parameters to this method if needed. Create Instantiates an empty document. CreateDocument NitriteDocument Key String Value String Create2 Instantiates a new Document from a map. TMap Map AsJavaObject Returns the wrapped object as JavaObject JavaObject ContainsKey Boolean Key String Get Get object specified with the key. Object Key String GetRaw Object Key String GetDefault Object Key String Default Object GetRawDefault Object Key String Default Object GetId Gets the _id field of the document. NitriteId GetLastModifiedTime Gets the last modified time of the documents. Long GetObject Returns the wrapped object as Object Object GetRevision Gets the document revision number. Int GetSource Gets the source of the documents. String Keys Returns all keys as alist of strings List Put Append document with new key and value pair. NitriteDocument Key String Value Object PutRaw NitriteDocument Key String Value Object Remove Key String ToString String SetObject Comment if not needed Set the underlying Object, must be of correct type Obj Object NitriteDocument_Static NitriteDocument_Static CreateDocument Created a new Document from a key-value pair. NitriteDocument Key String Value Object CreateDocument2 Creates a document with all the fields and values within the passed Map NitriteDocument M Map CreateDocument3 Creates an empty document NitriteDocument NitriteId NitriteId Initialize Initializes the object. You can add parameters to this method if needed. AsJavaObject Returns the wrapped object as JavaObject JavaObject CompareTo * Int Other NitriteId Equals * Boolean O Object GetIdValue Gets the underlying id object. JavaObject GetObject Returns the wrapped object as Object Object HashCode * Int ToString * String SetObject Comment if not needed Set the underlying Object, must be of correct type Obj Object NitriteId_Static NitriteId_Static CreateId Creates a NitriteId from a long value. NitriteId Value JavaObject NewId Gets a new auto-generated NitriteId. NitriteId NitriteIterator NitriteIterator Initialize Initializes the object. You can add parameters to this method if needed. AsJavaObject Returns the wrapped object as JavaObject JavaObject GetObject Returns the wrapped object as Object Object HasNext Returns true if the iteration has more elements. Boolean GetNext Returns the next element in the iteration. Object SetObject Comment if not needed Set the underlying Object, must be of correct type Obj Object Nitrite_Static Nitrite_Static Builder Provides a builder utility to create a Nitrite database instance. NitriteBuilder Nitrite_Utils Nitrite_Utils UnwrapMap Map M Map UnwrapList List L List ObjectFilters ObjectFilters Initialize Initializes the object. You can add parameters to this method if needed. SetObject Class is a subclass with no constructor, we need to set the object on which JavaObject will operate. Target JavaObject ALL A filter to select all elements. ObjectFilters And Creates an and filter which performs a logical AND operation on two filters and selects the documents that satisfy both filters. ObjectFilters TFilters Object AsJavaObject Returns the wrapped object as JavaObject JavaObject ElemMatch Creates an element match filter that matches documents that contain an array value with at least one element that matches the specified filter. ObjectFilters Field String TFilter ObjectFilters Eq Creates an equality filter which matches documents where the value of a field equals the specified value. ObjectFilters Field String Value Object GetObject Returns the wrapped object as Object Object Gt Creates a greater than filter which matches those documents where the value of the value is greater than (i.e. ObjectFilters Field String Value Object Gte Creates a greater equal filter which matches those documents where the value of the value is greater than or equals to (i.e. ObjectFilters Field String Value Object IsIn Creates an in filter which matches the documents where the value of a field equals any value in the specified array. ObjectFilters Field String Values Object Lt Creates a lesser than filter which matches those documents where the value of the value is less than (i.e. ObjectFilters Field String Value Object Lte Creates a lesser equal filter which matches those documents where the value of the value is lesser than or equals to (i.e. ObjectFilters Field String Value Object Not_ Creates a not filter which performs a logical NOT operation on a filter and selects the documents that do not satisfy the filter. ObjectFilters TFilter ObjectFilters NotIn Creates a notIn filter which matches the documents where the value of a field not equals any value in the specified array. ObjectFilters Field String Values Object Or_ Creates an or filter which performs a logical OR operation on two filters and selects the documents that satisfy at least one of the filter. ObjectFilters TFilters Object Regex_ Creates a string filter which provides regular expression capabilities for pattern matching strings in documents. ObjectFilters Field String Value String Text Creates a text filter which performs a text search on the content of the fields indexed with a full-text index. ObjectFilters Field String Value String Tag Tag Object PersistantCollection PersistantCollection PersistentCollection (MethodName As String,Args() as Object) As Object Initialize Initializes the object. You can add parameters to this method if needed. AsJavaObject Returns the wrapped object as JavaObject JavaObject Close Closes the collection for further access. CreateIndex Creates an index on value, if not already exists. IndexOptions Field String IndexOption IndexOptions Drop Drops the collection and all of its indices. DropAllIndices Drops all indices from the collection. DropIndex Drops the index on a field. Field String GetById Gets a single element from the collection by its id. Object TNitriteId NitriteId GetName Returns the name of the PersistentCollection. String GetObject Returns the wrapped object as Object Object HasIndex Checks if a value is already indexed or not. Boolean Field String Insert Inserts elements into this collection. WriteResult Elements Object IsClosed Returns true if the collection is closed; otherwise, false. Boolean IsDropped Returns true if the collection is dropped; otherwise, false. Boolean IsIndexing Checks if indexing operation is currently ongoing for a field. Boolean Field String ListIndices Gets a set of all indices in the collection. List RebuildIndex Rebuilds index on field if it exists. Field String Async Boolean Remove Deletes the element from the collection. WriteResult Element Object Size Returns the size of the PersistentCollection. Long Update Updates element in the collection. WriteResult Element Object Update2 Updates element in the collection. WriteResult Element Object Upsert Boolean SetObject Comment if not needed Set the underlying Object, must be of correct type Obj Object RecordIterable RecordIterable Initialize Initializes the object. You can add parameters to this method if needed. AsJavaObject Returns the wrapped object as JavaObject JavaObject FirstOrDefault Gets the first element of the result or An uninitialized Document if it is empty. NitriteDocument GetIterator NitriteIterator GetObject Returns the wrapped object as Object Object HasMore Specifies if there are more elements in the database that has not been retrieved yet. Boolean Size Gets the size of the current record set. Int ToList Returns a list of all elements. List TotalCount Gets the total count of the records in the database matching a filter criteria. Int SetObject Comment if not needed Set the underlying Object, must be of correct type Obj Object RemoveOptions RemoveOptions Initialize * AsJavaObject Returns the wrapped object as JavaObject JavaObject GetObject Returns the wrapped object as Object Object IsJustOne Indicates if only one document will be removed or all of them. Boolean SetJustOne Indicates if only one document will be removed or all of them. JustOne Boolean SetObject Comment if not needed Set the underlying Object, must be of correct type Obj Object RuleBasedCollator RuleBasedCollator Initialize Initializes the object. You can add parameters to this method if needed. Create RuleBasedCollator constructor. Rules String AsJavaObject Returns the wrapped object as JavaObject JavaObject Compare Compares the character data stored in two different strings based on the collation rules. Int Source String Target String GetObject Returns the wrapped object as Object Object GetRules Gets the table-based rules for the collation object. String SetObject Comment if not needed Set the underlying Object, must be of correct type Obj Object UpdateOptions UpdateOptions Initialize * AsJavaObject Returns the wrapped object as JavaObject JavaObject GetObject Returns the wrapped object as Object Object IsJustOnce Indicates if only one document will be updated or all of them. Boolean IsUpsert Indicates if the update operation will insert a new document if it does not find any existing document to update. Boolean SetJustOnce Indicates if only one document will be updated or all of them. JustOnce Boolean SetUpsert Indicates if the update operation will insert a new document if it does not find any existing document to update. Upsert Boolean ToString * String SetObject Comment if not needed Set the underlying Object, must be of correct type Obj Object UpdateOptions_Static UpdateOptions_Static NewUpdateOptions Creates a new UpdateOptions. UpdateOptions Upsert Boolean UpdateOptions2 Creates a new UpdateOptions. UpdateOptions Upsert Boolean JustOnce Boolean WriteResult WriteResult WriteResult (MethodName As String,Args() as Object) As Object Initialize Initializes the object. You can add parameters to this method if needed. AsJavaObject Returns the wrapped object as JavaObject JavaObject GetAffectedCount Gets the count of affected document in the collection. Int GetIterator NitriteIterator GetObject Returns the wrapped object as Object Object SetObject Comment if not needed Set the underlying Object, must be of correct type Obj Object ToList Returns a list of affected NitriteId's List ToElementList List Collection Object 1.10 Stevel05