Package org.opencms.ui.apps.searchindex

Class CmsSearchindexApp

java.lang.Object

org.opencms.ui.apps.A_CmsWorkplaceApp

org.opencms.ui.apps.searchindex.CmsSearchindexApp

All Implemented Interfaces:

I_CmsCRUDApp<I_CmsSearchIndex>, I_CmsWorkplaceApp

public class CmsSearchindexApp
extends A_CmsWorkplaceApp
implements I_CmsCRUDApp<I_CmsSearchIndex>

Class for the search index app.

Nested Class Summary

Nested classes/interfaces inherited from class org.opencms.ui.apps.A_CmsWorkplaceApp

A_CmsWorkplaceApp.NavEntry

Field Summary

Fields

Modifier and Type	Field	Description
protected CmsSearchIndexTable	m_table	Table.
protected static final String	PATH_REBUILD	Path to show sources.
protected static final String	SEPERATOR_INDEXNAMES	Seperator used when several index names are submitted.

Fields inherited from class org.opencms.ui.apps.A_CmsWorkplaceApp

m_infoLayout, m_rootLayout, m_uiContext, PARAM_ASSIGN, PARAM_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
CmsSearchindexApp()

Method Summary

Modifier and Type	Method	Description
void	createElement(I_CmsSearchIndex element)	Creates the element of type T in the system.
void	defaultAction(String elementId)	Performs a default action.
void	deleteElements(List<String> elementId)	Delete the given List of elements.
List<I_CmsSearchIndex>	getAllElements()	Get all Elements.
protected LinkedHashMap<String,String>	getBreadCrumbForState(String state)	Returns the current bread crumb entries in an ordered map.
protected com.vaadin.ui.Component	getComponentForState(String state)	Returns the app component for the given state.
I_CmsSearchIndex	getElement(String elementId)	Reads out an element.
protected List<A_CmsWorkplaceApp.NavEntry>	getSubNavEntries(String state)	Returns the sub navigation entries.
protected com.vaadin.ui.Component	getUpdateThreadComponent(List<String> elementIds)	Gets the thread to update given indexes.
void	writeElement(I_CmsSearchIndex element)	Writes a changed element to the system which already exists.

Methods inherited from class org.opencms.ui.apps.A_CmsWorkplaceApp

addParamToState, addSubNavEntry, getLastPathLevel, getOfflineCmsObject, getParamFromState, getParamsFromState, initUI, onStateChange, openSubView, removeParamsFromState, setBreadCrumbEntries, updateBreadCrumb, updateSubNav

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PATH_REBUILD

protected static final String PATH_REBUILD

Path to show sources.

See Also:

• Constant Field Values

SEPERATOR_INDEXNAMES

protected static final String SEPERATOR_INDEXNAMES

Seperator used when several index names are submitted.

See Also:

• Constant Field Values

m_table

protected CmsSearchIndexTable m_table

Table.

Constructor Details

CmsSearchindexApp

public CmsSearchindexApp()

Method Details

createElement

public void createElement(I_CmsSearchIndex element)

Description copied from interface: I_CmsCRUDApp

Creates the element of type T in the system.

Specified by:

createElement in interface I_CmsCRUDApp<I_CmsSearchIndex>

Parameters:

element - to be saved

See Also:

• I_CmsCRUDApp.createElement(java.lang.Object)

defaultAction

public void defaultAction(String elementId)

Description copied from interface: I_CmsCRUDApp

Performs a default action.

Specified by:

defaultAction in interface I_CmsCRUDApp<I_CmsSearchIndex>

Parameters:

elementId - id of element

See Also:

• I_CmsCRUDApp.defaultAction(java.lang.String)

deleteElements

public void deleteElements(List<String> elementId)

Description copied from interface: I_CmsCRUDApp

Delete the given List of elements.

Specified by:

deleteElements in interface I_CmsCRUDApp<I_CmsSearchIndex>

Parameters:

elementId - of elements to be deleted

See Also:

• I_CmsCRUDApp.deleteElements(java.util.List)

getAllElements

public List<I_CmsSearchIndex> getAllElements()

Description copied from interface: I_CmsCRUDApp

Get all Elements.

Specified by:

getAllElements in interface I_CmsCRUDApp<I_CmsSearchIndex>

Returns:

a list of all elements

See Also:

• I_CmsCRUDApp.getAllElements()

getElement

public I_CmsSearchIndex getElement(String elementId)

Description copied from interface: I_CmsCRUDApp

Reads out an element.

Specified by:

getElement in interface I_CmsCRUDApp<I_CmsSearchIndex>

Parameters:

elementId - of the object

Returns:

the object of type T

See Also:

• I_CmsCRUDApp.getElement(java.lang.String)

writeElement

public void writeElement(I_CmsSearchIndex element)

Description copied from interface: I_CmsCRUDApp

Writes a changed element to the system which already exists.

Specified by:

writeElement in interface I_CmsCRUDApp<I_CmsSearchIndex>

Parameters:

element - to be saved

See Also:

• I_CmsCRUDApp.writeElement(java.lang.Object)

getBreadCrumbForState

protected LinkedHashMap<String,String> getBreadCrumbForState(String state)

Description copied from class: A_CmsWorkplaceApp

Returns the current bread crumb entries in an ordered map.

Specified by:

getBreadCrumbForState in class A_CmsWorkplaceApp

Parameters:

state - the current state

Returns:

bread crumb entry name by state, in case the state is empty, the entry will be disabled

See Also:

• A_CmsWorkplaceApp.getBreadCrumbForState(java.lang.String)

getComponentForState

protected com.vaadin.ui.Component getComponentForState(String state)

Description copied from class: A_CmsWorkplaceApp

Returns the app component for the given state.

Specified by:

getComponentForState in class A_CmsWorkplaceApp

Parameters:

state - the state to render

Returns:

the app component

See Also:

• A_CmsWorkplaceApp.getComponentForState(java.lang.String)

getSubNavEntries

protected List<A_CmsWorkplaceApp.NavEntry> getSubNavEntries(String state)

Description copied from class: A_CmsWorkplaceApp

Returns the sub navigation entries.

Specified by:

getSubNavEntries in class A_CmsWorkplaceApp

Parameters:

state - the state

Returns:

the sub navigation entries

See Also:

• A_CmsWorkplaceApp.getSubNavEntries(java.lang.String)

getUpdateThreadComponent

protected com.vaadin.ui.Component getUpdateThreadComponent(List<String> elementIds)

Gets the thread to update given indexes.

Parameters:

elementIds - to be updated

Returns:

A_CmsReportThread