Package org.opencms.ade.configuration.formatters

Class CmsFormatterBeanParser

java.lang.Object

org.opencms.ade.configuration.formatters.CmsFormatterBeanParser

public class CmsFormatterBeanParser
extends Object

Parses formatter beans from formatter configuration XML contents.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CmsFormatterBeanParser.ParseException	Exception for the errors in the configuration file not covered by other exception types.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	N_ALLOWS_SETTINGS_IN_EDITOR	Content value node name.
static final String	N_ATTRIBUTE	Content value node name.
static final String	N_AUTO_ENABLED	Content value node name.
static final String	N_CHOICE_NEW_LINK	Content value node name.
static final String	N_CONTAINER_TYPE	Content value node name.
static final String	N_CSS_INLINE	Content value node name.
static final String	N_CSS_LINK	Content value node name.
static final String	N_DEFAULT	Content value node name.
static final String	N_DEFAULT_CONTENT	Content value node name.
static final String	N_DESCRIPTION	Content value node name.
static final String	N_DETAIL	Content value node name.
static final String	N_DISPLAY	Content value node name.
static final String	N_ELEMENT	Content value node name.
static final String	N_FORMATTER	Node name.
static final String	N_FORMATTERS	Node name.
static final String	N_GROUP	Content value node name.
static final String	N_HEAD_INCLUDE_CSS	Content value node name.
static final String	N_HEAD_INCLUDE_JS	Content value node name.
static final String	N_INCLUDE_SETTINGS	Content value node name.
static final String	N_JAVASCRIPT_INLINE	Content value node name.
static final String	N_JAVASCRIPT_LINK	Content value node name.
static final String	N_JSP	Content value node name.
static final String	N_KEY	Content value node name.
static final String	N_KEY_ALIAS	Content value node name.
static final String	N_MACRO	Node name.
static final String	N_MACRO_NAME	Node name.
static final String	N_MATCH	Content value node name.
static final String	N_MAX_WIDTH	Content value node name.
static final String	N_META_MAPPING	Content value node name.
static final String	N_NESTED_FORMATTER_SETTINGS	Content value node name.
static final String	N_NICE_NAME	Content value node name.
static final String	N_ORDER	Content value node name.
static final String	N_PARAMETER	Content value node name.
static final String	N_PLACEHOLDER_MACRO	Content value node name.
static final String	N_PLACEHOLDER_STRING_TEMPLATE	Node name.
static final String	N_PLUGIN	Content value node name.
static final String	N_PREVIEW	Content value node name.
static final String	N_RANK	Content value node name.
static final String	N_SEARCH_CONTENT	Content value node name.
static final String	N_SETTING	Content value node name.
static final String	N_STRICT_CONTAINERS	Content value node name.
static final String	N_STRING_TEMPLATE	Node name.
static final String	N_TARGET	XML node name.
static final String	N_TYPE	Content value node name.
static final String	N_TYPES	Content value node name.
static final String	N_USE_META_MAPPINGS_FOR_NORMAL_ELEMENTS	Node name for the 'use meta mappings for normal elements' check box.
static final String	N_VALUE	Content value node name.
static final String	N_WIDTH	Content value node name.
static final String	SETTING_DISPLAY_TYPE	The key for the setting display type.

Constructor Summary

Constructors

Constructor	Description
CmsFormatterBeanParser(CmsObject cms, Map<CmsUUID,Map<CmsSharedSettingKey,CmsXmlContentProperty>> settingConfigs)	Creates a new parser instance.

Method Summary

Modifier and Type	Method	Description
I_CmsFormatterBean	parse(CmsXmlContent content, String location, String id)	Reads the formatter bean from the given XML content.
static String	path(String... components)	Creates an xpath from the given components.

Methods inherited from class java.lang.Object

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

Field Details

N_ALLOWS_SETTINGS_IN_EDITOR

public static final String N_ALLOWS_SETTINGS_IN_EDITOR

Content value node name.

See Also:

• Constant Field Values

N_ATTRIBUTE

public static final String N_ATTRIBUTE

Content value node name.

See Also:

• Constant Field Values

N_AUTO_ENABLED

public static final String N_AUTO_ENABLED

Content value node name.

See Also:

• Constant Field Values

N_CHOICE_NEW_LINK

public static final String N_CHOICE_NEW_LINK

Content value node name.

See Also:

• Constant Field Values

N_CONTAINER_TYPE

public static final String N_CONTAINER_TYPE

Content value node name.

See Also:

• Constant Field Values

N_CSS_INLINE

public static final String N_CSS_INLINE

Content value node name.

See Also:

• Constant Field Values

N_CSS_LINK

public static final String N_CSS_LINK

Content value node name.

See Also:

• Constant Field Values

N_DEFAULT

public static final String N_DEFAULT

Content value node name.

See Also:

• Constant Field Values

N_DEFAULT_CONTENT

public static final String N_DEFAULT_CONTENT

Content value node name.

See Also:

• Constant Field Values

N_DESCRIPTION

public static final String N_DESCRIPTION

Content value node name.

See Also:

• Constant Field Values

N_DETAIL

public static final String N_DETAIL

Content value node name.

See Also:

• Constant Field Values

N_DISPLAY

public static final String N_DISPLAY

Content value node name.

See Also:

• Constant Field Values

N_ELEMENT

public static final String N_ELEMENT

Content value node name.

See Also:

• Constant Field Values

N_FORMATTER

public static final String N_FORMATTER

Node name.

See Also:

• Constant Field Values

N_FORMATTERS

public static final String N_FORMATTERS

Node name.

See Also:

• Constant Field Values

N_GROUP

public static final String N_GROUP

Content value node name.

See Also:

• Constant Field Values

N_HEAD_INCLUDE_CSS

public static final String N_HEAD_INCLUDE_CSS

Content value node name.

See Also:

• Constant Field Values

N_HEAD_INCLUDE_JS

public static final String N_HEAD_INCLUDE_JS

Content value node name.

See Also:

• Constant Field Values

N_INCLUDE_SETTINGS

public static final String N_INCLUDE_SETTINGS

Content value node name.

See Also:

• Constant Field Values

N_JAVASCRIPT_INLINE

public static final String N_JAVASCRIPT_INLINE

Content value node name.

See Also:

• Constant Field Values

N_JAVASCRIPT_LINK

public static final String N_JAVASCRIPT_LINK

Content value node name.

See Also:

• Constant Field Values

N_JSP

public static final String N_JSP

Content value node name.

See Also:

• Constant Field Values

N_KEY

public static final String N_KEY

Content value node name.

See Also:

• Constant Field Values

N_KEY_ALIAS

public static final String N_KEY_ALIAS

Content value node name.

See Also:

• Constant Field Values

N_MACRO

public static final String N_MACRO

Node name.

See Also:

• Constant Field Values

N_MACRO_NAME

public static final String N_MACRO_NAME

Node name.

See Also:

• Constant Field Values

N_MATCH

public static final String N_MATCH

Content value node name.

See Also:

• Constant Field Values

N_MAX_WIDTH

public static final String N_MAX_WIDTH

Content value node name.

See Also:

• Constant Field Values

N_META_MAPPING

public static final String N_META_MAPPING

Content value node name.

See Also:

• Constant Field Values

N_NESTED_FORMATTER_SETTINGS

public static final String N_NESTED_FORMATTER_SETTINGS

Content value node name.

See Also:

• Constant Field Values

N_NICE_NAME

public static final String N_NICE_NAME

Content value node name.

See Also:

• Constant Field Values

N_ORDER

public static final String N_ORDER

Content value node name.

See Also:

• Constant Field Values

N_PARAMETER

public static final String N_PARAMETER

Content value node name.

See Also:

• Constant Field Values

N_PLACEHOLDER_MACRO

public static final String N_PLACEHOLDER_MACRO

Content value node name.

See Also:

• Constant Field Values

N_PLACEHOLDER_STRING_TEMPLATE

public static final String N_PLACEHOLDER_STRING_TEMPLATE

Node name.

See Also:

• Constant Field Values

N_PLUGIN

public static final String N_PLUGIN

Content value node name.

See Also:

• Constant Field Values

N_PREVIEW

public static final String N_PREVIEW

Content value node name.

See Also:

• Constant Field Values

N_RANK

public static final String N_RANK

Content value node name.

See Also:

• Constant Field Values

N_SEARCH_CONTENT

public static final String N_SEARCH_CONTENT

Content value node name.

See Also:

• Constant Field Values

N_SETTING

public static final String N_SETTING

Content value node name.

See Also:

• Constant Field Values

N_STRICT_CONTAINERS

public static final String N_STRICT_CONTAINERS

Content value node name.

See Also:

• Constant Field Values

N_STRING_TEMPLATE

public static final String N_STRING_TEMPLATE

Node name.

See Also:

• Constant Field Values

N_TARGET

public static final String N_TARGET

XML node name.

See Also:

• Constant Field Values

N_TYPE

public static final String N_TYPE

Content value node name.

See Also:

• Constant Field Values

N_TYPES

public static final String N_TYPES

Content value node name.

See Also:

• Constant Field Values

N_USE_META_MAPPINGS_FOR_NORMAL_ELEMENTS

public static final String N_USE_META_MAPPINGS_FOR_NORMAL_ELEMENTS

Node name for the 'use meta mappings for normal elements' check box.

See Also:

• Constant Field Values

N_VALUE

public static final String N_VALUE

Content value node name.

See Also:

• Constant Field Values

N_WIDTH

public static final String N_WIDTH

Content value node name.

See Also:

• Constant Field Values

SETTING_DISPLAY_TYPE

public static final String SETTING_DISPLAY_TYPE

The key for the setting display type.

See Also:

• Constant Field Values

Constructor Details

CmsFormatterBeanParser

public CmsFormatterBeanParser(CmsObject cms,
 Map<CmsUUID,Map<CmsSharedSettingKey,CmsXmlContentProperty>> settingConfigs)

Creates a new parser instance.

A new parser instance should be created for every formatter configuration you want to parse.

Parameters:

cms - the CMS context to use for parsing

settingConfigs - the additional setting configurations used for includes

Method Details

path

public static String path(String... components)

Creates an xpath from the given components.

Parameters:

components - the xpath componentns

Returns:

the composed xpath

parse

public I_CmsFormatterBean parse(CmsXmlContent content,
 String location,
 String id)
                         throws CmsException,
CmsFormatterBeanParser.ParseException

Reads the formatter bean from the given XML content.

Parameters:

content - the formatter configuration XML content

location - a string indicating the location of the configuration

id - the id to use as the formatter id

Returns:

the parsed formatter bean

Throws:

CmsFormatterBeanParser.ParseException - if parsing goes wrong

CmsException - if something else goes wrong