DimensionIndexer (druid-processing 0.9.2 API)

Type Parameters:

EncodedType - class of the encoded values

ActualType - class of the actual values

All Known Implementing Classes:

StringDimensionIndexer
```
public interface DimensionIndexer<EncodedType extends Comparable<EncodedType>,EncodedTypeArray,ActualType extends Comparable<ActualType>>
```
Processing related interface A DimensionIndexer is a per-dimension stateful object that encapsulates type-specific operations and data structures used during the in-memory ingestion process (i.e., work done by IncrementalIndex). Ingested row values are passed to a DimensionIndexer, which will update its internal data structures such as a value->ID dictionary as row values are seen. The DimensionIndexer is also responsible for implementing various value lookup operations, such as conversion between an encoded value and its full representation. It maintains knowledge of the mappings between encoded values and actual values. Sorting and Ordering -------------------- When encoding is present, there are two relevant orderings for the encoded values. 1.) Ordering based on encoded value's order of ingestion 2.) Ordering based on converted actual value Suppose we have a new String dimension DimA, which sees the values "Hello", "World", and "Apple", in that order. This would correspond to dictionary encodings of "Hello"=0, "World"=1, and "Apple"=2, by the order in which these values were first seen during ingestion. However, some use cases require the encodings to be sorted by their associated actual values. In this example, that ordering would be "Apple"=0, "Hello"=1, "World"=2. The first ordering will be referred to as "Unsorted" in the documentation for this interface, and the second ordering will be referred to as "Sorted". The unsorted ordering is used during ingestion, within the IncrementalIndex's TimeAndDims keys; the encodings are built as rows are ingested, taking the order in which new dimension values are seen. The generation of a sorted encoding takes place during segment creation when indexes are merged/persisted. The sorted ordering will be used for dimension value arrays in that context and when reading from persisted segments. Note that after calling the methods below that deal with sorted encodings, - getSortedEncodedValueFromUnsorted() - getUnsortedEncodedValueFromSorted() - getSortedIndexedValues() - convertUnsortedEncodedArrayToSortedEncodedArray() calling processRowValsToUnsortedEncodedArray() afterwards can invalidate previously read sorted encoding values (i.e., new values could be added that are inserted between existing values in the ordering). Thread Safety -------------------- Each DimensionIndexer exists within the context of a single IncrementalIndex. Before IndexMerger.persist() is called on an IncrementalIndex, any associated DimensionIndexers should allow multiple threads to add data to the indexer via processRowValsToUnsortedEncodedArray() and allow multiple threads to read data via methods that only deal with unsorted encodings. As mentioned in the "Sorting and Ordering" section, writes and calls to the sorted encoding methods should not be interleaved: the sorted encoding methods should only be called when it is known that writes to the indexer will no longer occur. The implementations of methods dealing with sorted encodings are free to assume that they will be called by only one thread. The sorted encoding methods are not currently used outside of index merging/persisting (single-threaded context, and no new events will be added to the indexer). If an indexer is passed to a thread that will use the sorted encoding methods, the caller is responsible for ensuring that previous writes to the indexer are visible to the thread that uses the sorted encoding space. For example, in the RealtimePlumber and IndexGeneratorJob, the thread that performs index persist is started by the same thread that handles the row adds on an index, ensuring the adds are visible to the persist thread.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`checkUnsortedEncodedArraysEqual(EncodedTypeArray lhs, EncodedTypeArray rhs)` Check if two row value arrays from TimeAndDims keys are equal.
`int`	`compareUnsortedEncodedArrays(EncodedTypeArray lhs, EncodedTypeArray rhs)` Compares the row values for this DimensionIndexer's dimension from a TimeAndDims key.
`Object`	`convertUnsortedEncodedArrayToActualArrayOrList(EncodedTypeArray key, boolean asList)` Given a row value array from a TimeAndDims key, as described in the documentatiion for compareUnsortedEncodedArrays(), convert the unsorted encoded values to a list or array of actual values.
`EncodedTypeArray`	`convertUnsortedEncodedArrayToSortedEncodedArray(EncodedTypeArray key)` Given a row value array from a TimeAndDims key, as described in the documentatiion for compareUnsortedEncodedArrays(), convert the unsorted encoded values to an array of sorted encoded values (i.e., sorted by their corresponding actual values)
`void`	`fillBitmapsFromUnsortedEncodedArray(EncodedTypeArray key, int rowNum, com.metamx.collections.bitmap.MutableBitmap[] bitmapIndexes, com.metamx.collections.bitmap.BitmapFactory factory)` Helper function for building bitmap indexes for integer-encoded dimensions.
`int`	`getCardinality()` Get the cardinality of this dimension's values.
`ActualType`	`getMaxValue()` Get the maximum dimension value seen by this indexer.
`ActualType`	`getMinValue()` Get the minimum dimension value seen by this indexer.
`EncodedType`	`getSortedEncodedValueFromUnsorted(EncodedType unsortedIntermediateValue)` Given an encoded value that was ordered by time of ingestion, return the equivalent encoded value ordered by associated actual value.
`Indexed<ActualType>`	`getSortedIndexedValues()` Returns an indexed structure of this dimension's sorted actual values.
`int`	`getUnsortedEncodedArrayHashCode(EncodedTypeArray key)` Given a row value array from a TimeAndDims key, generate a hashcode.
`EncodedType`	`getUnsortedEncodedValueFromSorted(EncodedType sortedIntermediateValue)` Given an encoded value that was ordered by associated actual value, return the equivalent encoded value ordered by time of ingestion.
`Object`	`makeColumnValueSelector(DimensionSpec spec, IncrementalIndexStorageAdapter.EntryHolder currEntry, IncrementalIndex.DimensionDesc desc)` Return an object used to read rows from a StorageAdapter's Cursor.
`ValueMatcher`	`makeIndexingValueMatcher(Comparable matchValue, IncrementalIndexStorageAdapter.EntryHolder holder, int dimIndex)` Return a ValueMatcher that accepts an EntryHolder containing the current TimeAndDims key and the array index of this indexer's dimension within the TimeAndDims key.
`ValueMatcher`	`makeIndexingValueMatcher(DruidPredicateFactory predicateFactory, IncrementalIndexStorageAdapter.EntryHolder holder, int dimIndex)` Return a ValueMatcher that accepts an EntryHolder containing the current TimeAndDims key and the array index of this indexer's dimension within the TimeAndDims key.
`EncodedTypeArray`	`processRowValsToUnsortedEncodedArray(Object dimValues)` Given a single row value or list of row values (for multi-valued dimensions), update any internal data structures with the ingested values and return the row values as an array to be used within a TimeAndDims key.

- Method Detail
  - processRowValsToUnsortedEncodedArray
```
EncodedTypeArray processRowValsToUnsortedEncodedArray(Object dimValues)
```
    Given a single row value or list of row values (for multi-valued dimensions), update any internal data structures with the ingested values and return the row values as an array to be used within a TimeAndDims key. For example, the dictionary-encoded String-type column will return an int[] containing a dictionary ID. The value within the returned array should be encoded if applicable, i.e. as instances of EncodedType. NOTE: This function can change the internal state of the DimensionIndexer.
    
    Parameters:
    
    dimValues - Single row val to process
    
    Returns:
    
    An array containing an encoded representation of the input row value.
  - getSortedEncodedValueFromUnsorted
```
EncodedType getSortedEncodedValueFromUnsorted(EncodedType unsortedIntermediateValue)
```
    Given an encoded value that was ordered by time of ingestion, return the equivalent encoded value ordered by associated actual value. Using the example in the class description: getSortedEncodedValueFromUnsorted(0) would return 2
    
    Parameters:
    
    unsortedIntermediateValue - value to convert
    
    Returns:
    
    converted value
  - getUnsortedEncodedValueFromSorted
```
EncodedType getUnsortedEncodedValueFromSorted(EncodedType sortedIntermediateValue)
```
    Given an encoded value that was ordered by associated actual value, return the equivalent encoded value ordered by time of ingestion. Using the example in the class description: getUnsortedEncodedValueFromSorted(2) would return 0
    
    Parameters:
    
    sortedIntermediateValue - value to convert
    
    Returns:
    
    converted value
  - getSortedIndexedValues
```
Indexed<ActualType> getSortedIndexedValues()
```
    Returns an indexed structure of this dimension's sorted actual values. The integer IDs represent the ordering of the sorted values. Using the example in the class description: "Apple"=0, "Hello"=1, "World"=2
    
    Returns:
    
    Sorted index of actual values
  - getMinValue
```
ActualType getMinValue()
```
    Get the minimum dimension value seen by this indexer. NOTE: On an in-memory segment (IncrementaIndex), we can determine min/max values by looking at the stream of row values seen in calls to processSingleRowValToIndexKey(). However, on a disk-backed segment (QueryableIndex), the numeric dimensions do not currently have any supporting index structures that can be used to efficiently determine min/max values. When numeric dimension support is added, the segment format should be changed to store min/max values, to avoid performing a full-column scan to determine these values for numeric dims.
    
    Returns:
    
    min value
  - getMaxValue
```
ActualType getMaxValue()
```
    Get the maximum dimension value seen by this indexer.
    
    Returns:
    
    max value
  - getCardinality
```
int getCardinality()
```
    Get the cardinality of this dimension's values.
    
    Returns:
    
    value cardinality
  - makeColumnValueSelector
```
Object makeColumnValueSelector(DimensionSpec spec,
                               IncrementalIndexStorageAdapter.EntryHolder currEntry,
                               IncrementalIndex.DimensionDesc desc)
```
    Return an object used to read rows from a StorageAdapter's Cursor. e.g. String -> DimensionSelector Long -> LongColumnSelector Float -> FloatColumnSelector See StringDimensionIndexer.makeColumnValueSelector() for a reference implementation.
    
    Parameters:
    
    spec - Specifies the output name of a dimension and any extraction functions to be applied.
    
    currEntry - Provides access to the current TimeAndDims object in the Cursor
    
    desc - Descriptor object for this dimension within an IncrementalIndex
    
    Returns:
    
    A new object that reads rows from currEntry
  - compareUnsortedEncodedArrays
```
int compareUnsortedEncodedArrays(EncodedTypeArray lhs,
                                 EncodedTypeArray rhs)
```
    Compares the row values for this DimensionIndexer's dimension from a TimeAndDims key. The dimension value arrays within a TimeAndDims key always use the "unsorted" ordering for encoded values. The row values are passed to this function as an Object, the implementer should cast them to the type appropriate for this dimension. For example, a dictionary encoded String implementation would cast the Objects as int[] arrays. When comparing, if the two arrays have different lengths, the shorter array should be ordered first. Otherwise, the implementer of this function should iterate through the unsorted encoded values, converting them to their actual type (e.g., performing a dictionary lookup for a dict-encoded String dimension), and comparing the actual values until a difference is found. Refer to StringDimensionIndexer.compareUnsortedEncodedArrays() for a reference implementation.
    
    Parameters:
    
    lhs - dimension value array from a TimeAndDims key
    
    rhs - dimension value array from a TimeAndDims key
    
    Returns:
    
    comparison of the two arrays
  - checkUnsortedEncodedArraysEqual
```
boolean checkUnsortedEncodedArraysEqual(EncodedTypeArray lhs,
                                        EncodedTypeArray rhs)
```
    Check if two row value arrays from TimeAndDims keys are equal.
    
    Parameters:
    
    lhs - dimension value array from a TimeAndDims key
    
    rhs - dimension value array from a TimeAndDims key
    
    Returns:
    
    true if the two arrays are equal
  - getUnsortedEncodedArrayHashCode
```
int getUnsortedEncodedArrayHashCode(EncodedTypeArray key)
```
    Given a row value array from a TimeAndDims key, generate a hashcode.
    
    Parameters:
    
    key - dimension value array from a TimeAndDims key
    
    Returns:
    
    hashcode of the array
  - convertUnsortedEncodedArrayToActualArrayOrList
```
Object convertUnsortedEncodedArrayToActualArrayOrList(EncodedTypeArray key,
                                                      boolean asList)
```
    Given a row value array from a TimeAndDims key, as described in the documentatiion for compareUnsortedEncodedArrays(), convert the unsorted encoded values to a list or array of actual values. If the key has one element, this method should return a single Object instead of an array or list, ignoring the asList parameter.
    
    Parameters:
    
    key - dimension value array from a TimeAndDims key
    
    asList - if true, return an array; if false, return a list
    
    Returns:
    
    single value, array, or list containing the actual values corresponding to the encoded values in the input array
  - convertUnsortedEncodedArrayToSortedEncodedArray
```
EncodedTypeArray convertUnsortedEncodedArrayToSortedEncodedArray(EncodedTypeArray key)
```
    Given a row value array from a TimeAndDims key, as described in the documentatiion for compareUnsortedEncodedArrays(), convert the unsorted encoded values to an array of sorted encoded values (i.e., sorted by their corresponding actual values)
    
    Parameters:
    
    key - dimension value array from a TimeAndDims key
    
    Returns:
    
    array containing the sorted encoded values corresponding to the unsorted encoded values in the input array
  - fillBitmapsFromUnsortedEncodedArray
```
void fillBitmapsFromUnsortedEncodedArray(EncodedTypeArray key,
                                         int rowNum,
                                         com.metamx.collections.bitmap.MutableBitmap[] bitmapIndexes,
                                         com.metamx.collections.bitmap.BitmapFactory factory)
```
    Helper function for building bitmap indexes for integer-encoded dimensions. Called by IncrementalIndexAdapter as it iterates through its sequence of rows. Given a row value array from a TimeAndDims key, with the current row number indicated by "rowNum", set the index for "rowNum" in the bitmap index for each value that appears in the row value array. For example, if key is an int[] array with values [1,3,4] for a dictionary-encoded String dimension, and rowNum is 27, this function would set bit 27 in bitmapIndexes[1], bitmapIndexes[3], and bitmapIndexes[4] See StringDimensionIndexer.fillBitmapsFromUnsortedEncodedArray() for a reference implementation. If a dimension type does not support bitmap indexes, this function will not be called and can be left unimplemented.
    
    Parameters:
    
    key - dimension value array from a TimeAndDims key
    
    rowNum - current row number
    
    bitmapIndexes - array of bitmaps, indexed by integer dimension value
    
    factory - bitmap factory
  - makeIndexingValueMatcher
```
ValueMatcher makeIndexingValueMatcher(Comparable matchValue,
                                      IncrementalIndexStorageAdapter.EntryHolder holder,
                                      int dimIndex)
```
    Return a ValueMatcher that accepts an EntryHolder containing the current TimeAndDims key and the array index of this indexer's dimension within the TimeAndDims key. The implementer should read the dimension array Object from the TimeAndDims key and cast it to the appropriate type, as described in the documentation for compareUnsortedEncodedArrays(). The returned ValueMatcher should match the dimension values against matchValue. See StringDimensionIndexer for a reference implementation.
    
    Parameters:
    
    matchValue - value to match on
    
    holder - holds the current TimeAndDims key during row iteration
    
    dimIndex - the array index of this indexer's dimension within the TimeAndDims key
    
    Returns:
    
    A ValueMatcher that matches a dimension value array from a TimeAndDims key against "matchValue"
  - makeIndexingValueMatcher
```
ValueMatcher makeIndexingValueMatcher(DruidPredicateFactory predicateFactory,
                                      IncrementalIndexStorageAdapter.EntryHolder holder,
                                      int dimIndex)
```
    Return a ValueMatcher that accepts an EntryHolder containing the current TimeAndDims key and the array index of this indexer's dimension within the TimeAndDims key. The implementer should read the dimension array Object from the TimeAndDims key and cast it to the appropriate type, as described in the documentation for compareUnsortedEncodedArrays(). Based on the type of the indexer, this method should get a predicate of the same type from the supplied predicateFactory. For example, a StringDimensionIndexer would call predicateFactory.makeStringPredicate(). The returned ValueMatcher should apply the generated predicate to the dimension values. See StringDimensionIndexer for a reference implementation.
    
    Parameters:
    
    predicateFactory - Factory object that can generate predicates for each supported dimension type
    
    holder - holds the current TimeAndDims key during row iteration
    
    dimIndex - the array index of this indexer's dimension within the TimeAndDims key
    
    Returns:
    
    A ValueMatcher that applies a predicate from the predicateFactory to the dimension values in the TimeAndDim keys

Interface DimensionIndexer<EncodedType extends Comparable<EncodedType>,EncodedTypeArray,ActualType extends Comparable<ActualType>>

Method Summary

Method Detail

processRowValsToUnsortedEncodedArray

getSortedEncodedValueFromUnsorted

getUnsortedEncodedValueFromSorted

getSortedIndexedValues

getMinValue

getMaxValue

getCardinality

makeColumnValueSelector

compareUnsortedEncodedArrays

checkUnsortedEncodedArraysEqual

getUnsortedEncodedArrayHashCode

convertUnsortedEncodedArrayToActualArrayOrList

convertUnsortedEncodedArrayToSortedEncodedArray

fillBitmapsFromUnsortedEncodedArray

makeIndexingValueMatcher

makeIndexingValueMatcher