Package org.hibernate.search.mapper.pojo.standalone.work

Interface SearchIndexingPlan

@Incubating public interface SearchIndexingPlan
An interface for indexing entities in the context of a session.

This class is stateful: it queues operations internally to apply them when the session is closed.

This contract is not thread-safe.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(Class<?> entityClass, Object providedId, DocumentRoutesDescriptor providedRoutes)
    Add an entity to the index, assuming that the entity is absent from the index.
    void
    add(Object entity)
    Add an entity to the index, assuming that the entity is absent from the index.
    void
    add(Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity)
    Add an entity to the index, assuming that the entity is absent from the index.
    void
    addOrUpdate(Class<?> entityClass, Object providedId, DocumentRoutesDescriptor providedRoutes)
    Update an entity in the index, or add it if it's absent from the index.
    void
    addOrUpdate(Object entity)
    Update an entity in the index, or add it if it's absent from the index.
    void
    addOrUpdate(Object entity, String... dirtyPaths)
    Consider an entity updated, and perform reindexing of this entity as well as containing entities as necessary.
    void
    addOrUpdate(Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity)
    Update an entity in the index, or add it if it's absent from the index.
    void
    addOrUpdate(Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity, boolean forceSelfDirty, boolean forceContainingDirty, String... dirtyPaths)
    Consider an entity updated, and perform reindexing of this entity as well as containing entities as necessary, taking into account dirtyPaths, forceSelfDirty and forceContainingDirty.
    void
    addOrUpdate(Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity, String... dirtyPaths)
    Consider an entity updated, and perform reindexing of this entity as well as containing entities as necessary, taking into account dirtyPaths.
    void
    addOrUpdateOrDelete(Class<?> entityClass, Object providedId, DocumentRoutesDescriptor providedRoutes, boolean forceSelfDirty, boolean forceContainingDirty, String... dirtyPaths)
    Consider an entity added, updated, or deleted, depending on the result of loading it by ID, and perform reindexing of this entity as well as containing entities as necessary, taking into account dirtyPaths, forceSelfDirty and forceContainingDirty.
    void
    delete(Object entity)
    Delete an entity from the index.
    void
    delete(Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity)
    Delete an entity from the index.
    void
    purge(Class<?> entityClass, Object providedId, DocumentRoutesDescriptor providedRoutes)
    Delete the entity from the index.

  • Method Details

    • add

      void add(Object entity)
      Add an entity to the index, assuming that the entity is absent from the index.

      Shorthand for add(null, null, entity); see add(Object, DocumentRoutesDescriptor, Object).

      Parameters:
      entity - The entity to add to the index.

    • add

      void add(Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity)
      Add an entity to the index, assuming that the entity is absent from the index.

      Note: depending on the backend, this may lead to errors or duplicate entries in the index if the entity was actually already present in the index before this call. When in doubt, you should rather use addOrUpdate(Object, DocumentRoutesDescriptor, Object) or addOrUpdate(Object).

      Parameters:
      providedId - A value to extract the document ID from. Generally the expected value is the entity ID, but a different value may be expected depending on the mapping. If null, Hibernate Search will attempt to extract the ID from the entity.
      providedRoutes - The route to the current index shard. Only required if custom routing is enabled and the RoutingBridge is missing or unable to provide all the correct previous routes. If a RoutingBridge is assigned to the entity type, the routes will be computed using that bridge instead, and provided routes will be ignored.
      entity - The entity to add to the index.

    • add

      void add(Class<?> entityClass, Object providedId, DocumentRoutesDescriptor providedRoutes)
      Add an entity to the index, assuming that the entity is absent from the index.

      Note: depending on the backend, this may lead to errors or duplicate entries in the index if the entity was actually already present in the index before this call. When in doubt, you should rather use addOrUpdate(Object, DocumentRoutesDescriptor, Object) or addOrUpdate(Object).

      Parameters:
      entityClass - The class of the entity to add to the index.
      providedId - A value to extract the document ID from. Generally the expected value is the entity ID, but a different value may be expected depending on the mapping.
      providedRoutes - The route to the current index shard. Only required if custom routing is enabled and the RoutingBridge is missing. If a RoutingBridge is assigned to the entity type, the routes will be computed using that bridge instead, and provided routes (current and previous) will all be appended to the generated "previous routes".

    • addOrUpdate

      void addOrUpdate(Object entity)
      Update an entity in the index, or add it if it's absent from the index.

      Shorthand for addOrUpdate(null, null, entity); see addOrUpdate(Object, DocumentRoutesDescriptor, Object).

      Parameters:
      entity - The entity to update in the index.

    • addOrUpdate

      void addOrUpdate(Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity)
      Update an entity in the index, or add it if it's absent from the index.
      Parameters:
      providedId - A value to extract the document ID from. Generally the expected value is the entity ID, but a different value may be expected depending on the mapping. If null, Hibernate Search will attempt to extract the ID from the entity.
      providedRoutes - The routes to the current and previous index shards. Only required if custom routing is enabled and the RoutingBridge is missing or unable to provide all the correct previous routes. If a RoutingBridge is assigned to the entity type, the routes will be computed using that bridge instead, and provided routes (current and previous) will all be appended to the generated "previous routes".
      entity - The entity to update in the index.

    • addOrUpdate

      void addOrUpdate(Class<?> entityClass, Object providedId, DocumentRoutesDescriptor providedRoutes)
      Update an entity in the index, or add it if it's absent from the index.
      Parameters:
      entityClass - The class of the entity to update in the index.
      providedId - A value to extract the document ID from. Generally the expected value is the entity ID, but a different value may be expected depending on the mapping.
      providedRoutes - The routes to the current and previous index shards. Only required if custom routing is enabled and the RoutingBridge is missing or unable to provide all the correct previous routes. If a RoutingBridge is assigned to the entity type, the routes will be computed using that bridge instead, and provided routes (current and previous) will all be appended to the generated "previous routes".

    • addOrUpdate

      void addOrUpdate(Object entity, String... dirtyPaths)
      Consider an entity updated, and perform reindexing of this entity as well as containing entities as necessary.

      Assumes that the entity may already be present in the index.

      Shorthand for addOrUpdate(null, null, entity, false, false, dirtyPaths); see addOrUpdate(Object, DocumentRoutesDescriptor, Object, boolean, boolean, String...).

      Parameters:
      entity - The entity to update in the index.
      dirtyPaths - The paths to consider dirty, formatted using the dot-notation ("directEntityProperty.nestedPropery").

    • addOrUpdate

      void addOrUpdate(Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity, String... dirtyPaths)
      Consider an entity updated, and perform reindexing of this entity as well as containing entities as necessary, taking into account dirtyPaths.

      Assumes that the entity may already be present in the index.

      Shorthand for addOrUpdate(providedId, providedRoutes, entity, false, false, dirtyPaths); see addOrUpdate(Object, DocumentRoutesDescriptor, Object, boolean, boolean, String...).

      Parameters:
      providedId - A value to extract the document ID from. Generally the expected value is the entity ID, but a different value may be expected depending on the mapping. If null, Hibernate Search will attempt to extract the ID from the entity.
      providedRoutes - The routes to the current and previous index shards. Only required if custom routing is enabled and the RoutingBridge is missing or unable to provide all the correct previous routes. If a RoutingBridge is assigned to the entity type, the routes will be computed using that bridge instead, and provided routes (current and previous) will all be appended to the generated "previous routes".
      entity - The entity to update in the index.
      dirtyPaths - The paths to consider dirty, formatted using the dot-notation

    • addOrUpdate

      void addOrUpdate(Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity, boolean forceSelfDirty, boolean forceContainingDirty, String... dirtyPaths)
      Consider an entity updated, and perform reindexing of this entity as well as containing entities as necessary, taking into account dirtyPaths, forceSelfDirty and forceContainingDirty.

      Assumes that the entity may already be present in the index.

      Parameters:
      providedId - A value to extract the document ID from. Generally the expected value is the entity ID, but a different value may be expected depending on the mapping. If null, Hibernate Search will attempt to extract the ID from the entity.
      providedRoutes - The routes to the current and previous index shards. Only required if custom routing is enabled and the RoutingBridge is missing or unable to provide all the correct previous routes. If a RoutingBridge is assigned to the entity type, the routes will be computed using that bridge instead, and provided routes (current and previous) will all be appended to the generated "previous routes".
      entity - The entity to update in the index.
      forceSelfDirty - If true, forces reindexing of this entity regardless of the dirty paths.
      forceContainingDirty - If true, forces the resolution of containing entities as dirty regardless of the dirty paths.
      dirtyPaths - The paths to consider dirty, formatted using the dot-notation

    • delete

      void delete(Object entity)
      Delete an entity from the index.

      Shorthand for delete(null, null, entity); see delete(Object, DocumentRoutesDescriptor, Object).

      Parameters:
      entity - The entity to delete from the index.

    • delete

      void delete(Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity)
      Delete an entity from the index.

      No effect on the index if the entity is not in the index.

      Parameters:
      providedId - A value to extract the document ID from. Generally the expected value is the entity ID, but a different value may be expected depending on the mapping. If null, Hibernate Search will attempt to extract the ID from the entity.
      providedRoutes - The routes to the current and previous index shards. Only required if custom routing is enabled and entity is null, or the RoutingBridge is missing or unable to provide all the correct previous routes. If a RoutingBridge is assigned to the entity type, and entity is non-null, the routes will be computed using that bridge instead, and provided routes (current and previous) will all be appended to the generated "previous routes".
      entity - The entity to delete from the index.

    • purge

      void purge(Class<?> entityClass, Object providedId, DocumentRoutesDescriptor providedRoutes)
      Delete the entity from the index.

      No effect on the index if the entity is not in the index.

      On contrary to delete(Object), if documents embed this entity (through IndexedEmbedded for example), these documents will not be re-indexed, leaving the indexes in an inconsistent state until they are re-indexed manually.

      Parameters:
      entityClass - The class of the entity to delete from the index.
      providedId - A value to extract the document ID from. Generally the expected value is the entity ID, but a different value may be expected depending on the mapping.
      providedRoutes - The routes to the current and previous index shards. Only required if custom routing is enabled.
      Throws:
      SearchException - If the entity type is not indexed directly (Indexed).

    • addOrUpdateOrDelete

      void addOrUpdateOrDelete(Class<?> entityClass, Object providedId, DocumentRoutesDescriptor providedRoutes, boolean forceSelfDirty, boolean forceContainingDirty, String... dirtyPaths)
      Consider an entity added, updated, or deleted, depending on the result of loading it by ID, and perform reindexing of this entity as well as containing entities as necessary, taking into account dirtyPaths, forceSelfDirty and forceContainingDirty.
      Parameters:
      entityClass - The class of the entity to add, update or delete from the index.
      providedId - A value to extract the document ID from. Generally the expected value is the entity ID, but a different value may be expected depending on the mapping.
      providedRoutes - The routes to the current and previous index shards. Only required if custom routing is enabled and the RoutingBridge is missing or unable to provide all the correct previous routes. If a RoutingBridge is assigned to the entity type, the routes will be computed using that bridge instead, and provided routes (current and previous) will all be appended to the generated "previous routes".
      forceSelfDirty - If true, forces reindexing of this entity regardless of the dirty paths.
      forceContainingDirty - If true, forces the resolution of containing entities as dirty.
      dirtyPaths - The paths to consider dirty, formatted using the dot-notation