IndexCreationContext (Pinot Segment Service Provider Interface 0.12.1 API)

All Known Implementing Classes:

IndexCreationContext.BloomFilter, IndexCreationContext.Common, IndexCreationContext.Forward, IndexCreationContext.Geospatial, IndexCreationContext.Inverted, IndexCreationContext.Json, IndexCreationContext.Range, IndexCreationContext.Text, IndexCreationContext.Wrapper
```
public interface IndexCreationContext
```
Provides parameters for constructing indexes via {@see IndexCreatorProvider}. The responsibility for ensuring that the correct parameters for a particular index type lies with the caller.

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static class`	`IndexCreationContext.BloomFilter`
`static class`	`IndexCreationContext.Builder`
`static class`	`IndexCreationContext.Common`
`static class`	`IndexCreationContext.Forward`
`static class`	`IndexCreationContext.Geospatial`
`static class`	`IndexCreationContext.Inverted`
`static class`	`IndexCreationContext.Json`
`static class`	`IndexCreationContext.Range`
`static class`	`IndexCreationContext.Text`
`static class`	`IndexCreationContext.Wrapper`

Method Summary

Modifier and Type	Method	Description
`static IndexCreationContext.Builder`	`builder()`
`boolean`	`forwardIndexDisabled()`
`int`	`getCardinality()`
`FieldSpec`	`getFieldSpec()`
`File`	`getIndexDir()`
`int`	`getLengthOfLongestEntry()`
`int`	`getMaxNumberOfMultiValueElements()`
`int`	`getMaxRowLengthInBytes()`
`Comparable<?>`	`getMaxValue()`
`Comparable<?>`	`getMinValue()`
`int`	`getTotalDocs()`
`int`	`getTotalNumberOfEntries()`
`boolean`	`hasDictionary()`
`boolean`	`isOnHeap()`
`boolean`	`isSorted()`

Method Detail

getFieldSpec
```
FieldSpec getFieldSpec()
```

getIndexDir
```
File getIndexDir()
```

isOnHeap
```
boolean isOnHeap()
```

getLengthOfLongestEntry
```
int getLengthOfLongestEntry()
```

getMaxNumberOfMultiValueElements
```
int getMaxNumberOfMultiValueElements()
```

getMaxRowLengthInBytes
```
int getMaxRowLengthInBytes()
```

isSorted
```
boolean isSorted()
```

getCardinality
```
int getCardinality()
```

getTotalNumberOfEntries
```
int getTotalNumberOfEntries()
```

getTotalDocs
```
int getTotalDocs()
```

hasDictionary
```
boolean hasDictionary()
```

getMinValue
```
Comparable<?> getMinValue()
```

getMaxValue
```
Comparable<?> getMaxValue()
```

forwardIndexDisabled
```
boolean forwardIndexDisabled()
```

builder

static IndexCreationContext.Builder builder()