de.hybris.platform.lucenesearch.model

Class AttributeConfigurationModel

java.lang.Object

de.hybris.platform.servicelayer.model.AbstractItemModel

de.hybris.platform.core.model.ItemModel

de.hybris.platform.lucenesearch.model.AbstractLuceneItemModel

de.hybris.platform.lucenesearch.model.AttributeConfigurationModel

All Implemented Interfaces:

Serializable

public class AttributeConfigurationModel
extends AbstractLuceneItemModel

Generated model class for type AttributeConfiguration first defined at extension lucenesearch.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

AbstractItemModel.NewModelContextFactory

Field Summary

Fields

Modifier and Type	Field and Description
static String	_TYPECODE Generated model type code constant.
static String	AVAILABLEINDEXABLEATTRIBUTES Generated constant - Attribute key of AttributeConfiguration.availableIndexableAttributes attribute defined at extension lucenesearch.
static String	EXACT Generated constant - Attribute key of AttributeConfiguration.exact attribute defined at extension lucenesearch.
static String	FIELDNAME Generated constant - Attribute key of AttributeConfiguration.fieldName attribute defined at extension lucenesearch.
static String	INDEXCONFIGURATION Generated constant - Attribute key of AttributeConfiguration.indexConfiguration attribute defined at extension lucenesearch.
static String	INDEXEDATTRIBUTE Generated constant - Attribute key of AttributeConfiguration.indexedAttribute attribute defined at extension lucenesearch.
static String	STOREDATA Generated constant - Attribute key of AttributeConfiguration.storeData attribute defined at extension lucenesearch.
static String	WEIGHT Generated constant - Attribute key of AttributeConfiguration.weight attribute defined at extension lucenesearch.

Fields inherited from class de.hybris.platform.core.model.ItemModel

_COMMENTITEMRELATION, COMMENTS, CREATIONTIME, ITEMTYPE, MODIFIEDTIME, OWNER, PK

Fields inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

LANGUAGE_FALLBACK_ENABLED_SERVICE_LAYER, MODEL_CONTEXT_FACTORY

Constructor Summary

Constructors

Constructor and Description
AttributeConfigurationModel() Generated constructor - Default constructor for generic creation.
AttributeConfigurationModel(IndexConfigurationModel _indexConfiguration, AttributeDescriptorModel _indexedAttribute) Deprecated. Since 4.1.1 Please use the default constructor without parameters
AttributeConfigurationModel(IndexConfigurationModel _indexConfiguration, AttributeDescriptorModel _indexedAttribute, ItemModel _owner) Deprecated. Since 4.1.1 Please use the default constructor without parameters
AttributeConfigurationModel(ItemModelContext ctx) Generated constructor - Default constructor for creation with existing context

Method Summary

Modifier and Type	Method and Description
Collection<AttributeDescriptorModel>	getAvailableIndexableAttributes() Generated method - Getter of the AttributeConfiguration.availableIndexableAttributes attribute defined at extension lucenesearch.
Boolean	getExact() Generated method - Getter of the AttributeConfiguration.exact attribute defined at extension lucenesearch.
String	getFieldName() Generated method - Getter of the AttributeConfiguration.fieldName attribute defined at extension lucenesearch.
IndexConfigurationModel	getIndexConfiguration() Generated method - Getter of the AttributeConfiguration.indexConfiguration attribute defined at extension lucenesearch.
AttributeDescriptorModel	getIndexedAttribute() Generated method - Getter of the AttributeConfiguration.indexedAttribute attribute defined at extension lucenesearch.
Boolean	getStoreData() Generated method - Getter of the AttributeConfiguration.storeData attribute defined at extension lucenesearch.
Double	getWeight() Generated method - Getter of the AttributeConfiguration.weight attribute defined at extension lucenesearch.
void	setExact(Boolean value) Generated method - Setter of AttributeConfiguration.exact attribute defined at extension lucenesearch.
void	setFieldName(String value) Generated method - Setter of AttributeConfiguration.fieldName attribute defined at extension lucenesearch.
void	setIndexConfiguration(IndexConfigurationModel value) Generated method - Initial setter of AttributeConfiguration.indexConfiguration attribute defined at extension lucenesearch.
void	setIndexedAttribute(AttributeDescriptorModel value) Generated method - Setter of AttributeConfiguration.indexedAttribute attribute defined at extension lucenesearch.
void	setStoreData(Boolean value) Generated method - Setter of AttributeConfiguration.storeData attribute defined at extension lucenesearch.
void	setWeight(Double value) Generated method - Setter of AttributeConfiguration.weight attribute defined at extension lucenesearch.

Methods inherited from class de.hybris.platform.core.model.ItemModel

getComments, getCreationtime, getModifiedtime, getOwner, setComments, setCreationtime, setModifiedtime, setOwner

Methods inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

equals, getItemModelContext, getItemtype, getPersistenceContext, getPk, getProperty, getProperty, getTenantId, hashCode, readResolve, setProperty, setProperty, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toString, writeReplace

Methods inherited from class java.lang.Object

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

Field Detail

_TYPECODE

public static final String _TYPECODE

Generated model type code constant.

See Also:

Constant Field Values

AVAILABLEINDEXABLEATTRIBUTES

public static final String AVAILABLEINDEXABLEATTRIBUTES

Generated constant - Attribute key of AttributeConfiguration.availableIndexableAttributes attribute defined at extension lucenesearch.

See Also:

Constant Field Values

EXACT

public static final String EXACT

Generated constant - Attribute key of AttributeConfiguration.exact attribute defined at extension lucenesearch.

See Also:

Constant Field Values

FIELDNAME

public static final String FIELDNAME

Generated constant - Attribute key of AttributeConfiguration.fieldName attribute defined at extension lucenesearch.

See Also:

Constant Field Values

INDEXCONFIGURATION

public static final String INDEXCONFIGURATION

Generated constant - Attribute key of AttributeConfiguration.indexConfiguration attribute defined at extension lucenesearch.

See Also:

Constant Field Values

INDEXEDATTRIBUTE

public static final String INDEXEDATTRIBUTE

Generated constant - Attribute key of AttributeConfiguration.indexedAttribute attribute defined at extension lucenesearch.

See Also:

Constant Field Values

STOREDATA

public static final String STOREDATA

Generated constant - Attribute key of AttributeConfiguration.storeData attribute defined at extension lucenesearch.

See Also:

Constant Field Values

WEIGHT

public static final String WEIGHT

Generated constant - Attribute key of AttributeConfiguration.weight attribute defined at extension lucenesearch.

See Also:

Constant Field Values

Constructor Detail

AttributeConfigurationModel

public AttributeConfigurationModel()

Generated constructor - Default constructor for generic creation.

AttributeConfigurationModel

public AttributeConfigurationModel(ItemModelContext ctx)

Generated constructor - Default constructor for creation with existing context

Parameters:

ctx - the model context to be injected, must not be null

AttributeConfigurationModel

@Deprecated
public AttributeConfigurationModel(IndexConfigurationModel _indexConfiguration,
                                               AttributeDescriptorModel _indexedAttribute)

Deprecated. Since 4.1.1 Please use the default constructor without parameters

Generated constructor - Constructor with all mandatory attributes.

Parameters:

_indexConfiguration - initial attribute declared by type AttributeConfiguration at extension lucenesearch

_indexedAttribute - initial attribute declared by type AttributeConfiguration at extension lucenesearch

AttributeConfigurationModel

@Deprecated
public AttributeConfigurationModel(IndexConfigurationModel _indexConfiguration,
                                               AttributeDescriptorModel _indexedAttribute,
                                               ItemModel _owner)

Deprecated. Since 4.1.1 Please use the default constructor without parameters

Generated constructor - for all mandatory and initial attributes.

Parameters:

_indexConfiguration - initial attribute declared by type AttributeConfiguration at extension lucenesearch

_indexedAttribute - initial attribute declared by type AttributeConfiguration at extension lucenesearch

_owner - initial attribute declared by type Item at extension core

Method Detail

getAvailableIndexableAttributes

@Accessor(qualifier="availableIndexableAttributes",
          type=GETTER)
public Collection<AttributeDescriptorModel> getAvailableIndexableAttributes()

Generated method - Getter of the AttributeConfiguration.availableIndexableAttributes attribute defined at extension lucenesearch. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.

Returns:

the availableIndexableAttributes - Direct mapping of the availableIndexableAttribute attribute of the IndexConfiguration to which the AttributeConfiguration is assigned. Jalo-only attribute.

getExact

@Accessor(qualifier="exact",
          type=GETTER)
public Boolean getExact()

Generated method - Getter of the AttributeConfiguration.exact attribute defined at extension lucenesearch.

Returns:

the exact - Indicates whether this attribute text must be indexed exactly (for example, without any stemming mechanism), such as codes or identification numbers. Defaults to Boolean.FALSE.

getFieldName

@Accessor(qualifier="fieldName",
          type=GETTER)
public String getFieldName()

Generated method - Getter of the AttributeConfiguration.fieldName attribute defined at extension lucenesearch.

Returns:

the fieldName - Field name within the lucene index where the attribute will be stored.

getIndexConfiguration

@Accessor(qualifier="indexConfiguration",
          type=GETTER)
public IndexConfigurationModel getIndexConfiguration()

Generated method - Getter of the AttributeConfiguration.indexConfiguration attribute defined at extension lucenesearch.

Returns:

the indexConfiguration - The IndexConfiguration to which this configuration belongs.

getIndexedAttribute

@Accessor(qualifier="indexedAttribute",
          type=GETTER)
public AttributeDescriptorModel getIndexedAttribute()

Generated method - Getter of the AttributeConfiguration.indexedAttribute attribute defined at extension lucenesearch.

Returns:

the indexedAttribute - Gets the attribute definition this configuration represents. Is limited to the values of the availableIndexableAttributes attribute.

getStoreData

@Accessor(qualifier="storeData",
          type=GETTER)
public Boolean getStoreData()

Generated method - Getter of the AttributeConfiguration.storeData attribute defined at extension lucenesearch.

Returns:

the storeData - Specifies whether the original text has to be stored inside the lucene index as well. Defaults to Boolean.TRUE.

getWeight

@Accessor(qualifier="weight",
          type=GETTER)
public Double getWeight()

Generated method - Getter of the AttributeConfiguration.weight attribute defined at extension lucenesearch.

Returns:

the weight - The weighting of the attribute within the Lucene index. Must be greater than 0. Defaults to new Double(1.0).

setExact

@Accessor(qualifier="exact",
          type=SETTER)
public void setExact(Boolean value)

Generated method - Setter of AttributeConfiguration.exact attribute defined at extension lucenesearch.

Parameters:

value - the exact - Indicates whether this attribute text must be indexed exactly (for example, without any stemming mechanism), such as codes or identification numbers. Defaults to Boolean.FALSE.

setFieldName

@Accessor(qualifier="fieldName",
          type=SETTER)
public void setFieldName(String value)

Generated method - Setter of AttributeConfiguration.fieldName attribute defined at extension lucenesearch.

Parameters:

value - the fieldName - Field name within the lucene index where the attribute will be stored.

setIndexConfiguration

@Accessor(qualifier="indexConfiguration",
          type=SETTER)
public void setIndexConfiguration(IndexConfigurationModel value)

Generated method - Initial setter of AttributeConfiguration.indexConfiguration attribute defined at extension lucenesearch. Can only be used at creation of model - before first save.

Parameters:

value - the indexConfiguration - The IndexConfiguration to which this configuration belongs.

setIndexedAttribute

@Accessor(qualifier="indexedAttribute",
          type=SETTER)
public void setIndexedAttribute(AttributeDescriptorModel value)

Generated method - Setter of AttributeConfiguration.indexedAttribute attribute defined at extension lucenesearch.

Parameters:

value - the indexedAttribute - Gets the attribute definition this configuration represents. Is limited to the values of the availableIndexableAttributes attribute.

setStoreData

@Accessor(qualifier="storeData",
          type=SETTER)
public void setStoreData(Boolean value)

Generated method - Setter of AttributeConfiguration.storeData attribute defined at extension lucenesearch.

Parameters:

value - the storeData - Specifies whether the original text has to be stored inside the lucene index as well. Defaults to Boolean.TRUE.

setWeight

@Accessor(qualifier="weight",
          type=SETTER)
public void setWeight(Double value)

Generated method - Setter of AttributeConfiguration.weight attribute defined at extension lucenesearch.

Parameters:

value - the weight - The weighting of the attribute within the Lucene index. Must be greater than 0. Defaults to new Double(1.0).