Package com.morpheusdata.core.synchronous

Interface MorpheusSynchronousDataQueryService<M extends MorpheusModel>

Type Parameters:
M - The MorpheusModel class type for this service to query against
All Known Subinterfaces:
MorpheusSynchronousAffinityGroupService
public interface MorpheusSynchronousDataQueryService<M extends MorpheusModel>
This interface is a standard base synchronous service so all services provide consistent finder methods. It features the ability to create dynamic queries using the DataQuery object. There are methods that can be implemented to provide both MorpheusModel related objects as well as Map objects for use in DatasetProvider use cases (dropdown and type-ahead components in UI option types). Often times this interface is used in conjunction with the MorpheusSynchronousIdentityService for providing an efficient way to sync objects via the MorpheusSynchronousIdentityService.listIdentityProjections(DataQuery) method. Another implementation also exists for asynchronous rxjava querying of the objects called the MorpheusDataQueryService. Typically, both should be implemented for use within the plugin api. It is recommended that the Asynchronous version of the service class is used where possible as it is the most efficient. An example of where this may be more useful would be in UI rendering methods which are already blocking as is.

Note: This object requires its asynchronous counterpart be implemented as it acts as a simple delegate to that service.

Since:
1.3.0
See Also:

  • Method Details

    • getDataQueryService

      MorpheusDataQueryService<M> getDataQueryService()
      Reference to the asynchronous data service MorpheusDataService implementation as this interface acts as a simple delegate blocking wrapper for it.
      Returns:
      the asynchronous data service to be used by the default method implementations in this interface.

    • count

      default Long count(DataQuery query)
      Performs a query operation based on the filters set in the DataQuery object passed and returns a simple total count of the results. This could be useful for paging.

      Note: For more information on how to query please refer to the documentation for the DataQuery class.

      Parameters:
      query - An instance of the DataQuery object used for filtering results. This should often include an account / user scope for security but does not always need to if being used for sync or multi-tenant reporting.
      Returns:
      A Long value with the total count.
      See Also:

    • get

      default M get(Long id)
      Fetches a single MorpheusModel by its Identifier (id) field. For more advanced single object fetches please refer to MorpheusDataQueryService.find(DataQuery).

      Note: This method does not factor in any sort of access/security control and should not be used in areas where this is required.

      Parameters:
      id - the database identifier to fetch an object by.
      Returns:
      a representation of a MorpheusModel depending on if the object was found or not.

    • listById

      default List<M> listById(List<Long> ids)
      Fetches a stream of MorpheusModel objects based on a collection of Identifiers (id). This is often used in conjunction with the MorpheusSynchronousIdentityService.listIdentityProjections(DataQuery) and the SyncTask for efficiently only fetching batches of objects we want to perform update operations on.

      Note: This method does not factor in any sort of access/security control and should not be used in areas where this is required.

      Parameters:
      ids - a collection of Identifiers (ids) to fetch the objects by.
      Returns:
      A List of MorpheusModel objects based on the ids passed in

    • list

      default List<M> list()
      Performs a list all operation on the database returning the results as MorpheusModel objects.
      Returns:
      an Observable stream of MorpheusModel objects based on the passed in query.

    • list

      default List<M> list(DataQuery query)
      Performs a query operation on the database returning the results as MorpheusModel objects. These queries can be scoped to an AccountIdentity or UserIdentity as well as various filters on arbitrary fields in the database.

      Note: For more information on how to query please refer to the documentation for the DataQuery class.

      Parameters:
      query - An instance of the DataQuery object used for filtering results. This should often include an account / user scope for security but does not always need to if being used for sync or multi-tenant reporting.
      Returns:
      A List of MorpheusModel objects based on the passed in query.

    • listOptions

      default List<Map> listOptions()
      Performs a list all operation on the database returning the results as Map objects typically containing keys of (name,value) for use in dropdown or type-ahead components within the UI. This would typically be paired with a DatasetProvider.
      Returns:
      an Observable stream of Map objects based on the passed in query containing name,value pairs.

    • listOptions

      default List<Map> listOptions(DataQuery query)
      Performs a query operation on the database returning the results as Map objects typically containing keys of (name,value) for use in dropdown or type-ahead components within the UI. This would typically be paired with a DatasetProvider. Queries can be scoped to an AccountIdentity or UserIdentity as well as various filters on arbitrary fields in the database.

      Note: For more information on how to query please refer to the documentation for the DataQuery class.

      Parameters:
      query - An instance of the DataQuery object used for filtering results. This should often include an account / user scope for security but does not always need to if being used for sync or multi-tenant reporting.
      Returns:
      A List of Map objects based on the passed in query containing name,value pairs.

    • find

      default M find(DataQuery query)
      Performs a query operation on the database returning the first result as a MorpheusModel object. These queries can be scoped to an AccountIdentity or UserIdentity as well as various filters on arbitrary fields in the database.

      Note: For more information on how to query please refer to the documentation for the DataQuery class.

      Parameters:
      query - An instance of the DataQuery object used for filtering results. This should often include an account / user scope for security but does not always need to if being used for sync or multi-tenant reporting.
      Returns:
      A MorpheusModel object based on the passed in query.

    • search

      default DataQueryResult search(DataQuery query)
      Performs a query operation on the database just like MorpheusDataQueryService.list(DataQuery) with a query, but the result is no longer a stream of individual MorpheusModel.

      Note: This is a reactive method and will not perform any operation until subscribed or blockingGet() is called on it.

      Note: For more information on how to query please refer to the documentation for the DataQuery class.

      Parameters:
      query - An instance of the DataQuery object used for filtering results. This should often include an account / user scope for security but does not always need to if being used for sync or multi-tenant reporting.
      Returns:
      a Single DataQueryResult representing a collection of result objects along with the metadata about the result. This could be paging data for example.