Package org.apache.druid.data.input.impl

Class DimensionsSpec

java.lang.Object

org.apache.druid.data.input.impl.DimensionsSpec

public class DimensionsSpec
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DimensionsSpec.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_FORCE_TIME_SORT
static final DimensionsSpec	EMPTY
static final String	PARAMETER_FORCE_TIME_SORT	Parameter name for allowing any sort order.
static final String	WARNING_NON_TIME_SORT_ORDER	Warning about non-time ordering to include in error messages when PARAMETER_FORCE_TIME_SORT is not set.

Constructor Summary

Constructors

Constructor	Description
DimensionsSpec(List<DimensionSchema> dimensions)

Method Summary

Modifier and Type	Method	Description
static DimensionsSpec.Builder	builder()
static DimensionsSpec.Builder	builder(DimensionsSpec dimensionsSpec)
static DimensionSchema	convertSpatialSchema(SpatialDimensionSchema spatialSchema)
boolean	equals(Object o)
static List<DimensionSchema>	getDefaultSchemas(List<String> dimNames)
static List<DimensionSchema>	getDefaultSchemas(List<String> dimNames, DimensionSchema.MultiValueHandling multiValueHandling)
Set<String>	getDimensionExclusions()
List<String>	getDimensionNames()
List<DimensionSchema>	getDimensions()
DimensionSchema	getSchema(String dimension)
List<SpatialDimensionSchema>	getSpatialDimensions()	Deprecated.
boolean	hasFixedDimensions()	Whether this spec represents a set of fixed dimensions.
int	hashCode()
boolean	isForceSegmentSortByTime()	Returns isForceSegmentSortByTimeConfigured() if nonnull, otherwise DEFAULT_FORCE_TIME_SORT.
Boolean	isForceSegmentSortByTimeConfigured()
boolean	isIncludeAllDimensions()
DimensionsSpec.Builder	toBuilder()
String	toString()
boolean	useSchemaDiscovery()
DimensionsSpec	withDimensionExclusions(Set<String> dimExs)
DimensionsSpec	withDimensions(List<DimensionSchema> dims)
DimensionsSpec	withSpatialDimensions(List<SpatialDimensionSchema> spatials)	Deprecated.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

PARAMETER_FORCE_TIME_SORT

public static final String PARAMETER_FORCE_TIME_SORT

Parameter name for allowing any sort order. Also used as an MSQ context parameter, for some consistency between MSQ and native ingest configuration.

See Also:

• Constant Field Values

WARNING_NON_TIME_SORT_ORDER

public static final String WARNING_NON_TIME_SORT_ORDER

Warning about non-time ordering to include in error messages when PARAMETER_FORCE_TIME_SORT is not set.

DEFAULT_FORCE_TIME_SORT

public static final boolean DEFAULT_FORCE_TIME_SORT

See Also:

• Constant Field Values

EMPTY

public static final DimensionsSpec EMPTY

Constructor Details

DimensionsSpec

public DimensionsSpec(List<DimensionSchema> dimensions)

Method Details

getDefaultSchemas

public static List<DimensionSchema> getDefaultSchemas(List<String> dimNames)

getDefaultSchemas

public static List<DimensionSchema> getDefaultSchemas(List<String> dimNames,
 DimensionSchema.MultiValueHandling multiValueHandling)

convertSpatialSchema

public static DimensionSchema convertSpatialSchema(SpatialDimensionSchema spatialSchema)

builder

public static DimensionsSpec.Builder builder()

builder

public static DimensionsSpec.Builder builder(DimensionsSpec dimensionsSpec)

getDimensions

public List<DimensionSchema> getDimensions()

getDimensionExclusions

public Set<String> getDimensionExclusions()

isIncludeAllDimensions

public boolean isIncludeAllDimensions()

useSchemaDiscovery

public boolean useSchemaDiscovery()

isForceSegmentSortByTimeConfigured

public Boolean isForceSegmentSortByTimeConfigured()

isForceSegmentSortByTime

public boolean isForceSegmentSortByTime()

Returns isForceSegmentSortByTimeConfigured() if nonnull, otherwise DEFAULT_FORCE_TIME_SORT.

getSpatialDimensions

@Deprecated
public List<SpatialDimensionSchema> getSpatialDimensions()

Deprecated.

getDimensionNames

public List<String> getDimensionNames()

getSchema

public DimensionSchema getSchema(String dimension)

hasFixedDimensions

public boolean hasFixedDimensions()

Whether this spec represents a set of fixed dimensions. Will be false if schema discovery is enabled, even if some dimensions are explicitly defined.

withDimensions

public DimensionsSpec withDimensions(List<DimensionSchema> dims)

withDimensionExclusions

public DimensionsSpec withDimensionExclusions(Set<String> dimExs)

withSpatialDimensions

@Deprecated
public DimensionsSpec withSpatialDimensions(List<SpatialDimensionSchema> spatials)

Deprecated.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toBuilder

public DimensionsSpec.Builder toBuilder()