services

Type Members

1. trait AggregateService extends AnyRef

   

   Defines common data access methods for generating aggregated data based on a search query.

   Defines common data access methods for generating aggregated data based on a search query.

   The search query is given as models.Facets. The service builds analytic information over a set of documents and provides the result as models.Aggregation. Such a models.Aggregation consists of a list of models.Bucket, where each bucket is associated with a key and the number of documents that match the given search query. The trait further supports mechanisms to exclude and include specific keys.

   The trait is implemented by models.services.ESAggregateService, which uses an elasticsearch index as backend.

   Annotations

   @ImplementedBy()

2. trait DBDocumentService extends DocumentService

   

   Partial implementation of models.services.DocumentService using a relational database.

   Partial implementation of models.services.DocumentService using a relational database.

   Retrieving large documents via ES is slow. We therefore use the database to fetch documents. Further, user-generated data like tags are stored in the database as well.

3. class DBEntityService extends EntityService

   

   Implementation of models.services.EntityService using a relational database.

4. trait DocumentService extends AnyRef

   

   Defines common data access methods for retrieving and annotating documents.

   Defines common data access methods for retrieving and annotating documents.

   The trait is implemented by models.services.FinalDocumentService, which uses mixed-in composition in order to combine models.services.DBDocumentService and models.services.ESDocumentService.

   Annotations

   @ImplementedBy()

5. class ESAggregateService extends AggregateService

   

   Implementation of models.services.AggregateService using an elasticsearch index as backend.

   Implementation of models.services.AggregateService using an elasticsearch index as backend.

   See also

   See ES documentation for more information.

6. abstract class ESDocumentService extends DocumentService

   

   Partial implementation of models.services.DocumentService using an elasticsearch index as backend.

7. class ESNetworkService extends NetworkService

   

   Implementation of models.services.NetworkService using an elasticsearch index as backend.

8. class ESTimelineService extends TimelineService

   

   Implementation of models.services.TimelineService using an elasticsearch index as backend.

9. class ESTransportClient extends SearchClientService

   

   Wrapper around an ElasticSearch TransportClient node.

   Wrapper around an ElasticSearch TransportClient node.

   Annotations

   @Singleton()

10. trait EntityService extends AnyRef

    

    Defines common data access methods for retrieving and manipulating models.Entity.

    Defines common data access methods for retrieving and manipulating models.Entity.

    The trait is implemented by models.services.DBDocumentService.

    Annotations

    @ImplementedBy()

11. class FinalDocumentService extends ESDocumentService with DBDocumentService

    

    Combines the elasticsearch and relational database implementations via mixed-in composition.

12. trait NetworkService extends AnyRef

    

    Defines common method for creating and extending co-occurrence networks given a search query.

    Defines common method for creating and extending co-occurrence networks given a search query.

    The trait is implemented by models.services.ESNetworkService.

    Annotations

    @ImplementedBy()

13. trait SearchClientService extends AnyRef

    

    Wrapper around an ElasticSearch Client.

    Wrapper around an ElasticSearch Client. Different ways of obtaining a Client can be implemented in classes implementing this interface.

    Annotations

    @ImplementedBy()

14. trait TimelineService extends AnyRef

    

    Defines common methods for creating timeline instances based on document creation dates and time expressions matching a search query.

    Defines common methods for creating timeline instances based on document creation dates and time expressions matching a search query.

    The trait is implemented by models.services.ESTimelineService.

    Annotations

    @ImplementedBy()