Package org.ametys.cms.contenttype

Class AbstractContentTypeViewParser

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.runtime.model.AbstractViewParser

org.ametys.cms.contenttype.AbstractContentTypeViewParser

All Implemented Interfaces:

ViewParser, Component, LogEnabled, Serviceable

Direct Known Subclasses:

ContentTypeViewParser, StaticSearchUIModelColumnsParser

public abstract class AbstractContentTypeViewParser
extends AbstractViewParser
implements Component, Serviceable

Abstract component that parses view's configuration for content types

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentTypeExtensionPoint	_contentTypeExtensionPoint	The content type extension point
protected ContentTypesHelper	_contentTypesHelper	The content types helper
protected SystemPropertyExtensionPoint	_systemPropertyExtensionPoint	The system property extension point

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

Method Summary

Modifier and Type	Method	Description
protected ViewItem	_createViewItemCopyInstanceForReferencedView(ViewItem viewItem)	Creates a ViewItem instance, that will be the copy of an existing view item in a referenced view
protected ModelItem	_getModelItem(ModelHelper.ConfigurationAndPluginName itemConfiguration, String modelItemName, Collection<? extends ModelItemAccessor> parents)	Retrieves the model item with the given name
protected ViewElement	_parseContentAttributeViewItem(ModelHelper.ConfigurationAndPluginName itemConfiguration, ContentAttributeDefinition definition, View referenceView, boolean override)	Parses the view item referencing an attribute of type content
protected ViewElement	_parseViewElement(ModelHelper.ConfigurationAndPluginName itemConfiguration, ElementDefinition definition, View referenceView, boolean override)	Parses the view element
protected void	_parseViewReference(String viewName, ViewItemAccessor viewItemAccessor, ModelItemAccessor modelItemAccessor)	Parses the view reference to add items of the view to the given item accessor
void	service(ServiceManager manager)

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

_addItemToOverriddenView, _addItemToViewItemAccessor, _createModelViewItemInstance, _createViewItemAccessor, _fillViewGeneralInformation, _getAddItemChildConfiguration, _getModel, _getModelItemReference, _insertItemInViewItemAccessor, _isAddingGroupConfiguration, _isAddingItemConfiguration, _isRemovingItemConfiguration, _parseModelViewItem, _parseSimpleViewItemGroup, _parseSimpleViewItemGroupChild, _parseViewChild, _parseViewItemAccessorChild, _parseViewName, _removeViewItemFromView, createModelViewItem, overrideView, 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

_contentTypeExtensionPoint

protected ContentTypeExtensionPoint _contentTypeExtensionPoint

The content type extension point

_contentTypesHelper

protected ContentTypesHelper _contentTypesHelper

The content types helper

_systemPropertyExtensionPoint

protected SystemPropertyExtensionPoint _systemPropertyExtensionPoint

The system property extension point

Constructor Details

AbstractContentTypeViewParser

public AbstractContentTypeViewParser()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

_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 AbstractViewParser

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.

_parseViewElement

protected ViewElement _parseViewElement(ModelHelper.ConfigurationAndPluginName itemConfiguration,
 ElementDefinition definition,
 View referenceView,
 boolean override)
                                 throws ConfigurationException

Description copied from class: AbstractViewParser

Parses the view element

Overrides:

_parseViewElement in class AbstractViewParser

Parameters:

itemConfiguration - configuration of the view item

definition - definition of the element

referenceView - view that references the item

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

Returns:

the view item

Throws:

ConfigurationException - if the configuration is not valid

_parseContentAttributeViewItem

protected ViewElement _parseContentAttributeViewItem(ModelHelper.ConfigurationAndPluginName itemConfiguration,
 ContentAttributeDefinition definition,
 View referenceView,
 boolean override)
                                              throws ConfigurationException

Parses the view item referencing an attribute of type content

Parameters:

itemConfiguration - configuration of the view item

definition - definition of the attribute

referenceView - view that references the item

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

Returns:

the view item

Throws:

ConfigurationException - if the configuration is not valid

_parseViewReference

protected void _parseViewReference(String viewName,
 ViewItemAccessor viewItemAccessor,
 ModelItemAccessor modelItemAccessor)
                            throws ConfigurationException

Description copied from class: AbstractViewParser

Parses the view reference to add items of the view to the given item accessor

Specified by:

_parseViewReference in class AbstractViewParser

Parameters:

viewName - the name of the referenced view

viewItemAccessor - the view item accessor referencing the view

modelItemAccessor - the definition of the model item containing the referenced view

Throws:

ConfigurationException - if the configuration is not valid

_createViewItemCopyInstanceForReferencedView

protected ViewItem _createViewItemCopyInstanceForReferencedView(ViewItem viewItem)

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

Parameters:

viewItem - the view item that will be copied

Returns:

the created ViewItem instance