IndexType (MyTISM API Documentation)

java.lang.Object
- java.lang.Enum<IndexType>
- - de.ipcon.schema.IndexType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IndexType>
```
public enum IndexType
extends java.lang.Enum<IndexType>
```
Represents database index types.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AUTO` Automatic index selection.
`BRIN` Block Range Index (BRIN).
`BRIN_FB_BTREE` BRIN index with a B-Tree fallback mechanism.
`BTREE` B-Tree index.
`CUSTOM` Custom user-defined index.
`GIN` Generalized Inverted Index (GIN).
`GIN_FB_BTREE` GIN index with a B-Tree fallback mechanism.
`GIN_TRGM_HSTORE` GIN index optimized for HSTORE columns using a global trigram cast.
`NONE` No index applied.
`TRIGRAM` Trigram index.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static java.util.SortedSet<java.lang.String>`	`allStandardValues()` Returns an unmodifiable, alphabetically sorted set of all unique standard index names.
`static java.util.Optional<IndexType>`	`from(java.lang.String value)` Resolves the IndexType corresponding to the given string representation.
`static IndexType`	`from(java.lang.String value, IndexType defaultValue)` Resolves the IndexType corresponding to the given string representation, returning the specified fallback if not found or null.
`java.lang.String`	`getValue()` Gets the string representation of the index type.
`boolean`	`isCustom()` Identifies if this is a custom user-defined index type.
`java.lang.String`	`toString()`
`static IndexType`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static IndexType[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - AUTO
```
public static final IndexType AUTO
```
    Automatic index selection.
  - NONE
```
public static final IndexType NONE
```
    No index applied.
  - BTREE
```
public static final IndexType BTREE
```
    B-Tree index.
  - TRIGRAM
```
public static final IndexType TRIGRAM
```
    Trigram index.
  - BRIN
```
public static final IndexType BRIN
```
    Block Range Index (BRIN).
  - BRIN_FB_BTREE
```
public static final IndexType BRIN_FB_BTREE
```
    BRIN index with a B-Tree fallback mechanism.
  - GIN
```
public static final IndexType GIN
```
    Generalized Inverted Index (GIN).
  - GIN_FB_BTREE
```
public static final IndexType GIN_FB_BTREE
```
    GIN index with a B-Tree fallback mechanism.
  - GIN_TRGM_HSTORE
```
public static final IndexType GIN_TRGM_HSTORE
```
    GIN index optimized for HSTORE columns using a global trigram cast. Used for multi-language searches where the entire HSTORE is cast to text for a first-pass trigram match before filtering by key.
  - CUSTOM
```
public static final IndexType CUSTOM
```
    Custom user-defined index.
- Method Detail
  - values
```
public static IndexType[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (IndexType c : IndexType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static IndexType valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getValue
```
public java.lang.String getValue()
```
    Gets the string representation of the index type.
    
    Returns:
    
    the string name of the index
  - isCustom
```
public boolean isCustom()
```
    Identifies if this is a custom user-defined index type.
    
    Returns:
    
    true if custom, false otherwise
  - from
```
public static java.util.Optional<IndexType> from(java.lang.String value)
```
    Resolves the IndexType corresponding to the given string representation.
    
    Parameters:
    
    value - the string value of the index type
    
    Returns:
    
    an Optional containing the matched IndexType, or empty if null or invalid
  - from
```
public static IndexType from(java.lang.String value,
                             IndexType defaultValue)
```
    Resolves the IndexType corresponding to the given string representation, returning the specified fallback if not found or null.
    
    Parameters:
    
    value - the string value of the index type
    
    defaultValue - the fallback IndexType to return if unresolved
    
    Returns:
    
    the matched IndexType, or the defaultValue
  - allStandardValues
```
public static java.util.SortedSet<java.lang.String> allStandardValues()
```
    Returns an unmodifiable, alphabetically sorted set of all unique standard index names.
    
    Returns:
    
    an unmodifiable sorted set of standard values
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Enum<IndexType>

Enum IndexType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

AUTO

NONE

BTREE

TRIGRAM

BRIN

BRIN_FB_BTREE

GIN

GIN_FB_BTREE

GIN_TRGM_HSTORE

CUSTOM

Method Detail

values

valueOf

getValue

isCustom

from

from

allStandardValues

toString