Skip navigation links
A B C D E F G I J L N O P Q R S T U W 

A

add(Document) - Method in interface jakarta.nosql.document.DocumentEntity
add a document within DocumentEntity
add(String, Object) - Method in interface jakarta.nosql.document.DocumentEntity
add a document within DocumentEntity
add(String, Value) - Method in interface jakarta.nosql.document.DocumentEntity
add a document within DocumentEntity
addAll(Iterable<Document>) - Method in interface jakarta.nosql.document.DocumentEntity
add all documents within DocumentEntity
and(DocumentCondition) - Method in interface jakarta.nosql.document.DocumentCondition
Creates a new DocumentCondition using the Condition.AND
and(DocumentCondition...) - Static method in interface jakarta.nosql.document.DocumentCondition
Returns a new DocumentCondition aggregating ,as ¨AND", all the conditions as just one condition.
and(DocumentCondition...) - Method in interface jakarta.nosql.document.DocumentCondition.DocumentConditionProvider
Creates a Condition.AND operation
and(String) - Method in interface jakarta.nosql.document.DocumentDeleteQuery.DocumentDeleteWhere
Starts a new condition in the select using DocumentCondition.and(DocumentCondition)
and(String) - Method in interface jakarta.nosql.document.DocumentQuery.DocumentWhere
Starts a new condition in the select using DocumentCondition.and(DocumentCondition)
asc() - Method in interface jakarta.nosql.document.DocumentQuery.DocumentOrder
Defines the order as SortType.ASC

B

between(Document) - Static method in interface jakarta.nosql.document.DocumentCondition
Creates a DocumentCondition that has a Condition.BETWEEN, it means a select will scanning to a document collection that is between two values informed on a document name.
between(Document) - Method in interface jakarta.nosql.document.DocumentCondition.DocumentConditionProvider
Creates a Condition.BETWEEN operation
between(T, T) - Method in interface jakarta.nosql.document.DocumentDeleteQuery.DocumentDeleteNameCondition
Creates the between condition Condition.EQUALS
between(T, T) - Method in interface jakarta.nosql.document.DocumentQuery.DocumentNameCondition
Creates the between condition Condition.EQUALS
bind(String, Object) - Method in interface jakarta.nosql.document.DocumentPreparedStatement
Binds an argument to a positional parameter.
build() - Method in interface jakarta.nosql.document.DocumentDeleteQuery.DocumentDeleteQueryBuild
Creates a new instance of DocumentDeleteQuery
build() - Method in interface jakarta.nosql.document.DocumentQuery.DocumentQueryBuild
Creates a new instance of DocumentQuery

C

clear() - Method in interface jakarta.nosql.document.DocumentEntity
Removes all Documents
close() - Method in interface jakarta.nosql.document.DocumentCollectionManager
closes a resource
close() - Method in interface jakarta.nosql.document.DocumentCollectionManagerFactory
closes a resource
contains(String) - Method in interface jakarta.nosql.document.DocumentEntity
Returns true if this DocumentEntity contains a document whose the name is informed
copy() - Method in interface jakarta.nosql.document.DocumentEntity
make copy of itself
count(String) - Method in interface jakarta.nosql.document.DocumentCollectionManager
Returns the number of elements from document collection

D

delete(DocumentDeleteQuery) - Method in interface jakarta.nosql.document.DocumentCollectionManager
Deletes an entity
delete(String...) - Static method in interface jakarta.nosql.document.DocumentDeleteQuery
Creates a delete query to Document
delete() - Static method in interface jakarta.nosql.document.DocumentDeleteQuery
Creates a delete query to Column
delete(DocumentCollectionManager) - Method in interface jakarta.nosql.document.DocumentDeleteQuery.DocumentDeleteQueryBuild
DeleteQueryConverter - Interface in jakarta.nosql.document
A converter that converts DeleteQuery to DocumentDeleteQueryParams
desc() - Method in interface jakarta.nosql.document.DocumentQuery.DocumentOrder
Defines the order as SortType.DESC
Document - Interface in jakarta.nosql.document
A Document Collection Entity unit, it is a tuple (pair) that consists of a key-value pair, where the key is mapped to a value.
Document.DocumentProvider - Interface in jakarta.nosql.document
A provider of Document where it will create from two parameters: The first one is the name of column The second one is the information of column
DocumentCollectionManager - Interface in jakarta.nosql.document
Interface used to interact with the persistence context to DocumentEntity The DocumentCollectionManager API is used to create and remove persistent DocumentEntity instances, to select entities by their primary key, and to select over entities.
DocumentCollectionManagerFactory - Interface in jakarta.nosql.document
DocumentCondition - Interface in jakarta.nosql.document
An unit condition to run a document collection select
DocumentCondition.DocumentConditionProvider - Interface in jakarta.nosql.document
A provider of DocumentCondition where it will create from two parameters: The first one is Document The second one is the Condition
DocumentConfiguration - Interface in jakarta.nosql.document
The Jakarta NoSQL communication configuration to create a DocumentCollectionManagerFactory
DocumentDeleteQuery - Interface in jakarta.nosql.document
A unit that has the columnFamily and condition to delete from conditions This instance will be used on:
DocumentDeleteQuery.DocumentDelete - Interface in jakarta.nosql.document
The initial element in the Document delete query
DocumentDeleteQuery.DocumentDeleteFrom - Interface in jakarta.nosql.document
The Document Delete Query
DocumentDeleteQuery.DocumentDeleteNameCondition - Interface in jakarta.nosql.document
The base to delete name condition
DocumentDeleteQuery.DocumentDeleteNotCondition - Interface in jakarta.nosql.document
The document not condition
DocumentDeleteQuery.DocumentDeleteProvider - Interface in jakarta.nosql.document
DocumentDeleteQuery.DocumentDeleteQueryBuild - Interface in jakarta.nosql.document
The last step to the build of DocumentDeleteQuery.
DocumentDeleteQuery.DocumentDeleteWhere - Interface in jakarta.nosql.document
The Document Where whose define the condition in the delete query.
DocumentDeleteQueryParams - Interface in jakarta.nosql.document
DocumentEntity - Interface in jakarta.nosql.document
A document-oriented database, or document store, is a computer program designed for storing, retrieving, and managing document-oriented information, also known as semi-structured data.
DocumentEntity.DocumentEntityProvider - Interface in jakarta.nosql.document
A provider of DocumentEntity where it will return from the document entity name.
DocumentObserverParser - Interface in jakarta.nosql.document
An observer to a parser; this observer allows checking both the name of an entity and the fields.
DocumentPreparedStatement - Interface in jakarta.nosql.document
An object that represents a precompiled Query statement.
DocumentQuery - Interface in jakarta.nosql.document
Class that contains information to do a select to DocumentCollectionManager
DocumentQuery.DocumentFrom - Interface in jakarta.nosql.document
The DocumentFrom Query
DocumentQuery.DocumentLimit - Interface in jakarta.nosql.document
The Document Order whose define the the maximum number of results to retrieve.
DocumentQuery.DocumentNameCondition - Interface in jakarta.nosql.document
The base to name condition
DocumentQuery.DocumentNameOrder - Interface in jakarta.nosql.document
The Column name order to the builder
DocumentQuery.DocumentNotCondition - Interface in jakarta.nosql.document
The column not condition
DocumentQuery.DocumentOrder - Interface in jakarta.nosql.document
The Document Order whose define the sort in the query.
DocumentQuery.DocumentQueryBuild - Interface in jakarta.nosql.document
The last step to the build of DocumentQuery.
DocumentQuery.DocumentSelect - Interface in jakarta.nosql.document
The initial element in the Document query
DocumentQuery.DocumentSelectProvider - Interface in jakarta.nosql.document
A provider class of DocumentQuery.DocumentSelect
DocumentQuery.DocumentSkip - Interface in jakarta.nosql.document
The Document Order whose define the position of the first result to retrieve.
DocumentQuery.DocumentWhere - Interface in jakarta.nosql.document
The Document Where whose define the condition in the query.
DocumentQueryParams - Interface in jakarta.nosql.document
The result of SelectQueryConverter that has DocumentQuery and Params.
DocumentQueryParser - Interface in jakarta.nosql.document
A query parser to document database type, this class will convert a String to an operation in DocumentCollectionManager.
Documents - Class in jakarta.nosql.document
This class has utilitarian class to Document

E

EMPTY - Static variable in interface jakarta.nosql.document.DocumentObserverParser
 
eq(Document) - Static method in interface jakarta.nosql.document.DocumentCondition
Creates a DocumentCondition that has a Condition.EQUALS, it means a select will scanning to a document collection that has the same name and equals value informed in this document.
eq(T) - Method in interface jakarta.nosql.document.DocumentDeleteQuery.DocumentDeleteNameCondition
Creates the equals condition Condition.EQUALS
eq(T) - Method in interface jakarta.nosql.document.DocumentQuery.DocumentNameCondition
Creates the equals condition Condition.EQUALS

F

find(String) - Method in interface jakarta.nosql.document.DocumentEntity
Find document a document from document name
fireEntity(String) - Method in interface jakarta.nosql.document.DocumentObserverParser
Fire an event to entity name
fireField(String, String) - Method in interface jakarta.nosql.document.DocumentObserverParser
Fire an event to each field in case of mapper process
from(String) - Method in interface jakarta.nosql.document.DocumentDeleteQuery.DocumentDelete
Defines the document collection in the delete query
from(String) - Method in interface jakarta.nosql.document.DocumentQuery.DocumentSelect
Defines the document collection in the query

G

get(Class<T>) - Method in interface jakarta.nosql.document.Document
get(TypeSupplier<T>) - Method in interface jakarta.nosql.document.Document
get() - Method in interface jakarta.nosql.document.Document
Alias to Value.get()
get(String) - Method in interface jakarta.nosql.document.DocumentCollectionManagerFactory
Creates a DocumentCollectionManager from database's name
get() - Method in interface jakarta.nosql.document.DocumentConfiguration
Reads configuration either from default configuration or a file defined by NoSQL provider and then creates a DocumentCollectionManagerFactory instance.
get(Settings) - Method in interface jakarta.nosql.document.DocumentConfiguration
Reads configuration from the Settings instance, the parameters are defined by NoSQL provider, then creates a DocumentCollectionManagerFactory instance.
getCondition() - Method in interface jakarta.nosql.document.DocumentCondition
Gets the conditions to be used in the select
getCondition() - Method in interface jakarta.nosql.document.DocumentDeleteQuery
getter the condition
getCondition() - Method in interface jakarta.nosql.document.DocumentQuery
The conditions that contains in this DocumentQuery If empty, Optional.empty() is true, the implementation might either return an unsupported exception or returns same elements in the database.
getConfiguration() - Static method in interface jakarta.nosql.document.DocumentConfiguration
creates and returns a DocumentConfiguration instance from ServiceLoader
getConfiguration(Class<T>) - Static method in interface jakarta.nosql.document.DocumentConfiguration
creates and returns a DocumentConfiguration instance from ServiceLoader for a particular provider implementation.
getDocument() - Method in interface jakarta.nosql.document.DocumentCondition
Gets the document to be used in the select
getDocumentCollection() - Method in interface jakarta.nosql.document.DocumentDeleteQuery
getter the collection name
getDocumentCollection() - Method in interface jakarta.nosql.document.DocumentQuery
The document collection name
getDocumentNames() - Method in interface jakarta.nosql.document.DocumentEntity
Returns a Set view of the names of document contained in Document Entity
getDocuments() - Method in interface jakarta.nosql.document.DocumentDeleteQuery
Defines which columns will be removed, the database provider might use this information to remove just these fields instead of all entity from DocumentDeleteQuery
getDocuments() - Method in interface jakarta.nosql.document.DocumentEntity
List of all documents
getDocuments() - Method in interface jakarta.nosql.document.DocumentQuery
Returns the documents to returns in that query if empty will return all elements in the query.
getLimit() - Method in interface jakarta.nosql.document.DocumentQuery
 
getName() - Method in interface jakarta.nosql.document.Document
The column's name
getName() - Method in interface jakarta.nosql.document.DocumentEntity
The collection name to DocumentEntity
getParams() - Method in interface jakarta.nosql.document.DocumentDeleteQueryParams
The Params
getParams() - Method in interface jakarta.nosql.document.DocumentQueryParams
The Params
getQuery() - Method in interface jakarta.nosql.document.DocumentDeleteQueryParams
getQuery() - Method in interface jakarta.nosql.document.DocumentQueryParams
getResult() - Method in interface jakarta.nosql.document.DocumentPreparedStatement
Executes a query and return the result as Stream
getResult(DocumentCollectionManager) - Method in interface jakarta.nosql.document.DocumentQuery.DocumentQueryBuild
getSingleResult() - Method in interface jakarta.nosql.document.DocumentPreparedStatement
Returns the result as a single element otherwise it will return an Optional.empty()
getSingleResult(DocumentCollectionManager) - Method in interface jakarta.nosql.document.DocumentQuery.DocumentQueryBuild
getSkip() - Method in interface jakarta.nosql.document.DocumentQuery
 
getSorts() - Method in interface jakarta.nosql.document.DocumentQuery
The sorts that contains in this DocumentQuery The implementation might ignore this option.
getValue() - Method in interface jakarta.nosql.document.Document
the column's value
getValues() - Method in interface jakarta.nosql.document.DocumentEntity
Returns a Collection view of the values contained in this DocumentEntity.
gt(Document) - Static method in interface jakarta.nosql.document.DocumentCondition
Creates a DocumentCondition that has a Condition.GREATER_THAN, it means a select will scanning to a document collection that has the same name and the value greater than informed in this document.
gt(T) - Method in interface jakarta.nosql.document.DocumentDeleteQuery.DocumentDeleteNameCondition
Creates the greater than condition Condition.GREATER_THAN
gt(T) - Method in interface jakarta.nosql.document.DocumentQuery.DocumentNameCondition
Creates the greater than condition Condition.GREATER_THAN
gte(Document) - Static method in interface jakarta.nosql.document.DocumentCondition
Creates a DocumentCondition that has a Condition.GREATER_EQUALS_THAN, it means a select will scanning to a document collection that has the same name and the value greater or equals than informed in this document.
gte(T) - Method in interface jakarta.nosql.document.DocumentDeleteQuery.DocumentDeleteNameCondition
Creates the greater equals than condition Condition.GREATER_EQUALS_THAN
gte(T) - Method in interface jakarta.nosql.document.DocumentQuery.DocumentNameCondition
Creates the greater equals than condition Condition.GREATER_EQUALS_THAN

I

in(Document) - Method in interface jakarta.nosql.document.DocumentCondition.DocumentConditionProvider
Creates a Condition.IN operation
in(Document) - Static method in interface jakarta.nosql.document.DocumentCondition
Creates a DocumentCondition that has a Condition.IN, it means a select will scanning to a document collection that has the same name and the value is within informed in this document.
in(Iterable<T>) - Method in interface jakarta.nosql.document.DocumentDeleteQuery.DocumentDeleteNameCondition
Creates in condition Condition.IN
in(Iterable<T>) - Method in interface jakarta.nosql.document.DocumentQuery.DocumentNameCondition
Creates in condition Condition.IN
insert(DocumentEntity) - Method in interface jakarta.nosql.document.DocumentCollectionManager
Saves document collection entity
insert(DocumentEntity, Duration) - Method in interface jakarta.nosql.document.DocumentCollectionManager
Saves document collection entity with time to live
insert(Iterable<DocumentEntity>) - Method in interface jakarta.nosql.document.DocumentCollectionManager
Saves documents collection entity, by default it's just run for each saving using DocumentCollectionManager.insert(DocumentEntity), each NoSQL vendor might replace to a more appropriate one.
insert(Iterable<DocumentEntity>, Duration) - Method in interface jakarta.nosql.document.DocumentCollectionManager
Saves documents collection entity with time to live, by default it's just run for each saving using DocumentCollectionManager.insert(DocumentEntity, Duration), each NoSQL vendor might replace to a more appropriate one.
isEmpty() - Method in interface jakarta.nosql.document.DocumentEntity
Returns true if this list contains no elements.

J

jakarta.nosql.document - package jakarta.nosql.document
This package contains all objects to use a Document Collection.

L

like(Document) - Static method in interface jakarta.nosql.document.DocumentCondition
Creates a DocumentCondition that has a Condition.LIKE, it means a select will scanning to a document collection that has the same name and the value is like than informed in this document.
like(String) - Method in interface jakarta.nosql.document.DocumentDeleteQuery.DocumentDeleteNameCondition
Creates the like condition Condition.LIKE
like(String) - Method in interface jakarta.nosql.document.DocumentQuery.DocumentNameCondition
Creates the like condition Condition.LIKE
limit(long) - Method in interface jakarta.nosql.document.DocumentQuery.DocumentFrom
Defines the maximum number of results to retrieve.
limit(long) - Method in interface jakarta.nosql.document.DocumentQuery.DocumentNameOrder
Defines the maximum number of results to retrieve.
limit(long) - Method in interface jakarta.nosql.document.DocumentQuery.DocumentSkip
Defines the maximum number of results to retrieve.
limit(long) - Method in interface jakarta.nosql.document.DocumentQuery.DocumentWhere
Defines the maximum number of results to retrieve.
lt(Document) - Static method in interface jakarta.nosql.document.DocumentCondition
Creates a DocumentCondition that has a Condition.LESSER_THAN, it means a select will scanning to a document collection that has the same name and the value lesser than informed in this document.
lt(T) - Method in interface jakarta.nosql.document.DocumentDeleteQuery.DocumentDeleteNameCondition
Creates the lesser than condition Condition.LESSER_THAN
lt(T) - Method in interface jakarta.nosql.document.DocumentQuery.DocumentNameCondition
Creates the lesser than condition Condition.LESSER_THAN
lte(Document) - Static method in interface jakarta.nosql.document.DocumentCondition
Creates a DocumentCondition that has a Condition.LESSER_EQUALS_THAN, it means a select will scanning to a document collection that has the same name and the value lesser or equals than informed in this document.
lte(T) - Method in interface jakarta.nosql.document.DocumentDeleteQuery.DocumentDeleteNameCondition
Creates the lesser equals than condition Condition.LESSER_EQUALS_THAN
lte(T) - Method in interface jakarta.nosql.document.DocumentQuery.DocumentNameCondition
Creates the lesser equals than condition Condition.LESSER_EQUALS_THAN

N

negate() - Method in interface jakarta.nosql.document.DocumentCondition
Creates a new DocumentCondition negating the current one
not() - Method in interface jakarta.nosql.document.DocumentDeleteQuery.DocumentDeleteNameCondition
Creates the equals condition Condition.NOT
not() - Method in interface jakarta.nosql.document.DocumentQuery.DocumentNameCondition
Creates the equals condition Condition.NOT

O

of(String, V) - Static method in interface jakarta.nosql.document.Document
Creates a document instance
of(String) - Static method in interface jakarta.nosql.document.DocumentEntity
Creates a DocumentEntity instance
of(String, List<Document>) - Static method in interface jakarta.nosql.document.DocumentEntity
Creates a DocumentEntity instance
of(String, Object) - Static method in class jakarta.nosql.document.Documents
of(Map<String, ?>) - Static method in class jakarta.nosql.document.Documents
Converts the map to List of Document
or(DocumentCondition...) - Method in interface jakarta.nosql.document.DocumentCondition.DocumentConditionProvider
Creates a Condition.OR operation
or(DocumentCondition) - Method in interface jakarta.nosql.document.DocumentCondition
Creates a new DocumentCondition using the Condition.OR
or(DocumentCondition...) - Static method in interface jakarta.nosql.document.DocumentCondition
Returns a new DocumentCondition aggregating ,as ¨OR", all the conditions as just one condition.
or(String) - Method in interface jakarta.nosql.document.DocumentDeleteQuery.DocumentDeleteWhere
Starts a new condition in the select using DocumentCondition.or(DocumentCondition)
or(String) - Method in interface jakarta.nosql.document.DocumentQuery.DocumentWhere
Appends a new condition in the select using DocumentCondition.or(DocumentCondition)
orderBy(String) - Method in interface jakarta.nosql.document.DocumentQuery.DocumentFrom
Add the order how the result will returned
orderBy(String) - Method in interface jakarta.nosql.document.DocumentQuery.DocumentNameOrder
Add the order how the result will returned
orderBy(String) - Method in interface jakarta.nosql.document.DocumentQuery.DocumentWhere
Add the order how the result will returned

P

prepare(String) - Method in interface jakarta.nosql.document.DocumentCollectionManager
Executes a query and returns the result, when the operations are insert, update and select command it will return the result of the operation when the command is delete it will return an empty collection.
prepare(String, DocumentCollectionManager, DocumentObserverParser) - Method in interface jakarta.nosql.document.DocumentQueryParser
Executes a query and returns a DocumentPreparedStatement, when the operations are insert, update and select command it will return the result of the operation when the command is delete it will return an empty collection.

Q

query(String) - Method in interface jakarta.nosql.document.DocumentCollectionManager
Executes a query and returns the result, when the operations are insert, update and select command it will return the result of the operation when the command is delete it will return an empty collection.
query(String, DocumentCollectionManager, DocumentObserverParser) - Method in interface jakarta.nosql.document.DocumentQueryParser
Executes a query and returns the result, when the operations are insert, update and select command it will return the result of the operation when the command is delete it will return an empty collection.

R

remove(String) - Method in interface jakarta.nosql.document.DocumentEntity
Remove a Document whose name is informed in parameter.

S

select(DocumentQuery) - Method in interface jakarta.nosql.document.DocumentCollectionManager
Finds DocumentEntity from select
select(String...) - Static method in interface jakarta.nosql.document.DocumentQuery
Creates a query to Document
select() - Static method in interface jakarta.nosql.document.DocumentQuery
Creates a query to Document
SelectQueryConverter - Interface in jakarta.nosql.document
A converter that converts SelectQuery to DocumentQueryParams
singleResult(DocumentQuery) - Method in interface jakarta.nosql.document.DocumentCollectionManager
Returns a single entity from select
size() - Method in interface jakarta.nosql.document.DocumentEntity
Returns the number of elements in this list.
skip(long) - Method in interface jakarta.nosql.document.DocumentQuery.DocumentFrom
Defines the position of the first result to retrieve.
skip(long) - Method in interface jakarta.nosql.document.DocumentQuery.DocumentLimit
Defines the position of the first result to retrieve.
skip(long) - Method in interface jakarta.nosql.document.DocumentQuery.DocumentNameOrder
Defines the position of the first result to retrieve.
skip(long) - Method in interface jakarta.nosql.document.DocumentQuery.DocumentWhere
Defines the position of the first result to retrieve.

T

toMap() - Method in interface jakarta.nosql.document.DocumentEntity
Converts the columns to a Map where: the key is the name the column The value is the Value.get() of the map

U

update(DocumentEntity) - Method in interface jakarta.nosql.document.DocumentCollectionManager
Updates a entity
update(Iterable<DocumentEntity>) - Method in interface jakarta.nosql.document.DocumentCollectionManager
Updates documents collection entity, by default it's just run for each saving using DocumentCollectionManager.update(DocumentEntity), each NoSQL vendor might replace to a more appropriate one.

W

where(String) - Method in interface jakarta.nosql.document.DocumentDeleteQuery.DocumentDeleteFrom
Starts a new condition defining the column name
where(String) - Method in interface jakarta.nosql.document.DocumentQuery.DocumentFrom
Starts a new condition defining the column name
A B C D E F G I J L N O P Q R S T U W 
Skip navigation links

Copyright © 2017–2020 Eclipse Foundation. All rights reserved.