RxGormStaticApi (GORM for Rx 8.1.2)

org.grails.gorm.rx.api.RxGormStaticApi

All Implemented Interfaces and Traits:

RxGormAllOperations<D>
```
@groovy.transform.CompileStatic
class RxGormStaticApi<D>
extends java.lang.Object
implements RxGormAllOperations<D>
```
Bridge to the implementation of the static method level operations for RX GORM
Authors:
Graeme Rocher
Since:
6.0

Nested Class Summary

Nested classes
Modifiers	Name	Description
`class`	`RxGormStaticApi.1`

Field Summary

Fields
Modifiers	Name	Description
`protected ConnectionSources`	`connectionSources`
`private RxDatastoreClient`	`datastoreClient`
`private PersistentEntity`	`entity`
`private java.util.List<FinderMethod>`	`gormDynamicFinders`
`protected MultiTenancyMode`	`multiTenancyMode`
`private java.lang.Class`	`persistentClass`

Properties Summary

Properties
Type	Name and description
`RxDatastoreClient`	`datastoreClient`
`PersistentEntity`	`entity`
`java.util.List<FinderMethod>`	`gormDynamicFinders`
`java.lang.Class`	`persistentClass`

Constructor Summary

Constructors
Constructor and description
`RxGormStaticApi (PersistentEntity entity, RxDatastoreClient datastoreClient)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`rx.Observable<java.lang.Number>`	`count()` Returns: Counts the number of instances
	`D`	`create()` Retrieve an instance by id
	`CriteriaBuilder<D>`	`createCriteria()` Creates a criteria builder instance
	`protected java.util.List<FinderMethod>`	`createDynamicFinders()`
	`rx.Observable<java.lang.Boolean>`	`delete(D instance)`
	`rx.Observable<java.lang.Boolean>`	`delete(D instance, java.util.Map arguments)`
	`rx.Observable<java.lang.Number>`	`deleteAll(D[] objects)`
	`rx.Observable<java.lang.Number>`	`deleteAll(java.lang.Iterable objects)` Batch deletes a number of objects in one go
	`RxGormAllOperations<D>`	`eachTenant(groovy.lang.Closure callable)`
	`rx.Observable<java.lang.Boolean>`	`exists(java.io.Serializable id)`
	`rx.Observable<D>`	`find(groovy.lang.Closure callable)` Uses detached criteria to build a query and then execute it returning an observable
	`rx.Observable<D>`	`findAll(java.util.Map params)`
	`rx.Observable<D>`	`findAll(groovy.lang.Closure callable)` Uses detached criteria to build a query and then execute it returning an observable
	`rx.Observable<D>`	`findAllWhere(java.util.Map queryMap)` Finds a single result matching all of the given conditions.
	`rx.Observable<D>`	`findAllWhere(java.util.Map queryMap, java.util.Map args)` Finds a single result matching all of the given conditions.
	`rx.Observable<D>`	`findOrCreateWhere(java.util.Map queryMap)` Finds a single result matching all of the given conditions.
	`rx.Observable<D>`	`findOrSaveWhere(java.util.Map queryMap)` Finds a single result matching all of the given conditions.
	`rx.Observable<D>`	`findWhere(java.util.Map queryMap)` Finds a single result matching all of the given conditions.
	`rx.Observable<D>`	`findWhere(java.util.Map queryMap, java.util.Map args)` Finds a single result matching all of the given conditions.
	`rx.Observable<D>`	`first(java.lang.String property)` Finds the first object sorted by propertyName
	`rx.Observable<D>`	`first(java.util.Map params)` Finds the first object.
	`rx.Observable<D>`	`get(java.io.Serializable id, java.util.Map args)`
	`java.io.Serializable`	`ident(D instance)`
	`rx.Observable<D>`	`insert(D instance)`
	`rx.Observable<D>`	`insert(D instance, java.util.Map arguments)`
	`rx.Observable<java.util.List<java.io.Serializable>>`	`insertAll(java.lang.Iterable<D> objects, java.util.Map arguments)`
	`rx.Observable<java.util.List<java.io.Serializable>>`	`insertAll(D[] objects)`
	`rx.Observable<D>`	`last(java.lang.String property)` Finds the last object sorted by propertyName
	`rx.Observable<D>`	`last(java.util.Map params)` Finds the last object.
	`rx.Observable<java.util.List<D>>`	`list(java.util.Map params)`
	`rx.Observable<D>`	`methodMissing(java.lang.String methodName, java.lang.Object args)`
	`java.lang.Object`	`propertyMissing(java.lang.String name)` Property missing handler
	`ObservableProxy<D>`	`proxy(java.io.Serializable id)`
	`ObservableProxy<D>`	`proxy(java.io.Serializable id, java.util.Map queryArgs)`
	`ObservableProxy<D>`	`proxy(DetachedCriteria<D> query)`
	`ObservableProxy<D>`	`proxy(DetachedCriteria<D> query, java.util.Map queryArgs)`
	`rx.Observable<D>`	`save(D instance)`
	`rx.Observable<D>`	`save(D instance, java.util.Map arguments)`
	`rx.Observable<java.util.List<java.io.Serializable>>`	`saveAll(java.lang.Iterable<D> objects, java.util.Map arguments)` Batch saves all of the given objects
	`rx.Observable<java.util.List<java.io.Serializable>>`	`saveAll(D[] objects)`
	`rx.Observable<D>`	`staticMethodMissing(java.lang.String methodName, java.lang.Object arg)`
	`java.lang.Object`	`staticPropertyMissing(java.lang.String property)`
	`DetachedCriteria<D>`	`where(groovy.lang.Closure callable)` Parameters: `callable` - Callable closure containing detached criteria definition
	`DetachedCriteria<D>`	`whereAny(groovy.lang.Closure callable)` Parameters: `callable` - Callable closure containing detached criteria definition
	`DetachedCriteria<D>`	`whereLazy(groovy.lang.Closure callable)` Parameters: `callable` - Callable closure containing detached criteria definition
	`rx.Observable`	`withCriteria(groovy.lang.Closure callable)` Creates a criteria builder instance
	`rx.Observable`	`withCriteria(java.util.Map builderArgs, groovy.lang.Closure callable)` Creates a criteria builder instance
`<T>`	`T`	`withTenant(java.io.Serializable tenantId, groovy.lang.Closure<T> callable)`
	`RxGormAllOperations<D>`	`withTenant(java.io.Serializable tenantId)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - protected final ConnectionSources connectionSources
  - private final RxDatastoreClient datastoreClient
  - private final PersistentEntity entity
  - private final java.util.List<FinderMethod> gormDynamicFinders
  - protected final MultiTenancyMode multiTenancyMode
  - private final java.lang.Class persistentClass
- Property Detail
  - final RxDatastoreClient datastoreClient
  - final PersistentEntity entity
  - final java.util.List<FinderMethod> gormDynamicFinders
  - final java.lang.Class persistentClass
- Constructor Detail
  - RxGormStaticApi(PersistentEntity entity, RxDatastoreClient datastoreClient)
- Method Detail
  - rx.Observable<java.lang.Number> count()
    
    Returns:
    Counts the number of instances
  - @java.lang.Override D create()
    
    Retrieve an instance by id
    Parameters:
    id - The id of the instance
    Returns:
    An observable
  - CriteriaBuilder<D> createCriteria()
    
    Creates a criteria builder instance
  - protected java.util.List<FinderMethod> createDynamicFinders()
  - @java.lang.Override rx.Observable<java.lang.Boolean> delete(D instance)
  - @java.lang.Override rx.Observable<java.lang.Boolean> delete(D instance, java.util.Map arguments)
  - @java.lang.Override rx.Observable<java.lang.Number> deleteAll(D[] objects)
  - rx.Observable<java.lang.Number> deleteAll(java.lang.Iterable objects)
    
    Batch deletes a number of objects in one go
    Parameters:
    objects - The objects to delete
    Returns:
    The number of objects actually deleted
  - @java.lang.Override RxGormAllOperations<D> eachTenant(@groovy.lang.DelegatesTo(value: RxGormAllOperations) groovy.lang.Closure callable)
  - @java.lang.Override rx.Observable<java.lang.Boolean> exists(java.io.Serializable id)
  - rx.Observable<D> find(groovy.lang.Closure callable)
    
    Uses detached criteria to build a query and then execute it returning an observable
    Parameters:
    callable - The callable
    Returns:
    The observable
  - rx.Observable<D> findAll(java.util.Map params)
  - rx.Observable<D> findAll(groovy.lang.Closure callable)
    
    Uses detached criteria to build a query and then execute it returning an observable
    Parameters:
    callable - The callable
    Returns:
    The observable
  - rx.Observable<D> findAllWhere(java.util.Map queryMap)
    
    Finds a single result matching all of the given conditions. Eg. Book.findWhere(author:"Stephen King", title:"The Stand")
    Parameters:
    queryMap - The map of conditions
    Returns:
    A single result
  - rx.Observable<D> findAllWhere(java.util.Map queryMap, java.util.Map args)
    
    Finds a single result matching all of the given conditions. Eg. Book.findWhere(author:"Stephen King", title:"The Stand")
    Parameters:
    queryMap - The map of conditions
    args - The Query arguments
    Returns:
    A single result
  - rx.Observable<D> findOrCreateWhere(java.util.Map queryMap)
    
    Finds a single result matching all of the given conditions. Eg. Book.findWhere(author:"Stephen King", title:"The Stand"). If a matching persistent entity is not found a new entity is created and returned.
    Parameters:
    queryMap - The map of conditions
    Returns:
    A single result
  - rx.Observable<D> findOrSaveWhere(java.util.Map queryMap)
    
    Finds a single result matching all of the given conditions. Eg. Book.findWhere(author:"Stephen King", title:"The Stand"). If a matching persistent entity is not found a new entity is created, saved and returned.
    Parameters:
    queryMap - The map of conditions
    Returns:
    A single result
  - rx.Observable<D> findWhere(java.util.Map queryMap)
    
    Finds a single result matching all of the given conditions. Eg. Book.findWhere(author:"Stephen King", title:"The Stand")
    Parameters:
    queryMap - The map of conditions
    Returns:
    A single result
  - rx.Observable<D> findWhere(java.util.Map queryMap, java.util.Map args)
    
    Finds a single result matching all of the given conditions. Eg. Book.findWhere(author:"Stephen King", title:"The Stand")
    Parameters:
    queryMap - The map of conditions
    args - The Query arguments
    Returns:
    A single result
  - rx.Observable<D> first(java.lang.String property)
    
    Finds the first object sorted by propertyName
    Parameters:
    propertyName - the name of the property to sort by
    Returns:
    A single that will emit the first object, if it exists
  - rx.Observable<D> first(java.util.Map params)
    
    Finds the first object. If queryParams includes 'sort', that will dictate the sort order, otherwise natural sort order will be used. queryParams may include any of the same parameters that might be passed to the list(Map) method. This method will ignore 'order' and 'max' as those are always 'asc' and 1, respectively.
    Returns:
    A single that will emit the first object, if it exists
  - @java.lang.Override rx.Observable<D> get(java.io.Serializable id, java.util.Map args)
  - @java.lang.Override java.io.Serializable ident(D instance)
  - @java.lang.Override rx.Observable<D> insert(D instance)
  - @java.lang.Override rx.Observable<D> insert(D instance, java.util.Map arguments)
  - @java.lang.Override rx.Observable<java.util.List<java.io.Serializable>> insertAll(java.lang.Iterable<D> objects, java.util.Map arguments)
  - @java.lang.Override rx.Observable<java.util.List<java.io.Serializable>> insertAll(D[] objects)
  - rx.Observable<D> last(java.lang.String property)
    
    Finds the last object sorted by propertyName
    Parameters:
    propertyName - the name of the property to sort by
    Returns:
    A single that will emit the first object, if it exists
  - rx.Observable<D> last(java.util.Map params)
    
    Finds the last object. If queryParams includes 'sort', that will dictate the sort order, otherwise natural sort order will be used. queryParams may include any of the same parameters that might be passed to the list(Map) method. This method will ignore 'order' and 'max' as those are always 'desc' and 1, respectively.
    Returns:
    A single that will emit the last object, if it exists
  - rx.Observable<java.util.List<D>> list(java.util.Map params)
  - @groovy.transform.CompileDynamic rx.Observable<D> methodMissing(java.lang.String methodName, java.lang.Object args)
  - java.lang.Object propertyMissing(java.lang.String name)
    
    Property missing handler
    Parameters:
    name - The name of the property
  - @java.lang.Override ObservableProxy<D> proxy(java.io.Serializable id)
  - @java.lang.Override ObservableProxy<D> proxy(java.io.Serializable id, java.util.Map queryArgs)
  - @java.lang.Override ObservableProxy<D> proxy(DetachedCriteria<D> query)
  - @java.lang.Override ObservableProxy<D> proxy(DetachedCriteria<D> query, java.util.Map queryArgs)
  - @java.lang.Override rx.Observable<D> save(D instance)
  - @java.lang.Override rx.Observable<D> save(D instance, java.util.Map arguments)
  - @java.lang.Override rx.Observable<java.util.List<java.io.Serializable>> saveAll(java.lang.Iterable<D> objects, java.util.Map arguments)
    
    Batch saves all of the given objects
    Parameters:
    objects - The objects to save
    Returns:
    An observable that emits the identifiers of the saved objects
  - @java.lang.Override rx.Observable<java.util.List<java.io.Serializable>> saveAll(D[] objects)
  - @java.lang.Override rx.Observable<D> staticMethodMissing(java.lang.String methodName, java.lang.Object arg)
  - @java.lang.Override java.lang.Object staticPropertyMissing(java.lang.String property)
  - DetachedCriteria<D> where(groovy.lang.Closure callable)
    
    Parameters:
    callable - Callable closure containing detached criteria definition
    Returns:
    The DetachedCriteria instance
  - DetachedCriteria<D> whereAny(groovy.lang.Closure callable)
    
    Parameters:
    callable - Callable closure containing detached criteria definition
    Returns:
    The DetachedCriteria instance
  - DetachedCriteria<D> whereLazy(groovy.lang.Closure callable)
    
    Parameters:
    callable - Callable closure containing detached criteria definition
    Returns:
    The DetachedCriteria instance that is lazily initialized
  - rx.Observable withCriteria(@groovy.lang.DelegatesTo(value: Criteria) groovy.lang.Closure callable)
    
    Creates a criteria builder instance
  - rx.Observable withCriteria(java.util.Map builderArgs, @groovy.lang.DelegatesTo(value: Criteria) groovy.lang.Closure callable)
    
    Creates a criteria builder instance
  - <T> @java.lang.Override T withTenant(java.io.Serializable tenantId, @groovy.lang.DelegatesTo(value: RxGormAllOperations) groovy.lang.Closure<T> callable)
  - @java.lang.Override RxGormAllOperations<D> withTenant(java.io.Serializable tenantId)

Groovy Documentation

[Groovy] Class RxGormStaticApi<D>

Nested Class Summary

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected final ConnectionSources connectionSources

private final RxDatastoreClient datastoreClient

private final PersistentEntity entity

private final java.util.List<FinderMethod> gormDynamicFinders

protected final MultiTenancyMode multiTenancyMode

private final java.lang.Class persistentClass

Property Detail

final RxDatastoreClient datastoreClient

final PersistentEntity entity

final java.util.List<FinderMethod> gormDynamicFinders

final java.lang.Class persistentClass

Constructor Detail

RxGormStaticApi(PersistentEntity entity, RxDatastoreClient datastoreClient)

Method Detail

rx.Observable<java.lang.Number> count()

@java.lang.Override D create()

CriteriaBuilder<D> createCriteria()

protected java.util.List<FinderMethod> createDynamicFinders()

@java.lang.Override rx.Observable<java.lang.Boolean> delete(D instance)

@java.lang.Override rx.Observable<java.lang.Boolean> delete(D instance, java.util.Map arguments)

@java.lang.Override rx.Observable<java.lang.Number> deleteAll(D[] objects)

rx.Observable<java.lang.Number> deleteAll(java.lang.Iterable objects)

@java.lang.Override RxGormAllOperations<D> eachTenant(@groovy.lang.DelegatesTo(value: RxGormAllOperations) groovy.lang.Closure callable)

@java.lang.Override rx.Observable<java.lang.Boolean> exists(java.io.Serializable id)

rx.Observable<D> find(groovy.lang.Closure callable)

rx.Observable<D> findAll(java.util.Map params)

rx.Observable<D> findAll(groovy.lang.Closure callable)

rx.Observable<D> findAllWhere(java.util.Map queryMap)

rx.Observable<D> findAllWhere(java.util.Map queryMap, java.util.Map args)

rx.Observable<D> findOrCreateWhere(java.util.Map queryMap)

rx.Observable<D> findOrSaveWhere(java.util.Map queryMap)

rx.Observable<D> findWhere(java.util.Map queryMap)

rx.Observable<D> findWhere(java.util.Map queryMap, java.util.Map args)

rx.Observable<D> first(java.lang.String property)

rx.Observable<D> first(java.util.Map params)

@java.lang.Override rx.Observable<D> get(java.io.Serializable id, java.util.Map args)

@java.lang.Override java.io.Serializable ident(D instance)

@java.lang.Override rx.Observable<D> insert(D instance)

@java.lang.Override rx.Observable<D> insert(D instance, java.util.Map arguments)

@java.lang.Override rx.Observable<java.util.List<java.io.Serializable>> insertAll(java.lang.Iterable<D> objects, java.util.Map arguments)

@java.lang.Override rx.Observable<java.util.List<java.io.Serializable>> insertAll(D[] objects)

rx.Observable<D> last(java.lang.String property)

rx.Observable<D> last(java.util.Map params)

rx.Observable<java.util.List<D>> list(java.util.Map params)

@groovy.transform.CompileDynamic rx.Observable<D> methodMissing(java.lang.String methodName, java.lang.Object args)

java.lang.Object propertyMissing(java.lang.String name)

@java.lang.Override ObservableProxy<D> proxy(java.io.Serializable id)

@java.lang.Override ObservableProxy<D> proxy(java.io.Serializable id, java.util.Map queryArgs)

@java.lang.Override ObservableProxy<D> proxy(DetachedCriteria<D> query)

@java.lang.Override ObservableProxy<D> proxy(DetachedCriteria<D> query, java.util.Map queryArgs)

@java.lang.Override rx.Observable<D> save(D instance)

@java.lang.Override rx.Observable<D> save(D instance, java.util.Map arguments)

@java.lang.Override rx.Observable<java.util.List<java.io.Serializable>> saveAll(java.lang.Iterable<D> objects, java.util.Map arguments)

@java.lang.Override rx.Observable<java.util.List<java.io.Serializable>> saveAll(D[] objects)

@java.lang.Override rx.Observable<D> staticMethodMissing(java.lang.String methodName, java.lang.Object arg)

@java.lang.Override java.lang.Object staticPropertyMissing(java.lang.String property)

DetachedCriteria<D> where(groovy.lang.Closure callable)

DetachedCriteria<D> whereAny(groovy.lang.Closure callable)

DetachedCriteria<D> whereLazy(groovy.lang.Closure callable)

rx.Observable withCriteria(@groovy.lang.DelegatesTo(value: Criteria) groovy.lang.Closure callable)

rx.Observable withCriteria(java.util.Map builderArgs, @groovy.lang.DelegatesTo(value: Criteria) groovy.lang.Closure callable)

<T> @java.lang.Override T withTenant(java.io.Serializable tenantId, @groovy.lang.DelegatesTo(value: RxGormAllOperations) groovy.lang.Closure<T> callable)

@java.lang.Override RxGormAllOperations<D> withTenant(java.io.Serializable tenantId)