Package org.ametys.cms.search.ui.model

Class StaticSearchUIModelColumnsParser

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.runtime.model.AbstractViewParser

org.ametys.cms.contenttype.AbstractContentTypeViewParser

org.ametys.cms.search.ui.model.StaticSearchUIModelColumnsParser

All Implemented Interfaces:

ViewParser, Component, LogEnabled, Serviceable

public class StaticSearchUIModelColumnsParser
extends AbstractContentTypeViewParser

Component that parses the columns of a StaticSearchUIModel

Field Summary

Fields

Modifier and Type	Field	Description
protected Collection<ContentType>	_contentTypes	Content types containing the item available in the search model's columns

Fields inherited from class org.ametys.cms.contenttype.AbstractContentTypeViewParser

_contentTypeExtensionPoint, _contentTypesHelper, _systemPropertyExtensionPoint

Fields inherited from class org.ametys.runtime.model.AbstractViewParser

__VIEW_REFERENCE_PATTERN, __VIEW_REFERENCE_REGEX

Fields inherited from interface org.ametys.runtime.model.ViewParser

ADD_GROUP_TAG_NAME, ADD_ITEM_TAG_NAME, ALL_ITEMS_REFERENCE, ITEM_REFERENCE_ATTRIBUTE_NAME, REMOVE_ITEM_TAG_NAME

Constructor Summary

Constructors

Constructor	Description
StaticSearchUIModelColumnsParser(Collection<ContentType> contentTypes)	Creates a StaticSearchUIModel's columns parser

Method Summary

Modifier and Type	Method	Description
protected ModelViewItem	_createModelViewItemInstance(ModelItem modelItem)	Creates an instance of ModelViewItem due to the given ModelItem
protected ViewItem	_createViewItemCopyInstanceForReferencedView(ViewItem viewItem)	Creates a ViewItem instance, that will be the copy of an existing view item in a referenced view
protected void	_fillViewGeneralInformation(ModelHelper.ConfigurationAndPluginName viewConfiguration, View view, View existingView, Collection<? extends Model> model)	Fill the general information of the given view (label, description, ...)
protected Collection<? extends Model>	_getModel()	Retrieves the model corresponding to the view to parse
protected ModelItem	_getModelItem(ModelHelper.ConfigurationAndPluginName itemConfiguration, String modelItemName, Collection<? extends ModelItemAccessor> parents)	Retrieves the model item with the given name
protected String	_parseViewName(ModelHelper.ConfigurationAndPluginName viewConfiguration)	Parses the name of the view
protected ModelViewItem	createModelViewItem(ModelHelper.ConfigurationAndPluginName itemConfiguration, ModelItem modelItem, View referenceView, boolean override)	Creates the model view item corresponding to the given configuration
protected ModelViewItem	createModelViewItemForAllItemsReference(ModelHelper.ConfigurationAndPluginName itemConfiguration, ModelItem modelItem, View referenceView, boolean override)	Creates the model view item corresponding to the given configuration, in cas of all items references
View	overrideView(ModelHelper.ConfigurationAndPluginName viewConfiguration, View existingView)	Parses a view configuration to override a View object.

Methods inherited from class org.ametys.cms.contenttype.AbstractContentTypeViewParser

_parseContentElementViewItem, _parseViewElement, _parseViewReference, service

Methods inherited from class org.ametys.runtime.model.AbstractViewParser

_addItemToOverriddenView, _addItemToViewItemAccessor, _createViewItemAccessor, _getAddItemChildConfiguration, _getModelItemReference, _insertItemInViewItemAccessor, _isAddingGroupConfiguration, _isAddingItemConfiguration, _isRemovingItemConfiguration, _parseModelViewItem, _parseSimpleViewItemGroup, _parseSimpleViewItemGroupChild, _parseViewChild, _parseViewItemAccessorChild, _removeViewItemFromView, parseAllModelViewItems, parseView

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Details

_contentTypes

protected Collection<ContentType> _contentTypes

Content types containing the item available in the search model's columns

Constructor Details

StaticSearchUIModelColumnsParser

public StaticSearchUIModelColumnsParser(Collection<ContentType> contentTypes)

Creates a StaticSearchUIModel's columns parser

Parameters:

contentTypes - The content types containing the item available in the search model's columns

Method Details

_parseViewName

protected String _parseViewName(ModelHelper.ConfigurationAndPluginName viewConfiguration)
                         throws ConfigurationException

Description copied from class: AbstractViewParser

Parses the name of the view

Overrides:

_parseViewName in class AbstractViewParser

Parameters:

viewConfiguration - the view's configuration

Returns:

the view's name

Throws:

ConfigurationException - if an error occurs while parsing the view's name

overrideView

public View overrideView(ModelHelper.ConfigurationAndPluginName viewConfiguration,
 View existingView)
                  throws ConfigurationException

Description copied from interface: ViewParser

Parses a view configuration to override a View object.

Specified by:

overrideView in interface ViewParser

Overrides:

overrideView in class AbstractViewParser

Parameters:

viewConfiguration - the configuration of the view to parse

existingView - The view to override

Returns:

the overridden view

Throws:

ConfigurationException - if the configuration is not valid.

_fillViewGeneralInformation

protected void _fillViewGeneralInformation(ModelHelper.ConfigurationAndPluginName viewConfiguration,
 View view,
 View existingView,
 Collection<? extends Model> model)
                                    throws ConfigurationException

Description copied from class: AbstractViewParser

Fill the general information of the given view (label, description, ...)

Overrides:

_fillViewGeneralInformation in class AbstractViewParser

Parameters:

viewConfiguration - the configuration of the view to fill

view - the view to fill

existingView - the existing view, that may already contain general information

model - The model of the view

Throws:

ConfigurationException - if the configuration is not valid.

_getModel

protected Collection<? extends Model> _getModel()

Description copied from class: AbstractViewParser

Retrieves the model corresponding to the view to parse

Specified by:

_getModel in class AbstractViewParser

Returns:

the model

_getModelItem

protected ModelItem _getModelItem(ModelHelper.ConfigurationAndPluginName itemConfiguration,
 String modelItemName,
 Collection<? extends ModelItemAccessor> parents)
                           throws ConfigurationException

Description copied from class: AbstractViewParser

Retrieves the model item with the given name

Overrides:

_getModelItem in class AbstractContentTypeViewParser

Parameters:

itemConfiguration - configuration of the model view item

modelItemName - the model item name

parents - the accessors containing the model item

Returns:

the model item

Throws:

ConfigurationException - if the configuration is not valid.

createModelViewItemForAllItemsReference

protected ModelViewItem createModelViewItemForAllItemsReference(ModelHelper.ConfigurationAndPluginName itemConfiguration,
 ModelItem modelItem,
 View referenceView,
 boolean override)
                                                         throws ConfigurationException

Description copied from class: AbstractViewParser

Creates the model view item corresponding to the given configuration, in cas of all items references

Overrides:

createModelViewItemForAllItemsReference in class AbstractViewParser

Parameters:

itemConfiguration - configuration of the model view item

modelItem - the model item

referenceView - view that references the item

override - true if the configuration is an override, false otherwise

Returns:

the created model view item

Throws:

ConfigurationException - if the configuration is not valid.

createModelViewItem

protected ModelViewItem createModelViewItem(ModelHelper.ConfigurationAndPluginName itemConfiguration,
 ModelItem modelItem,
 View referenceView,
 boolean override)
                                     throws ConfigurationException

Description copied from class: AbstractViewParser

Creates the model view item corresponding to the given configuration

Overrides:

createModelViewItem in class AbstractViewParser

Parameters:

itemConfiguration - configuration of the model view item

modelItem - the model item

referenceView - view that references the item

override - true if the configuration is an override, false otherwise

Returns:

the created model view item

Throws:

ConfigurationException - if the configuration is not valid.

_createModelViewItemInstance

protected ModelViewItem _createModelViewItemInstance(ModelItem modelItem)

Description copied from class: AbstractViewParser

Creates an instance of ModelViewItem due to the given ModelItem

Overrides:

_createModelViewItemInstance in class AbstractViewParser

Parameters:

modelItem - the model item corresponding to the view item to create

Returns:

the created view item

_createViewItemCopyInstanceForReferencedView

protected ViewItem _createViewItemCopyInstanceForReferencedView(ViewItem viewItem)

Description copied from class: AbstractContentTypeViewParser

Creates a ViewItem instance, that will be the copy of an existing view item in a referenced view

Overrides:

_createViewItemCopyInstanceForReferencedView in class AbstractContentTypeViewParser

Parameters:

viewItem - the view item that will be copied

Returns:

the created ViewItem instance