RxEntity (GORM for Rx 8.1.2)

grails.gorm.rx.RxEntity

All Implemented Interfaces and Traits:

DirtyCheckable, GormValidateable, RxGormOperations<D>, java.io.Serializable
```
@groovy.transform.Trait
@groovy.transform.CompileStatic
trait RxEntity<D>
extends java.lang.Object
implements DirtyCheckable, GormValidateable, RxGormOperations<D>, java.io.Serializable
```
Represents a reactive GORM entity
Authors:
Graeme Rocher
Since:
6.0
Type Parameters:
D - The entity type

Methods Summary

Methods
Type Params	Return Type	Name and description
	`D`	`addTo(java.lang.String associationName, java.lang.Object arg)` Adds the given value to given association ensuring both sides are correctly associated
	`static rx.Observable<java.lang.Number>`	`count()` Returns: Counts the number of instances
	`static D`	`create()` Returns: A new instance of this RxEntity
	`static CriteriaBuilder<D>`	`createCriteria()` Creates a criteria builder instance
	`private RxGormInstanceApi<D>`	`currentRxGormInstanceApi()`
	`private static RxGormStaticApi<D>`	`currentRxGormStaticApi()`
	`rx.Observable<java.lang.Boolean>`	`delete(java.util.Map arguments)` Deletes an entity
	`static rx.Observable<java.lang.Number>`	`deleteAll(D[] objects)` Batch deletes a number of objects in one go
	`static rx.Observable<java.lang.Number>`	`deleteAll(java.lang.Iterable<D> objects)` Batch deletes a number of objects in one go
	`private rx.Observable<D>`	`doSave(java.util.Map arguments, boolean isInsert)`
	`static rx.Observable<java.lang.Boolean>`	`exists(java.io.Serializable id)` Check whether an entity exists for the given id
	`static rx.Observable<D>`	`find(groovy.lang.Closure callable)` Uses detached criteria to build a query and then execute it returning an observable
	`static rx.Observable<D>`	`findAll()` List all entities and return an observable
	`static rx.Observable<D>`	`findAll(java.util.Map args)` List all entities and return an observable
	`static rx.Observable<D>`	`findAll(groovy.lang.Closure callable)` Uses detached criteria to build a query and then execute it returning an observable
	`static rx.Observable<D>`	`findAllWhere(java.util.Map queryMap)` Finds all results matching all of the given conditions.
	`static rx.Observable<D>`	`findAllWhere(java.util.Map queryMap, java.util.Map args)` Finds all results matching all of the given conditions.
	`static rx.Observable<D>`	`findOrCreateWhere(java.util.Map queryMap)` Finds a single result matching all of the given conditions.
	`static rx.Observable<D>`	`findOrSaveWhere(java.util.Map queryMap)` Finds a single result matching all of the given conditions.
	`static rx.Observable<D>`	`findWhere(java.util.Map queryMap)` Finds a single result matching all of the given conditions.
	`static rx.Observable<D>`	`findWhere(java.util.Map queryMap, java.util.Map args)` Finds a single result matching all of the given conditions.
	`static rx.Observable<D>`	`first()` Finds the first object using the natural sort order
	`static rx.Observable<D>`	`first(java.lang.String propertyName)` Finds the first object sorted by propertyName
	`static rx.Observable<D>`	`first(java.util.Map queryParams)` Finds the first object.
	`static rx.Observable<D>`	`get(java.io.Serializable id, java.util.Map args)` Retrieve an instance by id
	`java.io.Serializable`	`getAssociationId(java.lang.String associationName)` Obtains the id of an association without initialising the association
	`static java.util.List<FinderMethod>`	`getGormDynamicFinders()` Returns: The dynamic finders for this domain class
	`static PersistentEntity`	`getGormPersistentEntity()`
	`java.io.Serializable`	`ident()` Returns the objects identifier
	`rx.Observable<D>`	`insert(java.util.Map arguments)`
	`static rx.Observable<java.util.List<java.io.Serializable>>`	`insertAll(java.lang.Iterable<D> objects, java.util.Map arguments)` Batch saves all of the given objects
	`static rx.Observable<java.util.List<java.io.Serializable>>`	`insertAll(D[] objects)` Batch saves all of the given objects
	`boolean`	`isDirty(java.lang.String fieldName)` Checks whether a field is dirty
	`boolean`	`isDirty()` Checks whether an entity is dirty
	`static rx.Observable<D>`	`last()` Finds the last object using the natural sort order
	`static rx.Observable<D>`	`last(java.lang.String propertyName)` Finds the last object sorted by propertyName
	`static rx.Observable<D>`	`last(java.util.Map<java.lang.String, java.lang.Object> params)` Finds the last object.
	`static rx.Observable<java.util.List<D>>`	`list()` List all entities and return an observable
	`static rx.Observable<java.util.List<D>>`	`list(java.util.Map args)` List all entities and return an observable
	`static ObservableProxy<D>`	`proxy(java.io.Serializable id, java.util.Map args)` Obtain a proxy to the given instance
	`static ObservableProxy<D>`	`proxy(DetachedCriteria<D> query, java.util.Map args)` Obtain a proxy to the given instance
	`D`	`removeFrom(java.lang.String associationName, java.lang.Object arg)` Removes the given value to given association ensuring both sides are correctly disassociated
	`rx.Observable<D>`	`save()` Save an instance and return an observable
	`rx.Observable<D>`	`save(java.util.Map arguments)` Save an instance and return an observable
	`static 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
	`static rx.Observable<java.util.List<java.io.Serializable>>`	`saveAll(D[] objects)` Batch saves all of the given objects
	`static rx.Observable<D>`	`staticMethodMissing(java.lang.String methodName, java.lang.Object arg)` Handles dynamic finders
	`static java.lang.Object`	`staticPropertyMissing(java.lang.String property)`
	`boolean`	`validate(java.util.Map arguments)`
	`boolean`	`validate(java.util.List fields)`
	`boolean`	`validate()`
	`static DetachedCriteria<D>`	`where(groovy.lang.Closure callable)` Parameters: `callable` - Callable closure containing detached criteria definition
	`static DetachedCriteria<D>`	`whereAny(groovy.lang.Closure callable)` Parameters: `callable` - Callable closure containing detached criteria definition
	`static DetachedCriteria<D>`	`whereLazy(groovy.lang.Closure callable)` Parameters: `callable` - Callable closure containing detached criteria definition
	`RxGormAllOperations<D>`	`withConnection(java.lang.String connectionName)` Perform operations with the given connection
`<T>`	`static T`	`withConnection(java.lang.String connectionName, groovy.lang.Closure<T> callable)` Switches to given named connection within the context of the closure.
	`static rx.Observable`	`withCriteria(groovy.lang.Closure callable)` Creates a criteria builder instance
	`static rx.Observable`	`withCriteria(java.util.Map builderArgs, groovy.lang.Closure callable)` Creates a criteria builder instance

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()`

- Method Detail
  - D addTo(java.lang.String associationName, java.lang.Object arg)
    
    Adds the given value to given association ensuring both sides are correctly associated
    Parameters:
    associationName - The association name
    arg - The value
    Returns:
    This domain instance
  - static rx.Observable<java.lang.Number> count()
    
    Returns:
    Counts the number of instances
  - static D create()
    
    Returns:
    A new instance of this RxEntity
  - static CriteriaBuilder<D> createCriteria()
    
    Creates a criteria builder instance
  - private RxGormInstanceApi<D> currentRxGormInstanceApi()
  - private static RxGormStaticApi<D> currentRxGormStaticApi()
  - @java.lang.Override rx.Observable<java.lang.Boolean> delete(java.util.Map arguments)
    
    Deletes an entity
    Returns:
    An observable that returns a boolean true if successful
  - static rx.Observable<java.lang.Number> deleteAll(D[] objects)
    
    Batch deletes a number of objects in one go
    Parameters:
    objects - The objects to delete
    Returns:
    The number of objects actually deleted
  - static rx.Observable<java.lang.Number> deleteAll(java.lang.Iterable<D> objects)
    
    Batch deletes a number of objects in one go
    Parameters:
    objects - The objects to delete
    Returns:
    The number of objects actually deleted
  - private rx.Observable<D> doSave(java.util.Map arguments, boolean isInsert)
  - static rx.Observable<java.lang.Boolean> exists(java.io.Serializable id)
    
    Check whether an entity exists for the given id @return
    Parameters:
    id
  - static rx.Observable<D> find(@groovy.lang.DelegatesTo(value: DetachedCriteria) 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
  - static rx.Observable<D> findAll()
    
    List all entities and return an observable
    Returns:
    An observable with all results
  - static rx.Observable<D> findAll(java.util.Map args)
    
    List all entities and return an observable
    Returns:
    An observable with all results
  - static rx.Observable<D> findAll(@groovy.lang.DelegatesTo(value: DetachedCriteria) 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
  - static rx.Observable<D> findAllWhere(java.util.Map queryMap)
    
    Finds all results matching all of the given conditions. Eg. Book.findAllWhere(author:"Stephen King", title:"The Stand")
    Parameters:
    queryMap - The map of conditions
    Returns:
    A list of results
  - static rx.Observable<D> findAllWhere(java.util.Map queryMap, java.util.Map args)
    
    Finds all results matching all of the given conditions. Eg. Book.findAllWhere(author:"Stephen King", title:"The Stand")
    Parameters:
    queryMap - The map of conditions
    args - The Query arguments
    Returns:
    A list of results
  - static 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
  - static 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
  - static 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
  - static 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
  - static rx.Observable<D> first()
    
    Finds the first object using the natural sort order
    Returns:
    A single that will emit the first object, if it exists
  - static rx.Observable<D> first(java.lang.String propertyName)
    
    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
  - static rx.Observable<D> first(java.util.Map queryParams)
    
    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:
    the first object in the datastore, null if none exist
  - static rx.Observable<D> get(java.io.Serializable id, java.util.Map args)
    
    Retrieve an instance by id
    Parameters:
    id - The id of the instance
    Returns:
    An observable
  - java.io.Serializable getAssociationId(java.lang.String associationName)
    
    Obtains the id of an association without initialising the association
    Parameters:
    associationName - The association name
    Returns:
    The id of the association or null if it doesn't have one
  - static java.util.List<FinderMethod> getGormDynamicFinders()
    
    Returns:
    The dynamic finders for this domain class
  - static PersistentEntity getGormPersistentEntity()
  - java.io.Serializable ident()
    
    Returns the objects identifier
  - @java.lang.Override rx.Observable<D> insert(java.util.Map arguments)
  - static rx.Observable<java.util.List<java.io.Serializable>> insertAll(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
  - static rx.Observable<java.util.List<java.io.Serializable>> insertAll(D[] objects)
    
    Batch saves all of the given objects
    Parameters:
    objects - The objects to save
    Returns:
    An observable that emits the identifiers of the saved objects
  - boolean isDirty(java.lang.String fieldName)
    
    Checks whether a field is dirty
    Parameters:
    instance - The instance
    fieldName - The name of the field
    Returns:
    true if the field is dirty
  - boolean isDirty()
    
    Checks whether an entity is dirty
    Parameters:
    instance - The instance
    Returns:
    true if it is dirty
  - static rx.Observable<D> last()
    
    Finds the last object using the natural sort order
    Returns:
    A single that will emit the last object, if it exists
  - static rx.Observable<D> last(java.lang.String propertyName)
    
    Finds the last object sorted by propertyName
    Parameters:
    propertyName - the name of the property to sort by
    Returns:
    A single that will emit the last object, if it exists
  - static rx.Observable<D> last(java.util.Map<java.lang.String, java.lang.Object> 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
  - static rx.Observable<java.util.List<D>> list()
    
    List all entities and return an observable
    Returns:
    An observable with all results
  - static rx.Observable<java.util.List<D>> list(java.util.Map args)
    
    List all entities and return an observable
    Returns:
    An observable with all results
  - static ObservableProxy<D> proxy(java.io.Serializable id, java.util.Map args)
    
    Obtain a proxy to the given instance
    Parameters:
    id - The id of the instance
    Returns:
    An observable
  - static ObservableProxy<D> proxy(DetachedCriteria<D> query, java.util.Map args)
    
    Obtain a proxy to the given instance
    Parameters:
    query - The query that returns the instance
    Returns:
    An observable
  - D removeFrom(java.lang.String associationName, java.lang.Object arg)
    
    Removes the given value to given association ensuring both sides are correctly disassociated
    Parameters:
    associationName - The association name
    arg - The value
    Returns:
    This domain instance
  - rx.Observable<D> save()
    
    Save an instance and return an observable
    Returns:
    An observable
  - rx.Observable<D> save(java.util.Map arguments)
    
    Save an instance and return an observable
    Returns:
    An observable
  - static 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
  - static rx.Observable<java.util.List<java.io.Serializable>> saveAll(D[] objects)
    
    Batch saves all of the given objects
    Parameters:
    objects - The objects to save
    Returns:
    An observable that emits the identifiers of the saved objects
  - static rx.Observable<D> staticMethodMissing(java.lang.String methodName, java.lang.Object arg)
    
    Handles dynamic finders
    Parameters:
    methodName - The method name
    arg - The argument to the method
    Returns:
    An observable with the result
  - static java.lang.Object staticPropertyMissing(java.lang.String property)
  - @java.lang.Override boolean validate(java.util.Map arguments)
  - @java.lang.Override boolean validate(java.util.List fields)
  - @java.lang.Override boolean validate()
  - static DetachedCriteria<D> where(@groovy.lang.DelegatesTo(value: DetachedCriteria) groovy.lang.Closure callable)
    
    Parameters:
    callable - Callable closure containing detached criteria definition
    Returns:
    The DetachedCriteria instance
  - static DetachedCriteria<D> whereAny(@groovy.lang.DelegatesTo(value: DetachedCriteria) groovy.lang.Closure callable)
    
    Parameters:
    callable - Callable closure containing detached criteria definition
    Returns:
    The DetachedCriteria instance
  - static DetachedCriteria<D> whereLazy(@groovy.lang.DelegatesTo(value: DetachedCriteria) groovy.lang.Closure callable)
    
    Parameters:
    callable - Callable closure containing detached criteria definition
    Returns:
    The DetachedCriteria instance that is lazily initialized
  - RxGormAllOperations<D> withConnection(java.lang.String connectionName)
    
    Perform operations with the given connection
    Parameters:
    connectionName - The name of the connection
    Returns:
    The RxGormStaticOperations instance
  - <T> static T withConnection(java.lang.String connectionName, @groovy.lang.DelegatesTo(value: RxGormAllOperations) groovy.lang.Closure<T> callable)
    
    Switches to given named connection within the context of the closure. The delegate of the closure is used to resolve operations against the connection. @return
    Parameters:
    connectionName - The name of the connection
    callable - The closure
  - static rx.Observable withCriteria(@groovy.lang.DelegatesTo(value: CriteriaBuilder) groovy.lang.Closure callable)
    
    Creates a criteria builder instance
  - static rx.Observable withCriteria(java.util.Map builderArgs, @groovy.lang.DelegatesTo(value: CriteriaBuilder) groovy.lang.Closure callable)
    
    Creates a criteria builder instance

Summary:
Method

| Detail:
Method

Groovy Documentation

[Groovy] Trait RxEntity<D>

Methods Summary

Inherited Methods Summary

Method Detail

D addTo(java.lang.String associationName, java.lang.Object arg)

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

static D create()

static CriteriaBuilder<D> createCriteria()

private RxGormInstanceApi<D> currentRxGormInstanceApi()

private static RxGormStaticApi<D> currentRxGormStaticApi()

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

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

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

private rx.Observable<D> doSave(java.util.Map arguments, boolean isInsert)

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

static rx.Observable<D> find(@groovy.lang.DelegatesTo(value: DetachedCriteria) groovy.lang.Closure callable)

static rx.Observable<D> findAll()

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

static rx.Observable<D> findAll(@groovy.lang.DelegatesTo(value: DetachedCriteria) groovy.lang.Closure callable)

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

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

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

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

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

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

static rx.Observable<D> first()

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

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

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

java.io.Serializable getAssociationId(java.lang.String associationName)

static java.util.List<FinderMethod> getGormDynamicFinders()

static PersistentEntity getGormPersistentEntity()

java.io.Serializable ident()

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

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

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

boolean isDirty(java.lang.String fieldName)

boolean isDirty()

static rx.Observable<D> last()

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

static rx.Observable<D> last(java.util.Map<java.lang.String, java.lang.Object> params)

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

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

static ObservableProxy<D> proxy(java.io.Serializable id, java.util.Map args)

static ObservableProxy<D> proxy(DetachedCriteria<D> query, java.util.Map args)

D removeFrom(java.lang.String associationName, java.lang.Object arg)

rx.Observable<D> save()

rx.Observable<D> save(java.util.Map arguments)

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

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

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

static java.lang.Object staticPropertyMissing(java.lang.String property)

@java.lang.Override boolean validate(java.util.Map arguments)

@java.lang.Override boolean validate(java.util.List fields)

@java.lang.Override boolean validate()

static DetachedCriteria<D> where(@groovy.lang.DelegatesTo(value: DetachedCriteria) groovy.lang.Closure callable)

static DetachedCriteria<D> whereAny(@groovy.lang.DelegatesTo(value: DetachedCriteria) groovy.lang.Closure callable)

static DetachedCriteria<D> whereLazy(@groovy.lang.DelegatesTo(value: DetachedCriteria) groovy.lang.Closure callable)

RxGormAllOperations<D> withConnection(java.lang.String connectionName)

<T> static T withConnection(java.lang.String connectionName, @groovy.lang.DelegatesTo(value: RxGormAllOperations) groovy.lang.Closure<T> callable)

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

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