Package org.infinispan.query.backend

Interface SearchWorkCreator

  • All Known Subinterfaces:
    ExtendedSearchWorkCreator
    All Known Implementing Classes:
    DefaultSearchWorkCreator
    public interface SearchWorkCreator
    Creates collections of Work instances that should be performed by Hibernate-Search.
    Author:
    Marko Luksa

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      org.hibernate.search.backend.spi.Work createEntityWork​(Serializable id, org.hibernate.search.spi.IndexedTypeIdentifier entityType, org.hibernate.search.backend.spi.WorkType workType)
      Creates a Work instance for a given entity.
      Collection<org.hibernate.search.backend.spi.Work> createPerEntityTypeWorks​(org.hibernate.search.spi.IndexedTypeIdentifier entityType, org.hibernate.search.backend.spi.WorkType workType)
      Creates a collection of Work instances that Hibernate-Search should perform for all the entities of the given entity type.
      Collection<org.hibernate.search.backend.spi.Work> createPerEntityWorks​(Object entity, Serializable id, org.hibernate.search.backend.spi.WorkType workType)
      Creates a collection of Work instances that Hibernate-Search should perform for the given entity

    • Method Detail

      • createPerEntityTypeWorks

        Collection<org.hibernate.search.backend.spi.Work> createPerEntityTypeWorks​(org.hibernate.search.spi.IndexedTypeIdentifier entityType,
                                                                           org.hibernate.search.backend.spi.WorkType workType)
        Creates a collection of Work instances that Hibernate-Search should perform for all the entities of the given entity type.
        Parameters:
        entityType - the entity type that these Works should be created for
        workType - the type of work to be done
        Returns:
        collection of Work instances

      • createPerEntityWorks

        Collection<org.hibernate.search.backend.spi.Work> createPerEntityWorks​(Object entity,
                                                                       Serializable id,
                                                                       org.hibernate.search.backend.spi.WorkType workType)
        Creates a collection of Work instances that Hibernate-Search should perform for the given entity
        Parameters:
        entity - the entity that these Works should be created for
        id - the id of the document
        workType - the type of work to be done
        Returns:
        collection of Work instances

      • createEntityWork

        org.hibernate.search.backend.spi.Work createEntityWork​(Serializable id,
                                                       org.hibernate.search.spi.IndexedTypeIdentifier entityType,
                                                       org.hibernate.search.backend.spi.WorkType workType)
        Creates a Work instance for a given entity.
        Parameters:
        id - the id of the entity
        entityType - the entity type that the Work should be created for
        workType - the type of the Work to be done
        Returns:
        Work instance to be performed by the Hibernate Search engine