de.hybris.platform.lucenesearch.jalo

Class GeneratedIndexConfiguration

java.lang.Object

de.hybris.platform.util.BridgeAbstraction

de.hybris.platform.jalo.Item

de.hybris.platform.jalo.ExtensibleItem

de.hybris.platform.jalo.c2l.LocalizableItem

de.hybris.platform.jalo.GenericItem

de.hybris.platform.lucenesearch.jalo.GeneratedAbstractLuceneItem

de.hybris.platform.lucenesearch.jalo.AbstractLuceneItem

de.hybris.platform.lucenesearch.jalo.GeneratedIndexConfiguration

All Implemented Interfaces:

Serializable, Comparable

Direct Known Subclasses:

IndexConfiguration

public abstract class GeneratedIndexConfiguration
extends AbstractLuceneItem

Generated class for type IndexConfiguration.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.jalo.GenericItem

GenericItem.GenericItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LocalizableItem.LocalizableItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.ExtensibleItem

ExtensibleItem.ExtensibleItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.Item

Item.AttributeFilter, Item.AttributeMode, Item.CachedGetter, Item.CachedSetter, Item.ItemAttributeMap, Item.ItemConstraint, Item.ItemImpl, Item.JaloCachedComputationException

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIVATIONATTRIBUTE Qualifier of the IndexConfiguration.activationAttribute attribute
static String	ALLAVAILABLEATTRIBUTES Qualifier of the IndexConfiguration.allAvailableAttributes attribute
static String	ATTRIBUTECONFIGURATIONS Qualifier of the IndexConfiguration.attributeConfigurations attribute
static String	AVAILABLEACTIVATIONATTRIBUTES Qualifier of the IndexConfiguration.availableActivationAttributes attribute
static String	AVAILABLEGROUPINGATTRIBUTES Qualifier of the IndexConfiguration.availableGroupingAttributes attribute
static String	AVAILABLEINDEXABLEATTRIBUTES Qualifier of the IndexConfiguration.availableIndexableAttributes attribute
protected static Map<String,Item.AttributeMode>	DEFAULT_INITIAL_ATTRIBUTES
static String	GROUPINGATTRIBUTE Qualifier of the IndexConfiguration.groupingAttribute attribute
static String	INCLUDEDTYPES Qualifier of the IndexConfiguration.includedTypes attribute
static String	INDEXEDDATAFACTORYCLASSNAME Qualifier of the IndexConfiguration.indexedDataFactoryClassName attribute
static String	INDEXEDDATAPARAMS Qualifier of the IndexConfiguration.indexedDataParams attribute
static String	INDEXEDTYPE Qualifier of the IndexConfiguration.indexedType attribute
protected static String	INDEXTYPERELATION_MARKMODIFIED Relation disable markmodifed parameter constants for IndexTypeRelation from ((lucenesearch))
protected static String	INDEXTYPERELATION_SRC_ORDERED Relation ordering override parameter constants for IndexTypeRelation from ((lucenesearch))
protected static String	INDEXTYPERELATION_TGT_ORDERED
static String	LUCENEINDEX Qualifier of the IndexConfiguration.luceneIndex attribute
static String	PENDINGUPDATES Qualifier of the IndexConfiguration.pendingUpdates attribute

Fields inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LANGUAGE_FALLBACK_ENABLED

Fields inherited from class de.hybris.platform.jalo.Item

_CREATION_TIME_INTERNAL, _MODIFIED_TIME_INTERNAL, accessorLog, CREATION_TIME, DISABLE_ATTRIBUTE_CHECK, DISABLE_ITEMCHECK_BEFORE_REMOVABLE, EVEN, FEATURE_ACCESSMAP_QUALIFIER, INITIAL_CREATION_FLAG, isJaloOnly, MODIFIED_TIME, NEGATIVE, NOT_FOUND, OWNER, PK, POSITIVE, SAVE_FROM_SERVICE_LAYER, staticTransientObjects, TYPE

Fields inherited from class de.hybris.platform.util.BridgeAbstraction

impl, tenant

Constructor Summary

Constructors

Constructor and Description
GeneratedIndexConfiguration()

Method Summary

Modifier and Type	Method and Description
void	addToIncludedTypes(ComposedType value) Generated method - Adds value to includedTypes.
void	addToIncludedTypes(SessionContext ctx, ComposedType value) Generated method - Adds value to includedTypes.
AttributeDescriptor	getActivationAttribute() Generated method - Getter of the IndexConfiguration.activationAttribute attribute.
AttributeDescriptor	getActivationAttribute(SessionContext ctx) Generated method - Getter of the IndexConfiguration.activationAttribute attribute.
Collection<AttributeDescriptor>	getAllAvailableAttributes() Generated method - Getter of the IndexConfiguration.allAvailableAttributes attribute.
abstract Collection<AttributeDescriptor>	getAllAvailableAttributes(SessionContext ctx) Generated method - Getter of the IndexConfiguration.allAvailableAttributes attribute.
Collection<AttributeConfiguration>	getAttributeConfigurations() Generated method - Getter of the IndexConfiguration.attributeConfigurations attribute.
abstract Collection<AttributeConfiguration>	getAttributeConfigurations(SessionContext ctx) Generated method - Getter of the IndexConfiguration.attributeConfigurations attribute.
Collection<AttributeDescriptor>	getAvailableActivationAttributes() Generated method - Getter of the IndexConfiguration.availableActivationAttributes attribute.
abstract Collection<AttributeDescriptor>	getAvailableActivationAttributes(SessionContext ctx) Generated method - Getter of the IndexConfiguration.availableActivationAttributes attribute.
Collection<AttributeDescriptor>	getAvailableGroupingAttributes() Generated method - Getter of the IndexConfiguration.availableGroupingAttributes attribute.
abstract Collection<AttributeDescriptor>	getAvailableGroupingAttributes(SessionContext ctx) Generated method - Getter of the IndexConfiguration.availableGroupingAttributes attribute.
Collection<AttributeDescriptor>	getAvailableIndexableAttributes() Generated method - Getter of the IndexConfiguration.availableIndexableAttributes attribute.
abstract Collection<AttributeDescriptor>	getAvailableIndexableAttributes(SessionContext ctx) Generated method - Getter of the IndexConfiguration.availableIndexableAttributes attribute.
protected Map<String,Item.AttributeMode>	getDefaultAttributeModes()
AttributeDescriptor	getGroupingAttribute() Generated method - Getter of the IndexConfiguration.groupingAttribute attribute.
AttributeDescriptor	getGroupingAttribute(SessionContext ctx) Generated method - Getter of the IndexConfiguration.groupingAttribute attribute.
Collection<ComposedType>	getIncludedTypes() Generated method - Getter of the IndexConfiguration.includedTypes attribute.
Collection<ComposedType>	getIncludedTypes(SessionContext ctx) Generated method - Getter of the IndexConfiguration.includedTypes attribute.
long	getIncludedTypesCount()
long	getIncludedTypesCount(SessionContext ctx)
String	getIndexedDataFactoryClassName() Generated method - Getter of the IndexConfiguration.indexedDataFactoryClassName attribute.
String	getIndexedDataFactoryClassName(SessionContext ctx) Generated method - Getter of the IndexConfiguration.indexedDataFactoryClassName attribute.
String	getIndexedDataParams() Generated method - Getter of the IndexConfiguration.indexedDataParams attribute.
String	getIndexedDataParams(SessionContext ctx) Generated method - Getter of the IndexConfiguration.indexedDataParams attribute.
ComposedType	getIndexedType() Generated method - Getter of the IndexConfiguration.indexedType attribute.
ComposedType	getIndexedType(SessionContext ctx) Generated method - Getter of the IndexConfiguration.indexedType attribute.
LuceneIndex	getLuceneIndex() Generated method - Getter of the IndexConfiguration.luceneIndex attribute.
LuceneIndex	getLuceneIndex(SessionContext ctx) Generated method - Getter of the IndexConfiguration.luceneIndex attribute.
Collection<IndexUpdate>	getPendingUpdates() Generated method - Getter of the IndexConfiguration.pendingUpdates attribute.
abstract Collection<IndexUpdate>	getPendingUpdates(SessionContext ctx) Generated method - Getter of the IndexConfiguration.pendingUpdates attribute.
void	removeFromIncludedTypes(ComposedType value) Generated method - Removes value from includedTypes.
void	removeFromIncludedTypes(SessionContext ctx, ComposedType value) Generated method - Removes value from includedTypes.
void	setActivationAttribute(AttributeDescriptor value) Generated method - Setter of the IndexConfiguration.activationAttribute attribute.
void	setActivationAttribute(SessionContext ctx, AttributeDescriptor value) Generated method - Setter of the IndexConfiguration.activationAttribute attribute.
void	setAttributeConfigurations(Collection<AttributeConfiguration> value) Generated method - Setter of the IndexConfiguration.attributeConfigurations attribute.
abstract void	setAttributeConfigurations(SessionContext ctx, Collection<AttributeConfiguration> value) Generated method - Setter of the IndexConfiguration.attributeConfigurations attribute.
void	setGroupingAttribute(AttributeDescriptor value) Generated method - Setter of the IndexConfiguration.groupingAttribute attribute.
void	setGroupingAttribute(SessionContext ctx, AttributeDescriptor value) Generated method - Setter of the IndexConfiguration.groupingAttribute attribute.
void	setIncludedTypes(Collection<ComposedType> value) Generated method - Setter of the IndexConfiguration.includedTypes attribute.
void	setIncludedTypes(SessionContext ctx, Collection<ComposedType> value) Generated method - Setter of the IndexConfiguration.includedTypes attribute.
void	setIndexedDataFactoryClassName(SessionContext ctx, String value) Generated method - Setter of the IndexConfiguration.indexedDataFactoryClassName attribute.
void	setIndexedDataFactoryClassName(String value) Generated method - Setter of the IndexConfiguration.indexedDataFactoryClassName attribute.
void	setIndexedDataParams(SessionContext ctx, String value) Generated method - Setter of the IndexConfiguration.indexedDataParams attribute.
void	setIndexedDataParams(String value) Generated method - Setter of the IndexConfiguration.indexedDataParams attribute.
protected void	setIndexedType(ComposedType value) Generated method - Setter of the IndexConfiguration.indexedType attribute.
protected void	setIndexedType(SessionContext ctx, ComposedType value) Generated method - Setter of the IndexConfiguration.indexedType attribute.
void	setLuceneIndex(LuceneIndex value) Generated method - Setter of the IndexConfiguration.luceneIndex attribute.
void	setLuceneIndex(SessionContext ctx, LuceneIndex value) Generated method - Setter of the IndexConfiguration.luceneIndex attribute.
void	setPendingUpdates(Collection<IndexUpdate> value) Generated method - Setter of the IndexConfiguration.pendingUpdates attribute.
abstract void	setPendingUpdates(SessionContext ctx, Collection<IndexUpdate> value) Generated method - Setter of the IndexConfiguration.pendingUpdates attribute.

Methods inherited from class de.hybris.platform.jalo.GenericItem

createItem, getInitialProperties, getNonInitialAttributes

Methods inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllValuesSessionContext, getLocalizedProperty, getLocalizedProperty, getLocalizedPropertyInternal, getLocalizedPropertyNames, getLocalizedPropertyNames, hasLanguage, isEmptyValue, isFallbackEnabled, removeLocalizedProperty, removeLocalizedProperty, setAllLocalizedProperties, setAllLocalizedProperties, setLocalizedProperty, setLocalizedProperty

Methods inherited from class de.hybris.platform.jalo.ExtensibleItem

createNonClassAccessor, getAllProperties, getAllProperties, getProperty, getProperty, getPropertyNames, getPropertyNames, removeProperty, removeProperty, setAllProperties, setAllProperties, setProperty, setProperty

Methods inherited from class de.hybris.platform.jalo.Item

addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addNegativePermission, addPermission, addPositivePermission, assureExtensionsLoaded, changeTypeAfterCreation, checkConstraint, checkItemPermission, checkMandatoryAttribute, checkMandatoryAttribute, checkPermission, checkPermission, checkRemovable, clearPermission, compareTo, ctx, doAfterRemove, doBeforeRemove, equals, getAccessorFor, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributesInternal, getAllLinkedItems, getAndCheckCacheBoundItem, getAttribute, getAttribute, getCacheBoundItem, getComposedType, getComposedTypePK, getCreationTime, getCurrentlyRemovingCount, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItemsCount, getLinkedItemsCount, getLinkedItemsCount, getModificationTime, getNegativePermissions, getOwner, getPermissionMap, getPermissions, getPersistenceVersion, getPK, getPositivePermissions, getRestrictedPrincipals, getSession, getSyncObject, getTenant, getTransientObject, getTransientObjectMap, hashCode, hasRegisteredClassAccessorFor, internal_registerClassAccessorFor, internal_registerNonClassAccessorFor, invalidateLocalCaches, isAlive, isCacheBound, isCurrentlyRemoving, isCurrentlyRemoving, isEmptyRelationValue, isInCreate, isInstanceOf, isItemCheckBeforeRemoveableDisabled, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, readResolve, refreshRemote, registerAccessFor, registerAccessFor, registerJaloInvalidationListeners, remove, remove, removeItemCollection, removeItemCollection, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinks, removePartOfItems, removePartOfItems, setAllAttributes, setAllAttributes, setAllAttributesInternal, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAttribute, setAttribute, setAttributeFromString, setAttributeFromString, setCacheBound, setComposedType, setCreationTime, setImplementation, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setModificationTime, setNonInitialAttributes, setOwner, setPermissionsByMap, setTransientObject, setUseTA, toString, useTA, writeReplace

Methods inherited from class de.hybris.platform.util.BridgeAbstraction

getImplementation, setTenant

Methods inherited from class java.lang.Object

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

Field Detail

ACTIVATIONATTRIBUTE

public static final String ACTIVATIONATTRIBUTE

Qualifier of the IndexConfiguration.activationAttribute attribute

See Also:

Constant Field Values

ALLAVAILABLEATTRIBUTES

public static final String ALLAVAILABLEATTRIBUTES

Qualifier of the IndexConfiguration.allAvailableAttributes attribute

See Also:

Constant Field Values

ATTRIBUTECONFIGURATIONS

public static final String ATTRIBUTECONFIGURATIONS

Qualifier of the IndexConfiguration.attributeConfigurations attribute

See Also:

Constant Field Values

AVAILABLEACTIVATIONATTRIBUTES

public static final String AVAILABLEACTIVATIONATTRIBUTES

Qualifier of the IndexConfiguration.availableActivationAttributes attribute

See Also:

Constant Field Values

AVAILABLEGROUPINGATTRIBUTES

public static final String AVAILABLEGROUPINGATTRIBUTES

Qualifier of the IndexConfiguration.availableGroupingAttributes attribute

See Also:

Constant Field Values

AVAILABLEINDEXABLEATTRIBUTES

public static final String AVAILABLEINDEXABLEATTRIBUTES

Qualifier of the IndexConfiguration.availableIndexableAttributes attribute

See Also:

Constant Field Values

GROUPINGATTRIBUTE

public static final String GROUPINGATTRIBUTE

Qualifier of the IndexConfiguration.groupingAttribute attribute

See Also:

Constant Field Values

INDEXEDDATAFACTORYCLASSNAME

public static final String INDEXEDDATAFACTORYCLASSNAME

Qualifier of the IndexConfiguration.indexedDataFactoryClassName attribute

See Also:

Constant Field Values

INDEXEDDATAPARAMS

public static final String INDEXEDDATAPARAMS

Qualifier of the IndexConfiguration.indexedDataParams attribute

See Also:

Constant Field Values

INDEXEDTYPE

public static final String INDEXEDTYPE

Qualifier of the IndexConfiguration.indexedType attribute

See Also:

Constant Field Values

LUCENEINDEX

public static final String LUCENEINDEX

Qualifier of the IndexConfiguration.luceneIndex attribute

See Also:

Constant Field Values

PENDINGUPDATES

public static final String PENDINGUPDATES

Qualifier of the IndexConfiguration.pendingUpdates attribute

See Also:

Constant Field Values

INCLUDEDTYPES

public static final String INCLUDEDTYPES

Qualifier of the IndexConfiguration.includedTypes attribute

See Also:

Constant Field Values

INDEXTYPERELATION_SRC_ORDERED

protected static String INDEXTYPERELATION_SRC_ORDERED

Relation ordering override parameter constants for IndexTypeRelation from ((lucenesearch))

INDEXTYPERELATION_TGT_ORDERED

protected static String INDEXTYPERELATION_TGT_ORDERED

INDEXTYPERELATION_MARKMODIFIED

protected static String INDEXTYPERELATION_MARKMODIFIED

Relation disable markmodifed parameter constants for IndexTypeRelation from ((lucenesearch))

DEFAULT_INITIAL_ATTRIBUTES

protected static final Map<String,Item.AttributeMode> DEFAULT_INITIAL_ATTRIBUTES

Constructor Detail

GeneratedIndexConfiguration

public GeneratedIndexConfiguration()

Method Detail

getDefaultAttributeModes

protected Map<String,Item.AttributeMode> getDefaultAttributeModes()

Overrides:

getDefaultAttributeModes in class GeneratedAbstractLuceneItem

getActivationAttribute

public AttributeDescriptor getActivationAttribute(SessionContext ctx)

Generated method - Getter of the IndexConfiguration.activationAttribute attribute.

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.

getActivationAttribute

public AttributeDescriptor getActivationAttribute()

Generated method - Getter of the IndexConfiguration.activationAttribute attribute.

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.

setActivationAttribute

public void setActivationAttribute(SessionContext ctx,
                                   AttributeDescriptor value)

Generated method - Setter of the IndexConfiguration.activationAttribute attribute.

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.

setActivationAttribute

public void setActivationAttribute(AttributeDescriptor value)

Generated method - Setter of the IndexConfiguration.activationAttribute attribute.

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.

getAllAvailableAttributes

public abstract Collection<AttributeDescriptor> getAllAvailableAttributes(SessionContext ctx)

Generated method - Getter of the IndexConfiguration.allAvailableAttributes attribute.

Returns:

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

getAllAvailableAttributes

public Collection<AttributeDescriptor> getAllAvailableAttributes()

Generated method - Getter of the IndexConfiguration.allAvailableAttributes attribute.

Returns:

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

getAttributeConfigurations

public abstract Collection<AttributeConfiguration> getAttributeConfigurations(SessionContext ctx)

Generated method - Getter of the IndexConfiguration.attributeConfigurations attribute.

Returns:

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

getAttributeConfigurations

public Collection<AttributeConfiguration> getAttributeConfigurations()

Generated method - Getter of the IndexConfiguration.attributeConfigurations attribute.

Returns:

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

setAttributeConfigurations

public abstract void setAttributeConfigurations(SessionContext ctx,
                                                Collection<AttributeConfiguration> value)

Generated method - Setter of the IndexConfiguration.attributeConfigurations attribute.

Parameters:

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

setAttributeConfigurations

public void setAttributeConfigurations(Collection<AttributeConfiguration> value)

Generated method - Setter of the IndexConfiguration.attributeConfigurations attribute.

Parameters:

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

getAvailableActivationAttributes

public abstract Collection<AttributeDescriptor> getAvailableActivationAttributes(SessionContext ctx)

Generated method - Getter of the IndexConfiguration.availableActivationAttributes attribute.

Returns:

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

getAvailableActivationAttributes

public Collection<AttributeDescriptor> getAvailableActivationAttributes()

Generated method - Getter of the IndexConfiguration.availableActivationAttributes attribute.

Returns:

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

getAvailableGroupingAttributes

public abstract Collection<AttributeDescriptor> getAvailableGroupingAttributes(SessionContext ctx)

Generated method - Getter of the IndexConfiguration.availableGroupingAttributes attribute.

Returns:

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

getAvailableGroupingAttributes

public Collection<AttributeDescriptor> getAvailableGroupingAttributes()

Generated method - Getter of the IndexConfiguration.availableGroupingAttributes attribute.

Returns:

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

getAvailableIndexableAttributes

public abstract Collection<AttributeDescriptor> getAvailableIndexableAttributes(SessionContext ctx)

Generated method - Getter of the IndexConfiguration.availableIndexableAttributes attribute.

Returns:

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

getAvailableIndexableAttributes

public Collection<AttributeDescriptor> getAvailableIndexableAttributes()

Generated method - Getter of the IndexConfiguration.availableIndexableAttributes attribute.

Returns:

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

getGroupingAttribute

public AttributeDescriptor getGroupingAttribute(SessionContext ctx)

Generated method - Getter of the IndexConfiguration.groupingAttribute attribute.

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.

getGroupingAttribute

public AttributeDescriptor getGroupingAttribute()

Generated method - Getter of the IndexConfiguration.groupingAttribute attribute.

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.

setGroupingAttribute

public void setGroupingAttribute(SessionContext ctx,
                                 AttributeDescriptor value)

Generated method - Setter of the IndexConfiguration.groupingAttribute attribute.

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.

setGroupingAttribute

public void setGroupingAttribute(AttributeDescriptor value)

Generated method - Setter of the IndexConfiguration.groupingAttribute attribute.

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.

getIncludedTypes

public Collection<ComposedType> getIncludedTypes(SessionContext ctx)

Generated method - Getter of the IndexConfiguration.includedTypes attribute.

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.

getIncludedTypes

public Collection<ComposedType> getIncludedTypes()

Generated method - Getter of the IndexConfiguration.includedTypes attribute.

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.

getIncludedTypesCount

public long getIncludedTypesCount(SessionContext ctx)

getIncludedTypesCount

public long getIncludedTypesCount()

setIncludedTypes

public void setIncludedTypes(SessionContext ctx,
                             Collection<ComposedType> value)

Generated method - Setter of the IndexConfiguration.includedTypes attribute.

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.

setIncludedTypes

public void setIncludedTypes(Collection<ComposedType> value)

Generated method - Setter of the IndexConfiguration.includedTypes attribute.

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.

addToIncludedTypes

public void addToIncludedTypes(SessionContext ctx,
                               ComposedType value)

Generated method - Adds value to includedTypes.

Parameters:

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

addToIncludedTypes

public void addToIncludedTypes(ComposedType value)

Generated method - Adds value to includedTypes.

Parameters:

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

removeFromIncludedTypes

public void removeFromIncludedTypes(SessionContext ctx,
                                    ComposedType value)

Generated method - Removes value from includedTypes.

Parameters:

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

removeFromIncludedTypes

public void removeFromIncludedTypes(ComposedType value)

Generated method - Removes value from includedTypes.

Parameters:

value - the item to remove from 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

public String getIndexedDataFactoryClassName(SessionContext ctx)

Generated method - Getter of the IndexConfiguration.indexedDataFactoryClassName attribute.

Returns:

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

getIndexedDataFactoryClassName

public String getIndexedDataFactoryClassName()

Generated method - Getter of the IndexConfiguration.indexedDataFactoryClassName attribute.

Returns:

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

setIndexedDataFactoryClassName

public void setIndexedDataFactoryClassName(SessionContext ctx,
                                           String value)

Generated method - Setter of the IndexConfiguration.indexedDataFactoryClassName attribute.

Parameters:

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

setIndexedDataFactoryClassName

public void setIndexedDataFactoryClassName(String value)

Generated method - Setter of the IndexConfiguration.indexedDataFactoryClassName attribute.

Parameters:

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

getIndexedDataParams

public String getIndexedDataParams(SessionContext ctx)

Generated method - Getter of the IndexConfiguration.indexedDataParams attribute.

Returns:

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

getIndexedDataParams

public String getIndexedDataParams()

Generated method - Getter of the IndexConfiguration.indexedDataParams attribute.

Returns:

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

setIndexedDataParams

public void setIndexedDataParams(SessionContext ctx,
                                 String value)

Generated method - Setter of the IndexConfiguration.indexedDataParams attribute.

Parameters:

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

setIndexedDataParams

public void setIndexedDataParams(String value)

Generated method - Setter of the IndexConfiguration.indexedDataParams attribute.

Parameters:

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

getIndexedType

public ComposedType getIndexedType(SessionContext ctx)

Generated method - Getter of the IndexConfiguration.indexedType attribute.

Returns:

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

getIndexedType

public ComposedType getIndexedType()

Generated method - Getter of the IndexConfiguration.indexedType attribute.

Returns:

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

setIndexedType

protected void setIndexedType(SessionContext ctx,
                              ComposedType value)

Generated method - Setter of the IndexConfiguration.indexedType attribute.

Parameters:

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

setIndexedType

protected void setIndexedType(ComposedType value)

Generated method - Setter of the IndexConfiguration.indexedType attribute.

Parameters:

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

getLuceneIndex

public LuceneIndex getLuceneIndex(SessionContext ctx)

Generated method - Getter of the IndexConfiguration.luceneIndex attribute.

Returns:

the luceneIndex - The LuceneIndex to which this IndexConfiguration belongs.

getLuceneIndex

public LuceneIndex getLuceneIndex()

Generated method - Getter of the IndexConfiguration.luceneIndex attribute.

Returns:

the luceneIndex - The LuceneIndex to which this IndexConfiguration belongs.

setLuceneIndex

public void setLuceneIndex(SessionContext ctx,
                           LuceneIndex value)

Generated method - Setter of the IndexConfiguration.luceneIndex attribute.

Parameters:

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

setLuceneIndex

public void setLuceneIndex(LuceneIndex value)

Generated method - Setter of the IndexConfiguration.luceneIndex attribute.

Parameters:

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

getPendingUpdates

public abstract Collection<IndexUpdate> getPendingUpdates(SessionContext ctx)

Generated method - Getter of the IndexConfiguration.pendingUpdates attribute.

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.

getPendingUpdates

public Collection<IndexUpdate> getPendingUpdates()

Generated method - Getter of the IndexConfiguration.pendingUpdates attribute.

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.

setPendingUpdates

public abstract void setPendingUpdates(SessionContext ctx,
                                       Collection<IndexUpdate> value)

Generated method - Setter of the IndexConfiguration.pendingUpdates attribute.

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.

setPendingUpdates

public void setPendingUpdates(Collection<IndexUpdate> value)

Generated method - Setter of the IndexConfiguration.pendingUpdates attribute.

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.