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

Interface PojoTypeIndexingPlan

public interface PojoTypeIndexingPlan

  • Method Summary

    Modifier and Type
    Method
    Description
    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(Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity, boolean forceSelfDirty, boolean forceContainingDirty, BitSet 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
    addOrUpdateOrDelete(Object providedId, DocumentRoutesDescriptor providedRoutes, boolean forceSelfDirty, boolean forceContainingDirty, BitSet 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 providedId, DocumentRoutesDescriptor providedRoutes, Object entity)
    Delete an entity from the index.
    void
    updateAssociationInverseSide(BitSet dirtyAssociationPaths, Object[] oldState, Object[] newState)
    Consider an association updated with the given entities removed, and perform reindexing of the relevant entities on the inverse side of that association as necessary.

  • Method Details

    • 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, boolean, boolean, BitSet).

      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. 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.

    • addOrUpdate

      void addOrUpdate(Object providedId, DocumentRoutesDescriptor providedRoutes, Object entity, boolean forceSelfDirty, boolean forceContainingDirty, BitSet 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.
      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, as a BitSet. You can build such a BitSet by obtaining the dirty filter for the entity type and calling one of the filter methods.

    • delete

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

      Entities to reindex as a result of this operation will not be resolved.

      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 the provided ID is null, Hibernate Search will attempt to extract the ID from the entity (which must be non-null in that case).
      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. May be null if providedId is non-null.
      Throws:
      IllegalArgumentException - If both providedId and entity are null.

    • addOrUpdateOrDelete

      void addOrUpdateOrDelete(Object providedId, DocumentRoutesDescriptor providedRoutes, boolean forceSelfDirty, boolean forceContainingDirty, BitSet 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:
      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, as a BitSet. You can build such a BitSet by obtaining the dirty filter for the entity type and calling one of the filter methods.

    • updateAssociationInverseSide

      void updateAssociationInverseSide(BitSet dirtyAssociationPaths, Object[] oldState, Object[] newState)
      Consider an association updated with the given entities removed, and perform reindexing of the relevant entities on the inverse side of that association as necessary.

      This is mostly useful for cases where callers do not receive update events for associations on both sides, to have Hibernate Search act "as if" the inverse side of the association had been updated.

      WARNING: Getters returning the current state of the association on the removed entities are still expected to return the updated state of the association (for example through lazy-loading). Failing that, reindexing will index out-of-date information.

      Parameters:
      dirtyAssociationPaths - The association paths to consider dirty, as a BitSet. You can build such a BitSet by obtaining the dirty association filter for the entity type and calling one of the filter methods.
      oldState - The old state of the entity whose associations are dirty. May be null, in which case this state will not yield any reindexing.
      newState - The new state of the entity whose associations are dirty. May be null, in which case this state will not yield any reindexing.