Apache
/
druid
mirror of https://github.com/apache/druid.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix Javadocs in ColumnCapablities.java (#17462)

This commit is contained in:
Virushade 2024-11-12 14:00:33 +08:00 committed by GitHub
parent 3f56b57c7e
commit 8278a1f7df
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
processing/src/main/java/org/apache/druid/segment/column/ColumnCapabilities.java
View File

@ -38,13 +38,13 @@ public interface ColumnCapabilities extends TypeSignature<ValueType>
/** /**
* Is the column dictionary encoded? If so, a DimensionDictionarySelector may be used instead of using a value * Is the column dictionary encoded? If so, a DimensionDictionarySelector may be used instead of using a value
* selector, allowing algorithms to operate on primitive integer dictionary ids rather than the looked up dictionary * selector, allowing algorithms to operate on primitive integer dictionary ids rather than the looked up dictionary
* values * values.
*/ */
Capable isDictionaryEncoded(); Capable isDictionaryEncoded();
/** /**
* If the column is dictionary encoded, are those values sorted? Useful to know for optimizations that can defer * If the column is dictionary encoded, are those values sorted? Useful to know for optimizations that can defer
* looking up values and allowing sorting with the dictionary ids directly * looking up values and allowing sorting with the dictionary ids directly.
*/ */
Capable areDictionaryValuesSorted(); Capable areDictionaryValuesSorted();
@ -52,20 +52,20 @@ public interface ColumnCapabilities extends TypeSignature<ValueType>
/** /**
* If the column is dictionary encoded, is there a 1:1 mapping of dictionary ids to values? If this is true, it * If the column is dictionary encoded, is there a 1:1 mapping of dictionary ids to values? If this is true, it
* unlocks optimizations such as allowing for things like grouping directly on dictionary ids and deferred value * unlocks optimizations such as allowing for things like grouping directly on dictionary ids and deferred value
* lookup * lookup.
*/ */
Capable areDictionaryValuesUnique(); Capable areDictionaryValuesUnique();
/** /**
* String columns are sneaky, and might have multiple values, this is to allow callers to know and appropriately * String columns are sneaky, and might have multiple values, this is to allow callers to know and appropriately
* prepare themselves * prepare themselves.
*/ */
Capable hasMultipleValues(); Capable hasMultipleValues();
/** /**
* Does the column have an inverted index bitmap for each value? If so, these may be employed to 'pre-filter' the * Does the column have an inverted index bitmap for each value? If so, these may be employed to 'pre-filter' the
* column by examining if the values match the filter and intersecting the bitmaps, to avoid having to scan and * column by examining if the values match the filter and intersecting the bitmaps, to avoid having to scan and
* evaluate if every row matches the filter * evaluate if every row matches the filter.
*/ */
boolean hasBitmapIndexes(); boolean hasBitmapIndexes();
@ -76,7 +76,7 @@ public interface ColumnCapabilities extends TypeSignature<ValueType>
/** /**
* Does this column contain null values? If so, callers, especially for primitive numeric columns, will need to check * Does this column contain null values? If so, callers, especially for primitive numeric columns, will need to check
* for null value rows and act accordingly * for null value rows and act accordingly.
*/ */
Capable hasNulls(); Capable hasNulls();
@ -164,7 +164,7 @@ public interface ColumnCapabilities extends TypeSignature<ValueType>
} }
/** /**
* This interface defines the shape of a mechnism to allow for bespoke coercion of {@link Capable#UNKNOWN} into * This interface defines the shape of a mechanism to allow for bespoke coercion of {@link Capable#UNKNOWN} into
* {@link Capable#TRUE} or {@link Capable#FALSE} for each {@link Capable} of a {@link ColumnCapabilities}, as is * {@link Capable#TRUE} or {@link Capable#FALSE} for each {@link Capable} of a {@link ColumnCapabilities}, as is
* appropriate for the situation of the caller. * appropriate for the situation of the caller.
*/ */
@ -177,13 +177,13 @@ public interface ColumnCapabilities extends TypeSignature<ValueType>
boolean dictionaryEncoded(); boolean dictionaryEncoded();
/** /**
* If {@link ColumnCapabilities#areDictionaryValuesSorted()} ()} is {@link Capable#UNKNOWN}, define if it should be * If {@link ColumnCapabilities#areDictionaryValuesSorted()} is {@link Capable#UNKNOWN}, define if it should be
* treated as true or false. * treated as true or false.
*/ */
boolean dictionaryValuesSorted(); boolean dictionaryValuesSorted();
/** /**
* If {@link ColumnCapabilities#areDictionaryValuesUnique()} ()} is {@link Capable#UNKNOWN}, define if it should be * If {@link ColumnCapabilities#areDictionaryValuesUnique()} is {@link Capable#UNKNOWN}, define if it should be
* treated as true or false. * treated as true or false.
*/ */
boolean dictionaryValuesUnique(); boolean dictionaryValuesUnique();
@ -196,7 +196,7 @@ public interface ColumnCapabilities extends TypeSignature<ValueType>
/** /**
* If {@link ColumnCapabilities#hasNulls()} is {@link Capable#UNKNOWN}, define if it should be treated as true * If {@link ColumnCapabilities#hasNulls()} is {@link Capable#UNKNOWN}, define if it should be treated as true
* or false * or false.
*/ */
boolean hasNulls(); boolean hasNulls();
} }