de.hybris.platform.lucenesearch.model

Class IndexConfigurationModel

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.IndexConfigurationModel

All Implemented Interfaces:

java.io.Serializable

public class IndexConfigurationModel
extends AbstractLuceneItemModel

Generated model class for type IndexConfiguration 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 java.lang.String	_TYPECODE Generated model type code constant.
static java.lang.String	ACTIVATIONATTRIBUTE Generated constant - Attribute key of IndexConfiguration.activationAttribute attribute defined at extension lucenesearch.
static java.lang.String	ALLAVAILABLEATTRIBUTES Generated constant - Attribute key of IndexConfiguration.allAvailableAttributes attribute defined at extension lucenesearch.
static java.lang.String	ATTRIBUTECONFIGURATIONS Generated constant - Attribute key of IndexConfiguration.attributeConfigurations attribute defined at extension lucenesearch.
static java.lang.String	AVAILABLEACTIVATIONATTRIBUTES Generated constant - Attribute key of IndexConfiguration.availableActivationAttributes attribute defined at extension lucenesearch.
static java.lang.String	AVAILABLEGROUPINGATTRIBUTES Generated constant - Attribute key of IndexConfiguration.availableGroupingAttributes attribute defined at extension lucenesearch.
static java.lang.String	AVAILABLEINDEXABLEATTRIBUTES Generated constant - Attribute key of IndexConfiguration.availableIndexableAttributes attribute defined at extension lucenesearch.
static java.lang.String	GROUPINGATTRIBUTE Generated constant - Attribute key of IndexConfiguration.groupingAttribute attribute defined at extension lucenesearch.
static java.lang.String	INCLUDEDTYPES Generated constant - Attribute key of IndexConfiguration.includedTypes attribute defined at extension lucenesearch.
static java.lang.String	INDEXEDDATAFACTORYCLASSNAME Generated constant - Attribute key of IndexConfiguration.indexedDataFactoryClassName attribute defined at extension lucenesearch.
static java.lang.String	INDEXEDDATAPARAMS Generated constant - Attribute key of IndexConfiguration.indexedDataParams attribute defined at extension lucenesearch.
static java.lang.String	INDEXEDTYPE Generated constant - Attribute key of IndexConfiguration.indexedType attribute defined at extension lucenesearch.
static java.lang.String	LUCENEINDEX Generated constant - Attribute key of IndexConfiguration.luceneIndex attribute defined at extension lucenesearch.
static java.lang.String	PENDINGUPDATES Generated constant - Attribute key of IndexConfiguration.pendingUpdates 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
IndexConfigurationModel() Generated constructor - Default constructor for generic creation.
IndexConfigurationModel(ComposedTypeModel _indexedType, LuceneIndexModel _luceneIndex) Deprecated. since 4.1.1 Please use the default constructor without parameters
IndexConfigurationModel(ComposedTypeModel _indexedType, LuceneIndexModel _luceneIndex, ItemModel _owner) Deprecated. since 4.1.1 Please use the default constructor without parameters
IndexConfigurationModel(ItemModelContext ctx) Generated constructor - Default constructor for creation with existing context

Method Summary

Modifier and Type	Method and Description
AttributeDescriptorModel	getActivationAttribute() Generated method - Getter of the IndexConfiguration.activationAttribute attribute defined at extension lucenesearch.
java.util.Collection<AttributeDescriptorModel>	getAllAvailableAttributes() Generated method - Getter of the IndexConfiguration.allAvailableAttributes attribute defined at extension lucenesearch.
java.util.Collection<AttributeConfigurationModel>	getAttributeConfigurations() Generated method - Getter of the IndexConfiguration.attributeConfigurations attribute defined at extension lucenesearch.
java.util.Collection<AttributeDescriptorModel>	getAvailableActivationAttributes() Generated method - Getter of the IndexConfiguration.availableActivationAttributes attribute defined at extension lucenesearch.
java.util.Collection<AttributeDescriptorModel>	getAvailableGroupingAttributes() Generated method - Getter of the IndexConfiguration.availableGroupingAttributes attribute defined at extension lucenesearch.
java.util.Collection<AttributeDescriptorModel>	getAvailableIndexableAttributes() Generated method - Getter of the IndexConfiguration.availableIndexableAttributes attribute defined at extension lucenesearch.
AttributeDescriptorModel	getGroupingAttribute() Generated method - Getter of the IndexConfiguration.groupingAttribute attribute defined at extension lucenesearch.
java.util.Collection<ComposedTypeModel>	getIncludedTypes() Generated method - Getter of the IndexConfiguration.includedTypes attribute defined at extension lucenesearch.
java.lang.String	getIndexedDataFactoryClassName() Generated method - Getter of the IndexConfiguration.indexedDataFactoryClassName attribute defined at extension lucenesearch.
java.lang.String	getIndexedDataParams() Generated method - Getter of the IndexConfiguration.indexedDataParams attribute defined at extension lucenesearch.
ComposedTypeModel	getIndexedType() Generated method - Getter of the IndexConfiguration.indexedType attribute defined at extension lucenesearch.
LuceneIndexModel	getLuceneIndex() Generated method - Getter of the IndexConfiguration.luceneIndex attribute defined at extension lucenesearch.
java.util.Collection<IndexUpdateModel>	getPendingUpdates() Generated method - Getter of the IndexConfiguration.pendingUpdates attribute defined at extension lucenesearch.
void	setActivationAttribute(AttributeDescriptorModel value) Generated method - Setter of IndexConfiguration.activationAttribute attribute defined at extension lucenesearch.
void	setAttributeConfigurations(java.util.Collection<AttributeConfigurationModel> value) Generated method - Setter of IndexConfiguration.attributeConfigurations attribute defined at extension lucenesearch.
void	setGroupingAttribute(AttributeDescriptorModel value) Generated method - Setter of IndexConfiguration.groupingAttribute attribute defined at extension lucenesearch.
void	setIncludedTypes(java.util.Collection<ComposedTypeModel> value) Generated method - Setter of IndexConfiguration.includedTypes attribute defined at extension lucenesearch.
void	setIndexedDataFactoryClassName(java.lang.String value) Generated method - Setter of IndexConfiguration.indexedDataFactoryClassName attribute defined at extension lucenesearch.
void	setIndexedDataParams(java.lang.String value) Generated method - Setter of IndexConfiguration.indexedDataParams attribute defined at extension lucenesearch.
void	setIndexedType(ComposedTypeModel value) Generated method - Initial setter of IndexConfiguration.indexedType attribute defined at extension lucenesearch.
void	setLuceneIndex(LuceneIndexModel value) Generated method - Setter of IndexConfiguration.luceneIndex attribute defined at extension lucenesearch.
void	setPendingUpdates(java.util.Collection<IndexUpdateModel> value) Generated method - Setter of IndexConfiguration.pendingUpdates 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 java.lang.String _TYPECODE

Generated model type code constant.

See Also:

Constant Field Values

ACTIVATIONATTRIBUTE

public static final java.lang.String ACTIVATIONATTRIBUTE

Generated constant - Attribute key of IndexConfiguration.activationAttribute attribute defined at extension lucenesearch.

See Also:

Constant Field Values

ALLAVAILABLEATTRIBUTES

public static final java.lang.String ALLAVAILABLEATTRIBUTES

Generated constant - Attribute key of IndexConfiguration.allAvailableAttributes attribute defined at extension lucenesearch.

See Also:

Constant Field Values

ATTRIBUTECONFIGURATIONS

public static final java.lang.String ATTRIBUTECONFIGURATIONS

Generated constant - Attribute key of IndexConfiguration.attributeConfigurations attribute defined at extension lucenesearch.

See Also:

Constant Field Values

AVAILABLEACTIVATIONATTRIBUTES

public static final java.lang.String AVAILABLEACTIVATIONATTRIBUTES

Generated constant - Attribute key of IndexConfiguration.availableActivationAttributes attribute defined at extension lucenesearch.

See Also:

Constant Field Values

AVAILABLEGROUPINGATTRIBUTES

public static final java.lang.String AVAILABLEGROUPINGATTRIBUTES

Generated constant - Attribute key of IndexConfiguration.availableGroupingAttributes attribute defined at extension lucenesearch.

See Also:

Constant Field Values

AVAILABLEINDEXABLEATTRIBUTES

public static final java.lang.String AVAILABLEINDEXABLEATTRIBUTES

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

See Also:

Constant Field Values

GROUPINGATTRIBUTE

public static final java.lang.String GROUPINGATTRIBUTE

Generated constant - Attribute key of IndexConfiguration.groupingAttribute attribute defined at extension lucenesearch.

See Also:

Constant Field Values

INDEXEDDATAFACTORYCLASSNAME

public static final java.lang.String INDEXEDDATAFACTORYCLASSNAME

Generated constant - Attribute key of IndexConfiguration.indexedDataFactoryClassName attribute defined at extension lucenesearch.

See Also:

Constant Field Values

INDEXEDDATAPARAMS

public static final java.lang.String INDEXEDDATAPARAMS

Generated constant - Attribute key of IndexConfiguration.indexedDataParams attribute defined at extension lucenesearch.

See Also:

Constant Field Values

INDEXEDTYPE

public static final java.lang.String INDEXEDTYPE

Generated constant - Attribute key of IndexConfiguration.indexedType attribute defined at extension lucenesearch.

See Also:

Constant Field Values

LUCENEINDEX

public static final java.lang.String LUCENEINDEX

Generated constant - Attribute key of IndexConfiguration.luceneIndex attribute defined at extension lucenesearch.

See Also:

Constant Field Values

PENDINGUPDATES

public static final java.lang.String PENDINGUPDATES

Generated constant - Attribute key of IndexConfiguration.pendingUpdates attribute defined at extension lucenesearch.

See Also:

Constant Field Values

INCLUDEDTYPES

public static final java.lang.String INCLUDEDTYPES

Generated constant - Attribute key of IndexConfiguration.includedTypes attribute defined at extension lucenesearch.

See Also:

Constant Field Values

Constructor Detail

IndexConfigurationModel

public IndexConfigurationModel()

Generated constructor - Default constructor for generic creation.

IndexConfigurationModel

public IndexConfigurationModel(ItemModelContext ctx)

Generated constructor - Default constructor for creation with existing context

Parameters:

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

IndexConfigurationModel

@Deprecated
public IndexConfigurationModel(ComposedTypeModel _indexedType,
                                           LuceneIndexModel _luceneIndex)

Deprecated. since 4.1.1 Please use the default constructor without parameters

Generated constructor - Constructor with all mandatory attributes.

Parameters:

_indexedType - initial attribute declared by type IndexConfiguration at extension lucenesearch

_luceneIndex - initial attribute declared by type IndexConfiguration at extension lucenesearch

IndexConfigurationModel

@Deprecated
public IndexConfigurationModel(ComposedTypeModel _indexedType,
                                           LuceneIndexModel _luceneIndex,
                                           ItemModel _owner)

Deprecated. since 4.1.1 Please use the default constructor without parameters

Generated constructor - for all mandatory and initial attributes.

Parameters:

_indexedType - initial attribute declared by type IndexConfiguration at extension lucenesearch

_luceneIndex - initial attribute declared by type IndexConfiguration at extension lucenesearch

_owner - initial attribute declared by type Item at extension core

Method Detail

getActivationAttribute

@Accessor(qualifier="activationAttribute",
          type=GETTER)
public AttributeDescriptorModel getActivationAttribute()

Generated method - Getter of the IndexConfiguration.activationAttribute attribute defined at extension lucenesearch.

Returns:

the activationAttribute - Optional descriptor of boolean attribute. Instances must have the value true in this attribute to be indexed. Is limited to the values of the availableActivationAttributes attribute.

getAllAvailableAttributes

@Accessor(qualifier="allAvailableAttributes",
          type=GETTER)
public java.util.Collection<AttributeDescriptorModel> getAllAvailableAttributes()

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

Returns:

the allAvailableAttributes - Returns all attributes of the type specified by the indexedType attribute. Jalo-only attribute.

getAttributeConfigurations

@Accessor(qualifier="attributeConfigurations",
          type=GETTER)
public java.util.Collection<AttributeConfigurationModel> getAttributeConfigurations()

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

Returns:

the attributeConfigurations - All AttributeConfiguration objects that belong to this IndexConfiguration. Jalo-only attribute.

getAvailableActivationAttributes

@Accessor(qualifier="availableActivationAttributes",
          type=GETTER)
public java.util.Collection<AttributeDescriptorModel> getAvailableActivationAttributes()

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

Returns:

the availableActivationAttributes - all AttributeDescriptors of the indexed type. Jalo-only attribute. Deprecated.

getAvailableGroupingAttributes

@Accessor(qualifier="availableGroupingAttributes",
          type=GETTER)
public java.util.Collection<AttributeDescriptorModel> getAvailableGroupingAttributes()

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

Returns:

the availableGroupingAttributes - all groupable AttributeDescriptors of the indexed type. Jalo-only attribute. Deprecated.

getAvailableIndexableAttributes

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

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

Returns:

the availableIndexableAttributes - Gets all available attributes of the specified type which are indexable. Jalo-only attribute.

getGroupingAttribute

@Accessor(qualifier="groupingAttribute",
          type=GETTER)
public AttributeDescriptorModel getGroupingAttribute()

Generated method - Getter of the IndexConfiguration.groupingAttribute attribute defined at extension lucenesearch.

Returns:

the groupingAttribute - Optional descriptor of an attribute that puts the indexed item into one or more groups; see the documentation of LucenesearchManager for a description of grouping. Is limited to the values of the availableGroupingAttributes attribute.

getIncludedTypes

@Accessor(qualifier="includedTypes",
          type=GETTER)
public java.util.Collection<ComposedTypeModel> getIncludedTypes()

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

Returns:

the includedTypes - Only types specified here will be used within the index. Types not specified will not be indexed. Attribute created via the IndexTypeRelation relation.

getIndexedDataFactoryClassName

@Accessor(qualifier="indexedDataFactoryClassName",
          type=GETTER)
public java.lang.String getIndexedDataFactoryClassName()

Generated method - Getter of the IndexConfiguration.indexedDataFactoryClassName attribute defined at extension lucenesearch.

Returns:

the indexedDataFactoryClassName - Optionally, you can specify an IndexedDataFactory Uses the DefaultIndexedDataFactory by default.

getIndexedDataParams

@Accessor(qualifier="indexedDataParams",
          type=GETTER)
public java.lang.String getIndexedDataParams()

Generated method - Getter of the IndexConfiguration.indexedDataParams attribute defined at extension lucenesearch.

Returns:

the indexedDataParams - Additional parameters which may be evaluated by the associated IndexedDataFactory.

getIndexedType

@Accessor(qualifier="indexedType",
          type=GETTER)
public ComposedTypeModel getIndexedType()

Generated method - Getter of the IndexConfiguration.indexedType attribute defined at extension lucenesearch.

Returns:

the indexedType - The item type whose instances will be indexed. Initial attribute, cannot be edited after the IndexConfiguration has been created.

getLuceneIndex

@Accessor(qualifier="luceneIndex",
          type=GETTER)
public LuceneIndexModel getLuceneIndex()

Generated method - Getter of the IndexConfiguration.luceneIndex attribute defined at extension lucenesearch.

Returns:

the luceneIndex - The LuceneIndex to which this IndexConfiguration belongs.

getPendingUpdates

@Accessor(qualifier="pendingUpdates",
          type=GETTER)
public java.util.Collection<IndexUpdateModel> getPendingUpdates()

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

Returns:

the pendingUpdates - A collection of all IndexUpdate objects that refer to objects of the given type which currently exist and which have to be updated. Jalo-only attribute. Entries are retrieved via a FlexibleSearch statement.

setActivationAttribute

@Accessor(qualifier="activationAttribute",
          type=SETTER)
public void setActivationAttribute(AttributeDescriptorModel value)

Generated method - Setter of IndexConfiguration.activationAttribute attribute defined at extension lucenesearch.

Parameters:

value - the activationAttribute - Optional descriptor of boolean attribute. Instances must have the value true in this attribute to be indexed. Is limited to the values of the availableActivationAttributes attribute.

setAttributeConfigurations

@Accessor(qualifier="attributeConfigurations",
          type=SETTER)
public void setAttributeConfigurations(java.util.Collection<AttributeConfigurationModel> value)

Generated method - Setter of IndexConfiguration.attributeConfigurations attribute defined at extension lucenesearch.

Parameters:

value - the attributeConfigurations - All AttributeConfiguration objects that belong to this IndexConfiguration. Jalo-only attribute.

setGroupingAttribute

@Accessor(qualifier="groupingAttribute",
          type=SETTER)
public void setGroupingAttribute(AttributeDescriptorModel value)

Generated method - Setter of IndexConfiguration.groupingAttribute attribute defined at extension lucenesearch.

Parameters:

value - the groupingAttribute - Optional descriptor of an attribute that puts the indexed item into one or more groups; see the documentation of LucenesearchManager for a description of grouping. Is limited to the values of the availableGroupingAttributes attribute.

setIncludedTypes

@Accessor(qualifier="includedTypes",
          type=SETTER)
public void setIncludedTypes(java.util.Collection<ComposedTypeModel> value)

Generated method - Setter of IndexConfiguration.includedTypes attribute defined at extension lucenesearch.

Parameters:

value - the includedTypes - Only types specified here will be used within the index. Types not specified will not be indexed. Attribute created via the IndexTypeRelation relation.

setIndexedDataFactoryClassName

@Accessor(qualifier="indexedDataFactoryClassName",
          type=SETTER)
public void setIndexedDataFactoryClassName(java.lang.String value)

Generated method - Setter of IndexConfiguration.indexedDataFactoryClassName attribute defined at extension lucenesearch.

Parameters:

value - the indexedDataFactoryClassName - Optionally, you can specify an IndexedDataFactory Uses the DefaultIndexedDataFactory by default.

setIndexedDataParams

@Accessor(qualifier="indexedDataParams",
          type=SETTER)
public void setIndexedDataParams(java.lang.String value)

Generated method - Setter of IndexConfiguration.indexedDataParams attribute defined at extension lucenesearch.

Parameters:

value - the indexedDataParams - Additional parameters which may be evaluated by the associated IndexedDataFactory.

setIndexedType

@Accessor(qualifier="indexedType",
          type=SETTER)
public void setIndexedType(ComposedTypeModel value)

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

Parameters:

value - the indexedType - The item type whose instances will be indexed. Initial attribute, cannot be edited after the IndexConfiguration has been created.

setLuceneIndex

@Accessor(qualifier="luceneIndex",
          type=SETTER)
public void setLuceneIndex(LuceneIndexModel value)

Generated method - Setter of IndexConfiguration.luceneIndex attribute defined at extension lucenesearch.

Parameters:

value - the luceneIndex - The LuceneIndex to which this IndexConfiguration belongs.

setPendingUpdates

@Accessor(qualifier="pendingUpdates",
          type=SETTER)
public void setPendingUpdates(java.util.Collection<IndexUpdateModel> value)

Generated method - Setter of IndexConfiguration.pendingUpdates attribute defined at extension lucenesearch.

Parameters:

value - the pendingUpdates - A collection of all IndexUpdate objects that refer to objects of the given type which currently exist and which have to be updated. Jalo-only attribute. Entries are retrieved via a FlexibleSearch statement.