org.apache.polygene.spi.query

Interface EntityFinder

All Known Subinterfaces:

ElasticSearchFinder, ESClientIndexQueryService, ESClusterIndexQueryService, ESFilesystemIndexQueryService, RdfIndexingService, RdfQueryService, SolrQueryService

All Known Implementing Classes:

ElasticSearchFinder.Mixin, RdfQueryService.RdfEntityFinderMixin, SolrEntityIndexerMixin, SolrEntityQueryMixin

public interface EntityFinder

Entity Finder.

Method Summary

Modifier and Type	Method and Description
long	countEntities(Class<?> resultType, Predicate<Composite> whereClause, Map<String,Object> variables) Count entities matching the query criterion.
Stream<EntityReference>	findEntities(Class<?> resultType, Predicate<Composite> whereClause, List<OrderBy> orderBySegments, Integer firstResult, Integer maxResults, Map<String,Object> variables) Find entities matching the query criterion.
EntityReference	findEntity(Class<?> resultType, Predicate<Composite> whereClause, Map<String,Object> variables) Find a single entity matching the query criterion.

Method Detail

findEntities

Stream<EntityReference> findEntities(Class<?> resultType,
                                     @Optional
                                     Predicate<Composite> whereClause,
                                     @Optional
                                     List<OrderBy> orderBySegments,
                                     @Optional
                                     Integer firstResult,
                                     @Optional
                                     Integer maxResults,
                                     Map<String,Object> variables)
                              throws EntityFinderException

Find entities matching the query criterion.

Parameters:

resultType - Type that the entities must have.

whereClause - Where clause specification.

orderBySegments - Ordering

firstResult - Index of the first returned entity.

maxResults - Maximum returned entities.

variables - Query variables

Returns:

Entities matching the query criterion.

Throws:

EntityFinderException - on error

findEntity

EntityReference findEntity(Class<?> resultType,
                           @Optional
                           Predicate<Composite> whereClause,
                           Map<String,Object> variables)
                    throws EntityFinderException

Find a single entity matching the query criterion.

Parameters:

resultType - Type that the entity must have.

whereClause - Where clause specification.

variables - Query variables

Returns:

Single entity matching the query criterion.

Throws:

EntityFinderException - on error

countEntities

long countEntities(Class<?> resultType,
                   @Optional
                   Predicate<Composite> whereClause,
                   Map<String,Object> variables)
            throws EntityFinderException

Count entities matching the query criterion.

Parameters:

resultType - Type that the entities must have.

whereClause - Where clause specification.

variables - Query variables

Returns:

Count entities matching the query criterion.

Throws:

EntityFinderException - on error