CouchbaseQueryMethod (Spring Data Couchbase 4.1.5 API)

java.lang.Object
- org.springframework.data.repository.query.QueryMethod
- - org.springframework.data.couchbase.repository.query.CouchbaseQueryMethod

Direct Known Subclasses:

ReactiveCouchbaseQueryMethod
```
public class CouchbaseQueryMethod
extends QueryMethod
```
Represents a query method with couchbase extensions, allowing to discover if View-based query or N1QL-based query must be used.

Author:

Michael Nitschinger, Simon Baslé, Oliver Gierke, Michael Reiche

Constructor Summary

Constructors
Constructor and Description
`CouchbaseQueryMethod(Method method, RepositoryMetadata metadata, ProjectionFactory factory, MappingContext<? extends CouchbasePersistentEntity<?>,CouchbasePersistentProperty> mappingContext)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WithConsistency`	`getConsistencyAnnotation()`
`Dimensional`	`getDimensionalAnnotation()`
`String`	`getInlineN1qlQuery()` Returns the query string declared in a `Query` annotation or null if neither the annotation found nor the attribute was specified.
`Query`	`getN1qlAnnotation()` Returns the @Query annotation if set, null otherwise.
`Meta`	`getQueryMetaAttributes()` Returns the `Meta` attributes to be applied.
`ScanConsistency`	`getScanConsistencyAnnotation()` ScanConsistency annotation
`View`	`getViewAnnotation()` Returns the @View annotation if set, null otherwise.
`boolean`	`hasConsistencyAnnotation()`
`boolean`	`hasDesignDoc()` If the method has a @View annotation with the designDocument specified.
`boolean`	`hasDimensionalAnnotation()`
`boolean`	`hasInlineN1qlQuery()` If the method has a @Query annotation with an inline Query statement inside.
`boolean`	`hasN1qlAnnotation()` If the method has a @Query annotation.
`boolean`	`hasQueryMetaAttributes()`
`boolean`	`hasReactiveWrapperParameter()`
`boolean`	`hasScanConsistencyAnnotation()` If the method has a @ScanConsistency annotation
`boolean`	`hasViewAnnotation()` If the method has a @View annotation.
`boolean`	`hasViewName()` If the method has a @View annotation with the viewName specified.
`boolean`	`hasViewSpecification()` If the method has a @View annotation with the designDocument and viewName specified.
`boolean`	`isCountQuery()` indicates if the method begins with "count"
`boolean`	`isDeleteQuery()` is this a 'delete'?
`boolean`	`isExistsQuery()` is this an 'exists' query?
`String`	`toString()`

Methods inherited from class org.springframework.data.repository.query.QueryMethod
createParameters, getDomainClass, getEntityInformation, getName, getNamedQueryName, getParameters, getResultProcessor, getReturnedObjectType, isCollectionQuery, isModifyingQuery, isPageQuery, isQueryForEntity, isSliceQuery, isStreamQuery

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CouchbaseQueryMethod
```
public CouchbaseQueryMethod(Method method,
                            RepositoryMetadata metadata,
                            ProjectionFactory factory,
                            MappingContext<? extends CouchbasePersistentEntity<?>,CouchbasePersistentProperty> mappingContext)
```
- Method Detail
  - hasViewAnnotation
```
public boolean hasViewAnnotation()
```
    If the method has a @View annotation.
    
    Returns:
    
    true if it has the annotation, false otherwise.
  - hasViewSpecification
```
public boolean hasViewSpecification()
```
    If the method has a @View annotation with the designDocument and viewName specified.
    
    Returns:
    
    true if it has the annotation and full view specified.
  - hasDesignDoc
```
public boolean hasDesignDoc()
```
    If the method has a @View annotation with the designDocument specified.
    
    Returns:
    
    true if it has the design document specified.
  - hasViewName
```
public boolean hasViewName()
```
    If the method has a @View annotation with the viewName specified.
    
    Returns:
    
    true if it has the view name specified.
  - getViewAnnotation
```
public View getViewAnnotation()
```
    Returns the @View annotation if set, null otherwise.
    
    Returns:
    
    the view annotation of present.
  - hasDimensionalAnnotation
```
public boolean hasDimensionalAnnotation()
```
    Returns:
    
    true if the method has a @Dimensional annotation, false otherwise.
  - getDimensionalAnnotation
```
public Dimensional getDimensionalAnnotation()
```
    Returns:
    
    the @Dimensional annotation if set, null otherwise.
  - hasN1qlAnnotation
```
public boolean hasN1qlAnnotation()
```
    If the method has a @Query annotation.
    
    Returns:
    
    true if it has the annotation, false otherwise.
  - getN1qlAnnotation
```
public Query getN1qlAnnotation()
```
    Returns the @Query annotation if set, null otherwise.
    
    Returns:
    
    the n1ql annotation if present.
  - hasInlineN1qlQuery
```
public boolean hasInlineN1qlQuery()
```
    If the method has a @Query annotation with an inline Query statement inside.
    
    Returns:
    
    true if this has the annotation and N1QL inline statement, false otherwise.
  - hasConsistencyAnnotation
```
public boolean hasConsistencyAnnotation()
```
  - getConsistencyAnnotation
```
public WithConsistency getConsistencyAnnotation()
```
  - hasScanConsistencyAnnotation
```
public boolean hasScanConsistencyAnnotation()
```
    If the method has a @ScanConsistency annotation
    
    Returns:
    
    true if this has the @ScanConsistency annotation
  - getScanConsistencyAnnotation
```
public ScanConsistency getScanConsistencyAnnotation()
```
    ScanConsistency annotation
    
    Returns:
    
    the @ScanConsistency annotation
  - hasQueryMetaAttributes
```
public boolean hasQueryMetaAttributes()
```
    Returns:
    
    return true if Meta annotation is available.
  - getQueryMetaAttributes
```
@Nullable
public Meta getQueryMetaAttributes()
```
    Returns the Meta attributes to be applied.
    
    Returns:
    
    never null.
  - getInlineN1qlQuery
```
public String getInlineN1qlQuery()
```
    Returns the query string declared in a Query annotation or null if neither the annotation found nor the attribute was specified.
    
    Returns:
    
    the query statement if present.
  - isDeleteQuery
```
public boolean isDeleteQuery()
```
    is this a 'delete'?
    
    Returns:
    
    is this a 'delete'?
  - isExistsQuery
```
public boolean isExistsQuery()
```
    is this an 'exists' query?
    
    Returns:
    
    is this an 'exists' query?
  - isCountQuery
```
public boolean isCountQuery()
```
    indicates if the method begins with "count"
    
    Returns:
    
    true if the method begins with "count", indicating that .count() should be called instead of one() or all().
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class QueryMethod
  - hasReactiveWrapperParameter
```
public boolean hasReactiveWrapperParameter()
```

Class CouchbaseQueryMethod

Constructor Summary

Method Summary

Methods inherited from class org.springframework.data.repository.query.QueryMethod

Methods inherited from class java.lang.Object

Constructor Detail

CouchbaseQueryMethod

Method Detail

hasViewAnnotation

hasViewSpecification

hasDesignDoc

hasViewName

getViewAnnotation

hasDimensionalAnnotation

getDimensionalAnnotation

hasN1qlAnnotation

getN1qlAnnotation

hasInlineN1qlQuery

hasConsistencyAnnotation

getConsistencyAnnotation

hasScanConsistencyAnnotation

getScanConsistencyAnnotation

hasQueryMetaAttributes

getQueryMetaAttributes

getInlineN1qlQuery

isDeleteQuery

isExistsQuery

isCountQuery

toString

hasReactiveWrapperParameter