Class IndexConfig<T>

java.lang.Object
com.tangosol.io.AbstractEvolvable
com.oracle.coherence.rag.config.AbstractConfig<T>
com.oracle.coherence.rag.config.index.IndexConfig<T>
Type Parameters:
T - the type of target object this configuration is for
All Implemented Interfaces:
Evolvable, PortableObject
Direct Known Subclasses:
BinaryQuantIndexConfig, HnswIndexConfig, SimpleIndexConfig
public class IndexConfig<T> extends AbstractConfig<T> implements PortableObject
Configuration class for document indexing settings.

This class encapsulates configuration parameters that control how document chunks are indexed in the Coherence RAG framework. The index type determines the specific indexing strategy and algorithm used for document storage and retrieval.

This class is designed to be serializable using Coherence POF (Portable Object Format) and JSON-B for configuration persistence and transmission.

Since:
25.09
Author:
Aleks Seovic 2025.06.28

  • Field Details

    • TYPE

      public static final String TYPE
      The type of the index this configuration is for.
      See Also:

    • IMPLEMENTATION_VERSION

      public static final int IMPLEMENTATION_VERSION
      The implementation version for this class.
      See Also:

  • Constructor Details

    • IndexConfig

      public IndexConfig()

  • Method Details

    • type

      public String type()
      Returns the type of the index this configuration is for.
      Returns:
      the type of the index this configuration is for

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getImplVersion

      public int getImplVersion()
      Description copied from class: AbstractEvolvable
      Determine the serialization version supported by the implementing class.
      Specified by:
      getImplVersion in interface Evolvable
      Overrides:
      getImplVersion in class AbstractConfig<T>
      Returns:
      the serialization version supported by this object

    • readExternal

      public void readExternal(PofReader reader) throws IOException
      Description copied from interface: PortableObject
      Restore the contents of a user type instance by reading its state using the specified PofReader object.
      Specified by:
      readExternal in interface PortableObject
      Parameters:
      reader - the PofReader from which to read the object's state
      Throws:
      IOException - if an I/O error occurs

    • writeExternal

      public void writeExternal(PofWriter writer) throws IOException
      Description copied from interface: PortableObject
      Save the contents of a POF user type instance by writing its state using the specified PofWriter object.
      Specified by:
      writeExternal in interface PortableObject
      Parameters:
      writer - the PofWriter to which to write the object's state
      Throws:
      IOException - if an I/O error occurs