DocumentQuery (communication-document 1.0.0-b2 API)

```
public interface DocumentQuery
```
Class that contains information to do a select to DocumentCollectionManager

See Also:

DocumentCollectionManager.select(DocumentQuery), DocumentCondition, Sort

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`DocumentQuery.DocumentFrom` The DocumentFrom Query
`static interface`	`DocumentQuery.DocumentLimit` The Document Order whose define the the maximum number of results to retrieve.
`static interface`	`DocumentQuery.DocumentNameCondition` The base to name condition
`static interface`	`DocumentQuery.DocumentNameOrder` The Column name order to the builder
`static interface`	`DocumentQuery.DocumentNotCondition` The column not condition
`static interface`	`DocumentQuery.DocumentOrder` The Document Order whose define the sort in the query.
`static interface`	`DocumentQuery.DocumentQueryBuild` The last step to the build of `DocumentQuery`.
`static interface`	`DocumentQuery.DocumentSelect` The initial element in the Document query
`static interface`	`DocumentQuery.DocumentSelectProvider` A provider class of `DocumentQuery.DocumentSelect`
`static interface`	`DocumentQuery.DocumentSkip` The Document Order whose define the position of the first result to retrieve.
`static interface`	`DocumentQuery.DocumentWhere` The Document Where whose define the condition in the query.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Optional<DocumentCondition>`	`getCondition()` 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.
`String`	`getDocumentCollection()` The document collection name
`List<String>`	`getDocuments()` Returns the documents to returns in that query if empty will return all elements in the query.
`long`	`getLimit()`
`long`	`getSkip()`
`List<Sort>`	`getSorts()` The sorts that contains in this `DocumentQuery` The implementation might ignore this option.
`static DocumentQuery.DocumentSelect`	`select()` Creates a query to Document
`static DocumentQuery.DocumentSelect`	`select(String... documents)` Creates a query to Document

- Method Detail
  - getLimit
```
long getLimit()
```
    Returns:
    
    The maximum number of results the select object was set to retrieve. The implementation might ignore this option.
  - getSkip
```
long getSkip()
```
    Returns:
    
    The position of the first result the select object was set to retrieve. The implementation might ignore this option.
  - getDocumentCollection
```
String getDocumentCollection()
```
    The document collection name
    
    Returns:
    
    the document collection name
  - getCondition
```
Optional<DocumentCondition> getCondition()
```
    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.
    
    Returns:
    
    the conditions
  - getSorts
```
List<Sort> getSorts()
```
    The sorts that contains in this DocumentQuery The implementation might ignore this option.
    
    Returns:
    
    the sorts
  - getDocuments
```
List<String> getDocuments()
```
    Returns the documents to returns in that query if empty will return all elements in the query. The implementation might ignore this option.
    
    Returns:
    
    the documents
  - select
```
static DocumentQuery.DocumentSelect select(String... documents)
```
    Creates a query to Document
    
    Parameters:
    
    documents - - The document fields to query, optional.
    
    Returns:
    
    a new DocumentQuery.DocumentSelect instance
    
    Throws:
    
    NullPointerException - when there is a null element
  - select
```
static DocumentQuery.DocumentSelect select()
```
    Creates a query to Document
    
    Returns:
    
    a new DocumentQuery.DocumentSelect instance
    
    Throws:
    
    NullPointerException - when there is a null element

Interface DocumentQuery

Nested Class Summary

Method Summary

Method Detail

getLimit

getSkip

getDocumentCollection

getCondition

getSorts

getDocuments

select

select