Module org.eclipse.persistence.core
Package org.eclipse.persistence.descriptors

Class CacheIndex

java.lang.Object
org.eclipse.persistence.descriptors.CacheIndex
All Implemented Interfaces:
Serializable, Cloneable
public class CacheIndex extends Object implements Cloneable, Serializable

Purpose: Define a secondary index on the cache.

See Also:

  • Field Details

    • isUpdateable

      protected boolean isUpdateable

    • isInsertable

      protected boolean isInsertable

    • fields

      protected List<DatabaseField> fields

    • cacheSize

      protected int cacheSize
      Allows the cache size to be set.

    • cacheType

      protected Class<? extends WeakIdentityMap> cacheType
      Allows the identity map class type to be set.

  • Constructor Details

    • CacheIndex

      public CacheIndex()

    • CacheIndex

      public CacheIndex(DatabaseField[] fields)

    • CacheIndex

      public CacheIndex(String... fields)

    • CacheIndex

      public CacheIndex(List<DatabaseField> fields)

  • Method Details

    • clone

      public Object clone() throws CloneNotSupportedException
      Overrides:
      clone in class Object
      Throws:
      CloneNotSupportedException

    • isUpdateable

      public boolean isUpdateable()
      Return if the index field can be updated.

    • setIsUpdateable

      public void setIsUpdateable(boolean isUpdateable)
      Set if the index field can be updated. If updateable the object will be re-indexed on each update/refresh.

    • isInsertable

      public boolean isInsertable()
      Return if the index field can be inserted.

    • setIsInsertable

      public void setIsInsertable(boolean isInsertable)
      Set if the index field can be inserted. If insertable the object will be indexed after insert.

    • getCacheType

      public <T extends WeakIdentityMap> Class<T> getCacheType()
      ADVANCED: Return the type of the cache used for the index. This default to a weak cache, and should normally not be changed. For a weak cache, the index will remain until the object gcs from the main cache.

    • setCacheType

      public void setCacheType(Class<? extends WeakIdentityMap> cacheType)
      ADVANCED: Set the type of the cache used for the index. This default to a weak cache, and should normally not be changed. For a weak cache, the index will remain until the object gcs from the main cache.

    • getCacheSize

      public int getCacheSize()
      ADVANCED: Return the cache size. This is either the initial size, sub-cache size, or fixed size depending on the cache type.

    • setCacheSize

      public void setCacheSize(int cacheSize)
      ADVANCED: Set the cache size. This is either the initial size, sub-cache size, or fixed size depending on the cache type.

    • addField

      public void addField(DatabaseField field)

    • addFieldName

      public void addFieldName(String field)
      PUBLIC: Add the database column name to the cache index.

    • getFields

      public List<DatabaseField> getFields()

    • setFields

      public void setFields(List<DatabaseField> fields)

    • toString

      public String toString()
      Overrides:
      toString in class Object