com.endeca.repository.importer

Class Dimension

java.lang.Object

com.endeca.repository.importer.SchemaConfig

com.endeca.repository.importer.Attribute

com.endeca.repository.importer.Dimension

public class Dimension
extends Attribute

A Dimension represents the definition of a dimension in the MDEX Engine.

Constructor Summary

Constructors

Constructor and Description
Dimension(Dimension other) Creates a Dimension which is a copy of the given Dimension.
Dimension(String attributeName) Creates a Dimension with given name.

Method Summary

Methods

Modifier and Type	Method and Description
Long	getDisplayOrder() Gets the display order for this dimension.
MultiSelectType	getMultiSelectType() Gets a dimension's multi-select type, or null if the type is not set.
RangeComparisonType	getRangeComparisonType() Gets a dimension's range comparison type, or null if the type is not set.
Collection<String>	getSourcePropertyNames() Gets the source property names that are used when data records are processed.
Boolean	isAutogen() Gets a dimension's autogen value.
Boolean	isHierarchicalDimensionSearchEnabled() Indicates whether hierarchical dimension search is enabled for this dimension.
Boolean	isHierarchicalRecordSearchEnabled() Indicates whether hierarchical record search is enabled for this dimension.
Boolean	isRecordSearchEnabled() Indicates whether record search is enabled for this dimension.
Boolean	isWildcardEnabledInRecordSearch() Indicates whether wildcard search is enabled for record search for this dimension.
void	setAutogen(Boolean isAutogen) Sets whether or not to auto-generate dimension values for this dimension.
void	setDisplayOrder(Long displayOrder) Specifies the display order of a dimension relative to other dimensions in refinement results.
void	setHierarchicalDimensionSearchEnabled(Boolean isHierarchicalDimensionSearchEnabled) Enables hierarchical dimension search for this dimension.
void	setHierarchicalRecordSearchEnabled(Boolean isHierarchicalRecordSearchEnabled) Enables hierarchical record search for this dimension.
void	setMultiSelectType(MultiSelectType multiSelectType) Sets the multi-select type to use for this dimension.
void	setRangeComparisonType(RangeComparisonType rangeComparisonType) Sets the data type to use for range dimension mapping.
void	setRecordSearchEnabled(Boolean isRecordSearchEnabled) Enables record search for this dimension.
void	setSourcePropertyNames(Collection<String> sourcePropertyNames) Allows the dimension to be populated from specific source properties when data records are processed.
void	setWildcardEnabledInRecordSearch(Boolean isWildcardEnabledInRecordSearch) Enables wildcard search for record search for this dimension.

Methods inherited from class com.endeca.repository.importer.Attribute

getAttributeName

Methods inherited from class com.endeca.repository.importer.SchemaConfig

equals, getMergeAction, hashCode, isEnabled, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Dimension

public Dimension(String attributeName)

Creates a Dimension with given name.

Parameters:

attributeName - name of dimension.

Dimension

public Dimension(Dimension other)

Creates a Dimension which is a copy of the given Dimension.

Parameters:

other -

Method Detail

setRangeComparisonType

public void setRangeComparisonType(RangeComparisonType rangeComparisonType)

Sets the data type to use for range dimension mapping. Doing so marks this dimension as a range dimension.

Parameters:

rangeComparisonType - the type to use

setAutogen

public void setAutogen(Boolean isAutogen)

Sets whether or not to auto-generate dimension values for this dimension.

Parameters:

isAutogen - true to auto-generate dimension values for this dimension, false otherwise.

setMultiSelectType

public void setMultiSelectType(MultiSelectType multiSelectType)

Sets the multi-select type to use for this dimension.

Parameters:

multiSelectType - the type to use

setDisplayOrder

public void setDisplayOrder(Long displayOrder)

Specifies the display order of a dimension relative to other dimensions in refinement results. Dimensions with lower values display before dimensions with higher values. Valid values are integers between 0 and 2147483647. If omitted, the dimension displays lower than dimensions with specified display orders. If dimension have the same display order value (a tie), the dimensions are ordered alphabetically by dimension name.

Parameters:

displayOrder - the display order for this dimension

setSourcePropertyNames

public void setSourcePropertyNames(Collection<String> sourcePropertyNames)

Allows the dimension to be populated from specific source properties when data records are processed.

If no source property name is specified for a given dimension, the default behavior is to map the dimension using a source property of the same name as the dimension's name.

If the source property name field is specified but with no names (i.e. a zero-length list of values), the given dimension is not mapped at all. This allows the dimension to continue to be defined, but to not ever have any data mapped to it.

If the source property name field is specified with a single name, that name is used to identify source properties whose values should be mapped to the given dimension. This takes the place of the source property with the matching name.

If the source property name field is specified with multiple names, then each source property whose name appears in this list has its values mapped to the given dimension.

Note that this permits a many-to-many mapping: a given dimension may get values from many source properties on an input data record, and the same source property may be used to provide values to more than one attribute.

Parameters:

sourcePropertyNames -

setRecordSearchEnabled

public void setRecordSearchEnabled(Boolean isRecordSearchEnabled)

Enables record search for this dimension.

Parameters:

isRecordSearchEnabled -

setWildcardEnabledInRecordSearch

public void setWildcardEnabledInRecordSearch(Boolean isWildcardEnabledInRecordSearch)

Enables wildcard search for record search for this dimension.

Parameters:

isWildcardEnabledInRecordSearch -

setHierarchicalRecordSearchEnabled

public void setHierarchicalRecordSearchEnabled(Boolean isHierarchicalRecordSearchEnabled)

Enables hierarchical record search for this dimension.

Parameters:

isHierarchicalRecordSearchEnabled -

setHierarchicalDimensionSearchEnabled

public void setHierarchicalDimensionSearchEnabled(Boolean isHierarchicalDimensionSearchEnabled)

Enables hierarchical dimension search for this dimension.

Parameters:

isHierarchicalDimensionSearchEnabled -

getRangeComparisonType

public RangeComparisonType getRangeComparisonType()

Gets a dimension's range comparison type, or null if the type is not set.

getMultiSelectType

public MultiSelectType getMultiSelectType()

Gets a dimension's multi-select type, or null if the type is not set.

getDisplayOrder

public Long getDisplayOrder()

Gets the display order for this dimension.

isAutogen

public Boolean isAutogen()

Gets a dimension's autogen value.

getSourcePropertyNames

public Collection<String> getSourcePropertyNames()

Gets the source property names that are used when data records are processed.

isRecordSearchEnabled

public Boolean isRecordSearchEnabled()

Indicates whether record search is enabled for this dimension.

isWildcardEnabledInRecordSearch

public Boolean isWildcardEnabledInRecordSearch()

Indicates whether wildcard search is enabled for record search for this dimension.

isHierarchicalRecordSearchEnabled

public Boolean isHierarchicalRecordSearchEnabled()

Indicates whether hierarchical record search is enabled for this dimension.

isHierarchicalDimensionSearchEnabled

public Boolean isHierarchicalDimensionSearchEnabled()

Indicates whether hierarchical dimension search is enabled for this dimension.