de.hybris.platform.solrfacetsearch.hmc

Class SolrIndexerHotUpdateWizard

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.hmc.jalo.GeneratedWizardBusinessItem

de.hybris.platform.hmc.jalo.WizardBusinessItem

de.hybris.platform.solrfacetsearch.hmc.GeneratedSolrIndexerHotUpdateWizard

de.hybris.platform.solrfacetsearch.hmc.SolrIndexerHotUpdateWizard

All Implemented Interfaces:

JaloOnlyItem, Serializable, Comparable

public class SolrIndexerHotUpdateWizard
extends GeneratedSolrIndexerHotUpdateWizard

See Also:

Serialized Form

Nested Class Summary

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 inherited from class de.hybris.platform.solrfacetsearch.hmc.GeneratedSolrIndexerHotUpdateWizard

COMPOSEDTYPEATTRIBUTE, INDEXTYPE, ITEMSTOINDEX, ITEMSTOINDEXDESCRIPTION, POSSIBLEINDEXTYPES, SOLRFACETSEARCHCONFIG, UPDATEOPERATION

Fields inherited from class de.hybris.platform.hmc.jalo.WizardBusinessItem

BACK_BUTTON, BACK_BUTTON_NAME, CANCEL_BUTTON, CANCEL_BUTTON_NAME, CLOSE_BUTTON_NAME, DONE_BUTTON_NAME, NEXT_BUTTON, NEXT_BUTTON_NAME, START_BUTTON, START_BUTTON_NAME

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
SolrIndexerHotUpdateWizard()

Method Summary

Modifier and Type	Method and Description
protected void	cleanUpPossibleIndexValues()
protected Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) Returns a new wizard instance.
protected Collection<ComposedIndexedType>	getComposedIndexTypes(Collection<IndexedType> indexedTypes)
ComposedType	getComposedTypeAttribute(SessionContext ctx) Generated method - Getter of the SolrIndexerHotUpdateWizard.composedTypeAttribute attribute.
protected ComposedType	getComposedTypeByCode(String code)
protected FacetSearchConfigService	getConfigService()
ComposedIndexedType	getIndexType(SessionContext ctx) Generated method - Getter of the SolrIndexerHotUpdateWizard.indexType attribute.
Collection<Item>	getItemsToIndex(SessionContext ctx) Generated method - Getter of the SolrIndexerHotUpdateWizard.itemsToIndex attribute.
String	getItemsToIndexDescription(SessionContext ctx) Generated method - Getter of the SolrIndexerHotUpdateWizard.itemsToIndexDescription attribute.
protected SolrfacetsearchManager	getManager()
Collection<ComposedIndexedType>	getPossibleIndexTypes(SessionContext ctx) Generated method - Getter of the SolrIndexerHotUpdateWizard.possibleIndexTypes attribute.
SolrFacetSearchConfig	getSolrFacetSearchConfig(SessionContext ctx) Generated method - Getter of the SolrIndexerHotUpdateWizard.solrFacetSearchConfig attribute.
protected SolrIndexerHotUpdateCronJob	getSolrIndexerHotUpdateJob()
protected TypeManager	getTypeManager()
void	initialize(WizardEditorContext ctx) Called to initialize the wizard immediately after the item editor creates the WizardEditorContext.
protected void	initializeConfigData(WizardEditorContext ctx)
protected void	initializeIndexTypeData(WizardEditorContext ctx)
Boolean	isUpdateOperation(SessionContext ctx) Generated method - Getter of the SolrIndexerHotUpdateWizard.updateOperation attribute.
void	pollStatus(WizardEditorContext ctx) Called during processing mode every time the wizards refreshes its status information.
void	setComposedTypeAttribute(SessionContext ctx, ComposedType value) Generated method - Setter of the SolrIndexerHotUpdateWizard.composedTypeAttribute attribute.
void	setIndexType(SessionContext ctx, ComposedIndexedType value) Generated method - Setter of the SolrIndexerHotUpdateWizard.indexType attribute.
void	setItemsToIndex(SessionContext ctx, Collection<Item> items) Generated method - Setter of the SolrIndexerHotUpdateWizard.itemsToIndex attribute.
void	setItemsToIndexDescription(SessionContext ctx, String value) Generated method - Setter of the SolrIndexerHotUpdateWizard.itemsToIndexDescription attribute.
void	setPossibleIndexTypes(SessionContext ctx, Collection<ComposedIndexedType> value) Generated method - Setter of the SolrIndexerHotUpdateWizard.possibleIndexTypes attribute.
void	setSolrFacetSearchConfig(SessionContext ctx, SolrFacetSearchConfig value) Generated method - Setter of the SolrIndexerHotUpdateWizard.solrFacetSearchConfig attribute.
void	setUpdateOperation(SessionContext ctx, Boolean value) Generated method - Setter of the SolrIndexerHotUpdateWizard.updateOperation attribute.
void	start(WizardEditorContext ctx) Called if the user requests the wizard to start its actions.
void	tabChanges(WizardEditorContext ctx, String fromTabName, String toTabName) Called before the current tab is changed.
void	validate(WizardEditorContext ctx, String fromTab, String toTab) Called before tab is changed start event delivered or if validation was explicitely requested.

Methods inherited from class de.hybris.platform.solrfacetsearch.hmc.GeneratedSolrIndexerHotUpdateWizard

getComposedTypeAttribute, getIndexType, getItemsToIndex, getItemsToIndexDescription, getPossibleIndexTypes, getSolrFacetSearchConfig, isUpdateOperation, isUpdateOperationAsPrimitive, isUpdateOperationAsPrimitive, setComposedTypeAttribute, setIndexType, setItemsToIndex, setItemsToIndexDescription, setPossibleIndexTypes, setSolrFacetSearchConfig, setUpdateOperation, setUpdateOperation, setUpdateOperation

Methods inherited from class de.hybris.platform.hmc.jalo.WizardBusinessItem

abortProcessing, appendLocalizedTemplateString, close, doGetAttribute, doSetAttribute, endProcessing, getLocalizedTemplateString, isCloseAllowed, provideComposedType, provideCreationTime, provideModificationTime, providePK, removeJaloOnly, setClosedAllowed, startProcessing, validate

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, getDefaultAttributeModes, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItemsCount, getLinkedItemsCount, getLinkedItemsCount, getModificationTime, getNegativePermissions, getNonInitialAttributes, 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

Constructor Detail

SolrIndexerHotUpdateWizard

public SolrIndexerHotUpdateWizard()

Method Detail

createItem

protected Item createItem(SessionContext ctx,
                          ComposedType type,
                          Item.ItemAttributeMap allAttributes)
                   throws JaloBusinessException

Description copied from class: WizardBusinessItem

Returns a new wizard instance.

Overrides:

createItem in class WizardBusinessItem

Parameters:

ctx - the current session context which this item is created within

type - the actual item type ( since subtypes may not provide a own jalo class this may be different from the type which this method was implemented for )

Returns:

the new item instance

Throws:

JaloBusinessException - indicates an error during creation - any changes will be rollbacked

initialize

public void initialize(WizardEditorContext ctx)

Description copied from class: WizardBusinessItem

Called to initialize the wizard immediately after the item editor creates the WizardEditorContext. Default implementation does nothing, you should override this method and implement appropriate init steps.

Overrides:

initialize in class WizardBusinessItem

Parameters:

ctx - the wizard editor context

start

public void start(WizardEditorContext ctx)
           throws VetoException

Description copied from class: WizardBusinessItem

Called if the user requests the wizard to start its actions. Validation is already done when this method is called.

Overrides:

start in class WizardBusinessItem

Parameters:

ctx - the wizard editor context

Throws:

VetoException - to signal that the wizard cannot be started right now

pollStatus

public void pollStatus(WizardEditorContext ctx)

Description copied from class: WizardBusinessItem

Called during processing mode every time the wizards refreshes its status information. Use WizardEditorContext.setStatus(String, int, boolean) to update the displayed status.

The method is called before the wizard is rendered. So changing the procesing mode here is allowed.

Overrides:

pollStatus in class WizardBusinessItem

Parameters:

ctx - the wizard editor context

tabChanges

public void tabChanges(WizardEditorContext ctx,
                       String fromTabName,
                       String toTabName)
                throws VetoException

Description copied from class: WizardBusinessItem

Called before the current tab is changed. If the current state should not allow the tab change a VetoException must be raised. In this case a error popup is shown.

Overrides:

tabChanges in class WizardBusinessItem

Parameters:

ctx - the wizard editor context

fromTabName - the current tab name

toTabName - the new tab name

Throws:

VetoException - to signal the tab cannot be changed right now

validate

public void validate(WizardEditorContext ctx,
                     String fromTab,
                     String toTab)
              throws ValidationException

Description copied from class: WizardBusinessItem

Called before

• tab is changed
• start event delivered
• or if validation was explicitely requested.

To check current input values use ItemEditorContext.getCurrentValue(String).

To signal an error a ValidationException must be raised. The actual event (tab change or start of this wizard) is not executed in this case but a error popup is shown.

Additionally erroneous fields may be marked via ItemEditorContext.showError(String, String).

Make sure that always super.validate is called !

Overrides:

validate in class WizardBusinessItem

Parameters:

ctx - the wizard editor context

fromTab - the tab which is being left

toTab - the new target tab

Throws:

ValidationException

getItemsToIndex

public Collection<Item> getItemsToIndex(SessionContext ctx)

Description copied from class: GeneratedSolrIndexerHotUpdateWizard

Generated method - Getter of the SolrIndexerHotUpdateWizard.itemsToIndex attribute.

Specified by:

getItemsToIndex in class GeneratedSolrIndexerHotUpdateWizard

Returns:

the itemsToIndex

setItemsToIndex

public void setItemsToIndex(SessionContext ctx,
                            Collection<Item> items)

Description copied from class: GeneratedSolrIndexerHotUpdateWizard

Generated method - Setter of the SolrIndexerHotUpdateWizard.itemsToIndex attribute.

Specified by:

setItemsToIndex in class GeneratedSolrIndexerHotUpdateWizard

items - the itemsToIndex

getPossibleIndexTypes

public Collection<ComposedIndexedType> getPossibleIndexTypes(SessionContext ctx)

Description copied from class: GeneratedSolrIndexerHotUpdateWizard

Generated method - Getter of the SolrIndexerHotUpdateWizard.possibleIndexTypes attribute.

Specified by:

getPossibleIndexTypes in class GeneratedSolrIndexerHotUpdateWizard

Returns:

the possibleIndexTypes

setPossibleIndexTypes

public void setPossibleIndexTypes(SessionContext ctx,
                                  Collection<ComposedIndexedType> value)

Description copied from class: GeneratedSolrIndexerHotUpdateWizard

Generated method - Setter of the SolrIndexerHotUpdateWizard.possibleIndexTypes attribute.

Specified by:

setPossibleIndexTypes in class GeneratedSolrIndexerHotUpdateWizard

value - the possibleIndexTypes

getSolrFacetSearchConfig

public SolrFacetSearchConfig getSolrFacetSearchConfig(SessionContext ctx)

Description copied from class: GeneratedSolrIndexerHotUpdateWizard

Generated method - Getter of the SolrIndexerHotUpdateWizard.solrFacetSearchConfig attribute.

Specified by:

getSolrFacetSearchConfig in class GeneratedSolrIndexerHotUpdateWizard

Returns:

the solrFacetSearchConfig

getIndexType

public ComposedIndexedType getIndexType(SessionContext ctx)

Description copied from class: GeneratedSolrIndexerHotUpdateWizard

Generated method - Getter of the SolrIndexerHotUpdateWizard.indexType attribute.

Specified by:

getIndexType in class GeneratedSolrIndexerHotUpdateWizard

Returns:

the indexType

setSolrFacetSearchConfig

public void setSolrFacetSearchConfig(SessionContext ctx,
                                     SolrFacetSearchConfig value)

Description copied from class: GeneratedSolrIndexerHotUpdateWizard

Generated method - Setter of the SolrIndexerHotUpdateWizard.solrFacetSearchConfig attribute.

Specified by:

setSolrFacetSearchConfig in class GeneratedSolrIndexerHotUpdateWizard

value - the solrFacetSearchConfig

setIndexType

public void setIndexType(SessionContext ctx,
                         ComposedIndexedType value)

Description copied from class: GeneratedSolrIndexerHotUpdateWizard

Generated method - Setter of the SolrIndexerHotUpdateWizard.indexType attribute.

Specified by:

setIndexType in class GeneratedSolrIndexerHotUpdateWizard

value - the indexType

getComposedTypeAttribute

public ComposedType getComposedTypeAttribute(SessionContext ctx)

Description copied from class: GeneratedSolrIndexerHotUpdateWizard

Generated method - Getter of the SolrIndexerHotUpdateWizard.composedTypeAttribute attribute.

Specified by:

getComposedTypeAttribute in class GeneratedSolrIndexerHotUpdateWizard

Returns:

the composedTypeAttribute

getItemsToIndexDescription

public String getItemsToIndexDescription(SessionContext ctx)

Description copied from class: GeneratedSolrIndexerHotUpdateWizard

Generated method - Getter of the SolrIndexerHotUpdateWizard.itemsToIndexDescription attribute.

Specified by:

getItemsToIndexDescription in class GeneratedSolrIndexerHotUpdateWizard

Returns:

the itemsToIndexDescription

setComposedTypeAttribute

public void setComposedTypeAttribute(SessionContext ctx,
                                     ComposedType value)

Description copied from class: GeneratedSolrIndexerHotUpdateWizard

Generated method - Setter of the SolrIndexerHotUpdateWizard.composedTypeAttribute attribute.

Specified by:

setComposedTypeAttribute in class GeneratedSolrIndexerHotUpdateWizard

value - the composedTypeAttribute

setItemsToIndexDescription

public void setItemsToIndexDescription(SessionContext ctx,
                                       String value)

Description copied from class: GeneratedSolrIndexerHotUpdateWizard

Generated method - Setter of the SolrIndexerHotUpdateWizard.itemsToIndexDescription attribute.

Specified by:

setItemsToIndexDescription in class GeneratedSolrIndexerHotUpdateWizard

value - the itemsToIndexDescription

initializeConfigData

protected void initializeConfigData(WizardEditorContext ctx)
                             throws ValidationException

Throws:

ValidationException

initializeIndexTypeData

protected void initializeIndexTypeData(WizardEditorContext ctx)
                                throws ValidationException

Throws:

ValidationException

cleanUpPossibleIndexValues

protected void cleanUpPossibleIndexValues()
                                   throws VetoException

Throws:

VetoException

getComposedIndexTypes

protected Collection<ComposedIndexedType> getComposedIndexTypes(Collection<IndexedType> indexedTypes)

getManager

protected SolrfacetsearchManager getManager()

getConfigService

protected FacetSearchConfigService getConfigService()

getTypeManager

protected TypeManager getTypeManager()

getComposedTypeByCode

protected ComposedType getComposedTypeByCode(String code)

getSolrIndexerHotUpdateJob

protected SolrIndexerHotUpdateCronJob getSolrIndexerHotUpdateJob()

isUpdateOperation

public Boolean isUpdateOperation(SessionContext ctx)

Description copied from class: GeneratedSolrIndexerHotUpdateWizard

Generated method - Getter of the SolrIndexerHotUpdateWizard.updateOperation attribute.

Specified by:

isUpdateOperation in class GeneratedSolrIndexerHotUpdateWizard

Returns:

the updateOperation

setUpdateOperation

public void setUpdateOperation(SessionContext ctx,
                               Boolean value)

Description copied from class: GeneratedSolrIndexerHotUpdateWizard

Generated method - Setter of the SolrIndexerHotUpdateWizard.updateOperation attribute.

Specified by:

setUpdateOperation in class GeneratedSolrIndexerHotUpdateWizard

value - the updateOperation