IndexingOverrides (Pinot Segment Service Provider Interface 0.12.1 API)

java.lang.Object
- org.apache.pinot.segment.spi.index.IndexingOverrides

public class IndexingOverrides
extends Object

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`IndexingOverrides.Default`	Extend this class to override index creation
`static interface`	`IndexingOverrides.IndexingOverride`

Method Summary

Modifier and Type	Method	Description
`static IndexCreatorProvider`	`getIndexCreatorProvider()`	Obtain the registered index creator provider.
`static IndexReaderProvider`	`getIndexReaderProvider()`	Gets the registered {@see IndexReaderProvider} or the default if none was registered yet.
`static MutableIndexProvider`	`getMutableIndexProvider()`	Gets the registered {@see MutableIndexProvider} or the default if none was registered yet.
`static boolean`	`registerProvider(IndexingOverrides.IndexingOverride provider)`	The caller provides a decorator to wrap the default provider, which allows plugins to create a delegation chain.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - registerProvider
```
public static boolean registerProvider(IndexingOverrides.IndexingOverride provider)
```
    The caller provides a decorator to wrap the default provider, which allows plugins to create a delegation chain.
    
    Parameters:
    
    provider - indexing override
    
    Returns:
    
    true if this is the first invocation and the provider has not yet been used.
  - getIndexReaderProvider
```
public static IndexReaderProvider getIndexReaderProvider()
```
    Gets the registered {@see IndexReaderProvider} or the default if none was registered yet.
    
    Returns:
    
    an index reader provider.
  - getMutableIndexProvider
```
public static MutableIndexProvider getMutableIndexProvider()
```
    Gets the registered {@see MutableIndexProvider} or the default if none was registered yet.
    
    Returns:
    
    a mutable index reader provider.
  - getIndexCreatorProvider
```
public static IndexCreatorProvider getIndexCreatorProvider()
```
    Obtain the registered index creator provider. If the user has provided an override, then it will be used instead. If the user has not provided an override yet, then this action will prevent them from doing so.
    
    Returns:
    
    the global index provision logic.