org.opencms.ui.apps.lists

Class CmsListManager

java.lang.Object

org.opencms.ui.apps.A_CmsWorkplaceApp

org.opencms.ui.apps.lists.CmsListManager

All Implemented Interfaces:

com.vaadin.navigator.ViewChangeListener, java.io.Serializable, I_CmsCachableApp, I_CmsContextProvider, I_CmsWorkplaceApp, CmsResourceTable.I_ResourcePropertyProvider, I_CmsWindowCloseListener

public class CmsListManager
extends A_CmsWorkplaceApp
implements CmsResourceTable.I_ResourcePropertyProvider, I_CmsContextProvider, com.vaadin.navigator.ViewChangeListener, I_CmsWindowCloseListener, I_CmsCachableApp

Manager for list configuration files.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CmsListManager.CategoryMode Enum representing how selected categories should be combined in a search.
protected class	CmsListManager.DialogContext Extended dialog context.
static class	CmsListManager.ListConfigurationBean The list configuration data.

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

A_CmsWorkplaceApp.NavEntry

Nested classes/interfaces inherited from interface com.vaadin.navigator.ViewChangeListener

com.vaadin.navigator.ViewChangeListener.ViewChangeEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected static CmsResourceTableProperty	BLACKLISTED_PROPERTY The blacklisted table column property id.
static java.lang.String	FIELD_CATEGORIES SOLR field name.
static java.lang.String	FIELD_DATE SOLR field name.
static java.lang.String	FIELD_DATE_FACET_NAME SOLR field name.
static java.lang.String	FIELD_PARENT_FOLDERS SOLR field name.
protected static CmsResourceTableProperty	INFO_PROPERTY The date series info table column property id.
protected static CmsResourceTableProperty	INFO_PROPERTY_LABEL The date series info label table column property id.
protected static CmsResourceTableProperty	INSTANCEDATE_PROPERTY The blacklisted table column property id.
static java.lang.String	N_BLACKLIST List configuration node name and field key.
static java.lang.String	N_CATEGORY List configuration node name and field key.
static java.lang.String	N_CATEGORY_MODE List configuration node name for the category mode.
static java.lang.String	N_DATE_RESTRICTION XML content node name.
static java.lang.String	N_DISPLAY_TYPE List configuration node name and field key.
static java.lang.String	N_FILTER_QUERY List configuration node name and field key.
static java.lang.String	N_KEY List configuration node name and field key.
static java.lang.String	N_PARAMETER List configuration node name and field key.
static java.lang.String	N_SEARCH_FOLDER List configuration node name and field key.
static java.lang.String	N_SHOW_EXPIRED List configuration node name and field key.
static java.lang.String	N_SORT_ORDER List configuration node name and field key.
static java.lang.String	N_TITLE List configuration node name and field key.
static java.lang.String	N_VALUE List configuration node name and field key.
static java.lang.String	PARAM_LOCALE List configuration node name and field key.
static java.lang.String[]	PARAMETER_FIELDS The parameter fields.
static java.lang.String	PATH_NAME_VIEW The view content list path name.
static java.lang.String	RES_TYPE_LIST_CONFIG The list configuration resource type name.
protected static java.lang.String[][]	SORT_OPTIONS The available sort options.

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

m_infoLayout, m_rootLayout, m_uiContext, PARAM_ASSIGN, PARAM_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
CmsListManager()

Method Summary

Modifier and Type	Method and Description
void	addItemProperties(com.vaadin.v7.data.Item resourceItem, CmsObject cms, CmsResource resource, java.util.Locale locale) Adds the property values to the given item.
void	afterViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent event)
boolean	beforeViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent event)
protected java.util.LinkedHashMap<java.lang.String,java.lang.String>	getBreadCrumbForState(java.lang.String state) Returns the current bread crumb entries in an ordered map.
protected com.vaadin.ui.Component	getComponentForState(java.lang.String state) Returns the app component for the given state.
I_CmsDialogContext	getDialogContext() Returns the dialog context for dialogs opened from the context menu.
protected java.util.List<A_CmsWorkplaceApp.NavEntry>	getSubNavEntries(java.lang.String state) Returns the sub navigation entries.
void	initUI(I_CmsAppUIContext uiContext) Within this method the app UI should be initialized.
boolean	isCachable() Returns whether this app should be cached within the user session.
void	onRestoreFromCache() Called after the view is fetched from the cache.
void	onStateChange(java.lang.String state) Called on navigation events.
void	onWindowClose() Executed on window close.
static CmsListManager.ListConfigurationBean	parseListConfiguration(CmsObject cms, CmsResource res) Parses the list configuration resource.
void	saveBlacklist(CmsListManager.ListConfigurationBean configBean) Saves the blacklist from the bean in the current list configuration.
void	search(CmsSimpleSearchConfigurationParser configParser, CmsResource resource) Execute a search with the given search configuration parser.
void	search(java.util.Map<java.lang.String,java.util.List<java.lang.String>> fieldFacets, java.util.Map<java.lang.String,java.util.List<java.lang.String>> rangeFacets) Updates the search result.
void	search(java.util.Map<java.lang.String,java.util.List<java.lang.String>> fieldFacets, java.util.Map<java.lang.String,java.util.List<java.lang.String>> rangeFacets, java.lang.String additionalQuery) Updates the search result.

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

addParamToState, addSubNavEntry, getLastPathLevel, getOfflineCmsObject, getParamFromState, getParamsFromState, openSubView, setBreadCrumbEntries, updateBreadCrumb, updateSubNav

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_CATEGORIES

public static final java.lang.String FIELD_CATEGORIES

SOLR field name.

See Also:

Constant Field Values

FIELD_DATE

public static final java.lang.String FIELD_DATE

SOLR field name.

See Also:

Constant Field Values

FIELD_DATE_FACET_NAME

public static final java.lang.String FIELD_DATE_FACET_NAME

SOLR field name.

See Also:

Constant Field Values

FIELD_PARENT_FOLDERS

public static final java.lang.String FIELD_PARENT_FOLDERS

SOLR field name.

See Also:

Constant Field Values

N_BLACKLIST

public static final java.lang.String N_BLACKLIST

List configuration node name and field key.

See Also:

Constant Field Values

N_CATEGORY

public static final java.lang.String N_CATEGORY

List configuration node name and field key.

See Also:

Constant Field Values

N_CATEGORY_MODE

public static final java.lang.String N_CATEGORY_MODE

List configuration node name for the category mode.

See Also:

Constant Field Values

N_DATE_RESTRICTION

public static final java.lang.String N_DATE_RESTRICTION

XML content node name.

See Also:

Constant Field Values

N_DISPLAY_TYPE

public static final java.lang.String N_DISPLAY_TYPE

List configuration node name and field key.

See Also:

Constant Field Values

N_FILTER_QUERY

public static final java.lang.String N_FILTER_QUERY

List configuration node name and field key.

See Also:

Constant Field Values

N_KEY

public static final java.lang.String N_KEY

List configuration node name and field key.

See Also:

Constant Field Values

N_PARAMETER

public static final java.lang.String N_PARAMETER

List configuration node name and field key.

See Also:

Constant Field Values

N_SEARCH_FOLDER

public static final java.lang.String N_SEARCH_FOLDER

List configuration node name and field key.

See Also:

Constant Field Values

N_SHOW_EXPIRED

public static final java.lang.String N_SHOW_EXPIRED

List configuration node name and field key.

See Also:

Constant Field Values

N_SORT_ORDER

public static final java.lang.String N_SORT_ORDER

List configuration node name and field key.

See Also:

Constant Field Values

N_TITLE

public static final java.lang.String N_TITLE

List configuration node name and field key.

See Also:

Constant Field Values

N_VALUE

public static final java.lang.String N_VALUE

List configuration node name and field key.

See Also:

Constant Field Values

PARAM_LOCALE

public static final java.lang.String PARAM_LOCALE

List configuration node name and field key.

See Also:

Constant Field Values

PARAMETER_FIELDS

public static final java.lang.String[] PARAMETER_FIELDS

The parameter fields.

PATH_NAME_VIEW

public static final java.lang.String PATH_NAME_VIEW

The view content list path name.

See Also:

Constant Field Values

RES_TYPE_LIST_CONFIG

public static final java.lang.String RES_TYPE_LIST_CONFIG

The list configuration resource type name.

See Also:

Constant Field Values

BLACKLISTED_PROPERTY

protected static final CmsResourceTableProperty BLACKLISTED_PROPERTY

The blacklisted table column property id.

INFO_PROPERTY

protected static final CmsResourceTableProperty INFO_PROPERTY

The date series info table column property id.

INFO_PROPERTY_LABEL

protected static final CmsResourceTableProperty INFO_PROPERTY_LABEL

The date series info label table column property id.

INSTANCEDATE_PROPERTY

protected static final CmsResourceTableProperty INSTANCEDATE_PROPERTY

The blacklisted table column property id.

SORT_OPTIONS

protected static final java.lang.String[][] SORT_OPTIONS

The available sort options.

Constructor Detail

CmsListManager

public CmsListManager()

Method Detail

parseListConfiguration

public static CmsListManager.ListConfigurationBean parseListConfiguration(CmsObject cms,
                                                                          CmsResource res)

Parses the list configuration resource.

Parameters:

cms - the CMS context to use

res - the list configuration resource

Returns:

the configuration data bean

addItemProperties

public void addItemProperties(com.vaadin.v7.data.Item resourceItem,
                              CmsObject cms,
                              CmsResource resource,
                              java.util.Locale locale)

Description copied from interface: CmsResourceTable.I_ResourcePropertyProvider

Adds the property values to the given item.

Specified by:

addItemProperties in interface CmsResourceTable.I_ResourcePropertyProvider

Parameters:

resourceItem - the resource item

cms - the cms context

resource - the resource

locale - the workplace locale

See Also:

CmsResourceTable.I_ResourcePropertyProvider.addItemProperties(com.vaadin.v7.data.Item, org.opencms.file.CmsObject, org.opencms.file.CmsResource, java.util.Locale)

afterViewChange

public void afterViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent event)

Specified by:

afterViewChange in interface com.vaadin.navigator.ViewChangeListener

See Also:

ViewChangeListener.afterViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent)

beforeViewChange

public boolean beforeViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent event)

Specified by:

beforeViewChange in interface com.vaadin.navigator.ViewChangeListener

See Also:

ViewChangeListener.beforeViewChange(com.vaadin.navigator.ViewChangeListener.ViewChangeEvent)

getDialogContext

public I_CmsDialogContext getDialogContext()

Description copied from interface: I_CmsContextProvider

Returns the dialog context for dialogs opened from the context menu.

Specified by:

getDialogContext in interface I_CmsContextProvider

Returns:

the dialog context

See Also:

I_CmsContextProvider.getDialogContext()

initUI

public void initUI(I_CmsAppUIContext uiContext)

Description copied from interface: I_CmsWorkplaceApp

Within this method the app UI should be initialized.

Use the context to add the app's components to the UI.

Specified by:

initUI in interface I_CmsWorkplaceApp

Overrides:

initUI in class A_CmsWorkplaceApp

Parameters:

uiContext - the UI context

See Also:

A_CmsWorkplaceApp.initUI(org.opencms.ui.apps.I_CmsAppUIContext)

isCachable

public boolean isCachable()

Description copied from interface: I_CmsCachableApp

Returns whether this app should be cached within the user session.

Specified by:

isCachable in interface I_CmsCachableApp

Returns:

true if the app is cachable

See Also:

I_CmsCachableApp.isCachable()

onRestoreFromCache

public void onRestoreFromCache()

Description copied from interface: I_CmsCachableApp

Called after the view is fetched from the cache.

Specified by:

onRestoreFromCache in interface I_CmsCachableApp

See Also:

I_CmsCachableApp.onRestoreFromCache()

onStateChange

public void onStateChange(java.lang.String state)

Description copied from interface: I_CmsWorkplaceApp

Called on navigation events.

Specified by:

onStateChange in interface I_CmsWorkplaceApp

Overrides:

onStateChange in class A_CmsWorkplaceApp

Parameters:

state - the app state to show

See Also:

A_CmsWorkplaceApp.onStateChange(java.lang.String)

onWindowClose

public void onWindowClose()

Description copied from interface: I_CmsWindowCloseListener

Executed on window close.

Specified by:

onWindowClose in interface I_CmsWindowCloseListener

See Also:

I_CmsWindowCloseListener.onWindowClose()

saveBlacklist

public void saveBlacklist(CmsListManager.ListConfigurationBean configBean)

Saves the blacklist from the bean in the current list configuration.

Parameters:

configBean - the bean whose blacklist should be saved

search

public void search(CmsSimpleSearchConfigurationParser configParser,
                   CmsResource resource)

Execute a search with the given search configuration parser.

Parameters:

configParser - the search configuration parser

resource - the current configuration resource

search

public void search(java.util.Map<java.lang.String,java.util.List<java.lang.String>> fieldFacets,
                   java.util.Map<java.lang.String,java.util.List<java.lang.String>> rangeFacets)

Updates the search result.

Parameters:

fieldFacets - the field facets

rangeFacets - the range facets

search

public void search(java.util.Map<java.lang.String,java.util.List<java.lang.String>> fieldFacets,
                   java.util.Map<java.lang.String,java.util.List<java.lang.String>> rangeFacets,
                   java.lang.String additionalQuery)

Updates the search result.

Parameters:

fieldFacets - the field facets

rangeFacets - the range facets

additionalQuery - the additional query

getBreadCrumbForState

protected java.util.LinkedHashMap<java.lang.String,java.lang.String> getBreadCrumbForState(java.lang.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(java.lang.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 java.util.List<A_CmsWorkplaceApp.NavEntry> getSubNavEntries(java.lang.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)