Package org.apache.openjpa.persistence

Interface FetchPlan

All Known Subinterfaces:
JDBCFetchPlan
All Known Implementing Classes:
FetchPlanImpl, JDBCFetchPlanImpl
public interface FetchPlan
The fetch plan allows you to dynamically alter eager fetching configuration and other aspects of data loading.
Since:
0.4.1
Author:
Abe White, Pinaki Poddar

  • Field Details

  • Method Details

    • getMaxFetchDepth

      int getMaxFetchDepth()
      The maximum fetch depth when loading an object.

    • setMaxFetchDepth

      FetchPlan setMaxFetchDepth(int depth)
      The maximum fetch depth when loading an object.

    • getFetchBatchSize

      int getFetchBatchSize()
      Return the fetch batch size for large result set support. Defaults to the openjpa.FetchBatchSize setting. Note that this property will be ignored under some data stores.

    • setFetchBatchSize

      FetchPlan setFetchBatchSize(int fetchBatchSize)
      Set the fetch batch size for large result set support. Defaults to the openjpa.FetchBatchSize setting. Note that this property will be ignored under some data stores.

    • getQueryResultCacheEnabled

      boolean getQueryResultCacheEnabled()
      Return whether or not query caching is enabled. If this returns true but the datacache plugin is not installed, caching will not be enabled. If this returns false, query caching will not be used even if the datacache plugin is installed.
      Since:
      1.0.0

    • setQueryResultCacheEnabled

      FetchPlan setQueryResultCacheEnabled(boolean cache)
      Control whether or not query caching is enabled. This has no effect if the datacache plugin is not installed, or if the query cache size is set to zero.
      Since:
      1.0.0

    • getQueryResultCache

      @Deprecated boolean getQueryResultCache()
      Deprecated.
      use getQueryResultCacheEnabled() instead.

    • setQueryResultCache

      @Deprecated FetchPlan setQueryResultCache(boolean cache)
      Deprecated.
      use setQueryResultCacheEnabled(boolean) instead.

    • getFetchGroups

      Collection<String> getFetchGroups()
      Returns the names of the fetch groups that this component will use when loading objects. Defaults to the openjpa.FetchGroups setting.

    • addFetchGroup

      FetchPlan addFetchGroup(String group)
      Adds group to the set of fetch group to use when loading objects.

    • addFetchGroups

      FetchPlan addFetchGroups(String... groups)
      Adds groups to the set of fetch group names to use when loading objects.

    • addFetchGroups

      FetchPlan addFetchGroups(Collection groups)
      Adds groups to the set of fetch group names to use when loading objects.

    • removeFetchGroup

      FetchPlan removeFetchGroup(String group)
      Remove the given fetch group.

    • removeFetchGroups

      FetchPlan removeFetchGroups(String... groups)
      Removes groups from the set of fetch group names to use when loading objects.

    • removeFetchGroups

      FetchPlan removeFetchGroups(Collection groups)
      Removes groups from the set of fetch group names to use when loading objects.

    • clearFetchGroups

      FetchPlan clearFetchGroups()
      Clears the set of fetch group names to use wen loading data. After this operation is invoked, only those fields in the default fetch group (and any requested field) will be loaded when loading an object.

    • resetFetchGroups

      FetchPlan resetFetchGroups()
      Resets the set of fetch groups to the list in the global configuration.

    • getFields

      Collection<String> getFields()
      Returns the fully qualified names of the fields that this component will use when loading objects. Defaults to the empty set.

    • hasField

      boolean hasField(String field)
      Return true if the given field has been added.

    • hasField

      boolean hasField(Class cls, String field)
      Return true if the given field has been added.

    • addField

      FetchPlan addField(String field)
      Adds field to the set of fully-qualified field names to use when loading objects.

    • addField

      FetchPlan addField(Class cls, String field)
      Adds field to the set of field names to use when loading objects.

    • addFields

      FetchPlan addFields(String... fields)
      Adds fields to the set of fully-qualified field names to use when loading objects.

    • addFields

      FetchPlan addFields(Class cls, String... fields)
      Adds fields to the set of field names to use when loading objects.

    • addFields

      FetchPlan addFields(Collection fields)
      Adds fields to the set of fully-qualified field names to use when loading objects.

    • addFields

      FetchPlan addFields(Class cls, Collection fields)
      Adds fields to the set of field names to use when loading objects.

    • removeField

      FetchPlan removeField(String field)
      Remove the given fully-qualified field.

    • removeField

      FetchPlan removeField(Class cls, String field)
      Remove the given field.

    • removeFields

      FetchPlan removeFields(String... fields)
      Removes fields from the set of fully-qualified field names to use when loading objects.

    • removeFields

      FetchPlan removeFields(Class cls, String... fields)
      Removes fields from the set of field names to use when loading objects.

    • removeFields

      FetchPlan removeFields(Collection fields)
      Removes fields from the set of fully-qualified field names to use when loading objects.

    • removeFields

      FetchPlan removeFields(Class cls, Collection fields)
      Removes fields from the set of field names to use when loading objects.

    • clearFields

      FetchPlan clearFields()
      Clears the set of field names to use wen loading data. After this operation is invoked, only those fields in the configured fetch groups will be loaded when loading an object.

    • getLockTimeout

      int getLockTimeout()
      The number of milliseconds to wait for an object lock, or -1 for no limit.

    • setLockTimeout

      FetchPlan setLockTimeout(int timeout)
      The number of milliseconds to wait for an object lock, or -1 for no limit.

    • getLockScope

      jakarta.persistence.PessimisticLockScope getLockScope()
      The lock scope to use for locking loaded objects.

    • setLockScope

      FetchPlan setLockScope(jakarta.persistence.PessimisticLockScope scope)
      The lock scope to use for locking loaded objects.

    • getQueryTimeout

      int getQueryTimeout()
      The number of milliseconds to wait for a query, or -1 for no limit.

    • setQueryTimeout

      FetchPlan setQueryTimeout(int timeout)
      The number of milliseconds to wait for a query, or -1 for no limit.

    • getReadLockMode

      jakarta.persistence.LockModeType getReadLockMode()
      The lock level to use for locking loaded objects.

    • setReadLockMode

      FetchPlan setReadLockMode(jakarta.persistence.LockModeType mode)
      The lock level to use for locking loaded objects.

    • getWriteLockMode

      jakarta.persistence.LockModeType getWriteLockMode()
      The lock level to use for locking dirtied objects.

    • setWriteLockMode

      FetchPlan setWriteLockMode(jakarta.persistence.LockModeType mode)
      The lock level to use for locking dirtied objects.

    • getDelegate

      @Deprecated FetchConfiguration getDelegate()
      Deprecated.
      cast to FetchPlanImpl instead. This method pierces the published-API boundary, as does the SPI cast.

    • getExtendedPathLookup

      boolean getExtendedPathLookup()
      Affirms if extended path lookup feature is active.
      Since:
      2.0.0

    • setExtendedPathLookup

      FetchPlan setExtendedPathLookup(boolean flag)
      Sets extended path lookup feature.
      Since:
      2.0.0

    • getCacheStoreMode

      DataCacheStoreMode getCacheStoreMode()
      Gets the current storage mode for data cache.
      Since:
      2.0.0

    • setCacheStoreMode

      FetchPlan setCacheStoreMode(DataCacheStoreMode mode)
      Sets the current storage mode for data cache.
      Since:
      2.0.0

    • getCacheRetrieveMode

      DataCacheRetrieveMode getCacheRetrieveMode()
      Gets the current retrieve mode for data cache.
      Since:
      2.0.0

    • setCacheRetrieveMode

      FetchPlan setCacheRetrieveMode(DataCacheRetrieveMode mode)
      Sets the current retrieve mode for data cache.
      Since:
      2.0.0

    • setHint

      void setHint(String key, Object value)
      Set the hint for the given key to the given value.
      Parameters:
      value - the value of the hint.
      name - the name of the hint.
      Since:
      2.0.0

    • getHints

      Map<String,Object> getHints()
      Get the hints and their values currently set on this receiver.
      Returns:
      empty map if no hint has been set.

    • getHint

      Object getHint(String key)
      Get the hint value for the given key.
      Returns:
      null if the key has not been set.