Package org.ametys.runtime.model

Interface ViewParser

All Known Implementing Classes:

AbstractContentTypeViewParser, AbstractViewParser, ContentTypeViewParser, StaticSearchUIModelColumnsParser

public interface ViewParser

Interface for components that parse view's configuration

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_GROUP_TAG_NAME	Default tag name for simple groups
static final String	ADD_ITEM_TAG_NAME	Default tag name for items
static final String	ALL_ITEMS_REFERENCE	The name of item reference to add all items
static final String	ITEM_REFERENCE_ATTRIBUTE_NAME	Default attribute name for items' references
static final String	REMOVE_ITEM_TAG_NAME	Tag name for references to delete items

Method Summary

Modifier and Type	Method	Description
View	overrideView(ModelHelper.ConfigurationAndPluginName viewConfiguration, View existingView)	Parses a view configuration to override a View object.
View	parseView(ModelHelper.ConfigurationAndPluginName viewConfiguration)	Parses a view configuration to create a View object.

Field Details

ADD_GROUP_TAG_NAME

static final String ADD_GROUP_TAG_NAME

Default tag name for simple groups

See Also:

• Constant Field Values

ADD_ITEM_TAG_NAME

static final String ADD_ITEM_TAG_NAME

Default tag name for items

See Also:

• Constant Field Values

ITEM_REFERENCE_ATTRIBUTE_NAME

static final String ITEM_REFERENCE_ATTRIBUTE_NAME

Default attribute name for items' references

See Also:

• Constant Field Values

REMOVE_ITEM_TAG_NAME

static final String REMOVE_ITEM_TAG_NAME

Tag name for references to delete items

See Also:

• Constant Field Values

ALL_ITEMS_REFERENCE

static final String ALL_ITEMS_REFERENCE

The name of item reference to add all items

See Also:

• Constant Field Values

Method Details

parseView

View parseView(ModelHelper.ConfigurationAndPluginName viewConfiguration)
        throws ConfigurationException

Parses a view configuration to create a View object.

Parameters:

viewConfiguration - the configuration of the view to parse

Returns:

the view

Throws:

ConfigurationException - if the configuration is not valid.

overrideView

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

Parses a view configuration to override a View object.

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.