CmsConfigurationReader

java.lang.Object
- org.opencms.ade.configuration.CmsConfigurationReader

```
public class CmsConfigurationReader
extends java.lang.Object
```
A class to parse ADE sitemap or module configuration files and create configuration objects from them.

字段概要

字段
限定符和类型	字段和说明
`static java.util.Locale`	`DEFAULT_LOCALE` The default locale for configuration objects.
`static java.lang.String`	`N_ADD_FORMATTER` Node name for added formatters.
`static java.lang.String`	`N_ADD_FORMATTERS` Node name for the nested content with the added formatters.
`static java.lang.String`	`N_CREATE_CONTENTS_LOCALLY` The create content locally node name.
`static java.lang.String`	`N_DEFAULT` The default node name.
`static java.lang.String`	`N_DESCRIPTION` The description node name.
`static java.lang.String`	`N_DETAIL_PAGE` The detail page node name.
`static java.lang.String`	`N_DETAIL_PAGES_DISABLED` The detail pages disabled node name.
`static java.lang.String`	`N_DISABLED` The disabled node name.
`static java.lang.String`	`N_DISCARD_MODEL_PAGES` The discard model pages node name.
`static java.lang.String`	`N_DISCARD_PROPERTIES` The discard properties node name.
`static java.lang.String`	`N_DISCARD_TYPES` The discard types node name.
`static java.lang.String`	`N_DISPLAY_NAME` The display name node name.
`static java.lang.String`	`N_ERROR` The error node name.
`static java.lang.String`	`N_FOLDER` The folder node name.
`static java.lang.String`	`N_FORMATTER` The formatter node name.
`static java.lang.String`	`N_FUNCTION` The function node name.
`static java.lang.String`	`N_FUNCTION_REF` The function reference node name.
`static java.lang.String`	`N_IS_DEFAULT` The is default node name.
`static java.lang.String`	`N_IS_PREVIEW` The is preview node name.
`static java.lang.String`	`N_JSP` The JSP node name.
`static java.lang.String`	`N_MAX_WIDTH` The max width node name.
`static java.lang.String`	`N_MIN_WIDTH` The min width node name.
`static java.lang.String`	`N_MODEL_PAGE` The model page node name.
`static java.lang.String`	`N_NAME` The folder name node name.
`static java.lang.String`	`N_NAME_PATTERN` The name pattern node name.
`static java.lang.String`	`N_ORDER` The order node name.
`static java.lang.String`	`N_PAGE` The page node name.
`static java.lang.String`	`N_PATH` The folder path node name.
`static java.lang.String`	`N_PREFER_FOLDER` The prefer folder node name.
`static java.lang.String`	`N_PROPERTY` The property node name.
`static java.lang.String`	`N_PROPERTY_NAME` The property name node name.
`static java.lang.String`	`N_REMOVE_FORMATTER` Node name for removed formatters.
`static java.lang.String`	`N_REMOVE_FORMATTERS` Node name for the nested content with the removed formatters.
`static java.lang.String`	`N_RESOURCE_TYPE` The resource type node name.
`static java.lang.String`	`N_RULE_REGEX` The regex rule node name.
`static java.lang.String`	`N_RULE_TYPE` The rule type node name.
`static java.lang.String`	`N_TYPE` The type node name.
`static java.lang.String`	`N_TYPE_NAME` The type name node name.
`static java.lang.String`	`N_WIDGET` The widget node name.
`static java.lang.String`	`N_WIDGET_CONFIG` The widget configuration node name.

构造器概要

构造器
构造器和说明

CmsConfigurationReader(CmsObject cms)
Creates a new configuration reader.

构造器
构造器和说明
`CmsConfigurationReader(CmsObject cms)` Creates a new configuration reader.

方法概要

方法
限定符和类型	方法和说明
`protected boolean`	`getBoolean(I_CmsXmlContentLocation parent, java.lang.String name)` Helper method to read a boolean value from the XML.
`java.util.List<CmsFunctionReference>`	`getFunctionReferences()` Returns the list of function references.
`static java.lang.String`	`getString(CmsObject cms, I_CmsXmlContentValueLocation location)` Gets the string value of an XML content location.
`protected java.lang.String`	`getString(I_CmsXmlContentValueLocation location)` Gets the string value of an XML content location.
`protected CmsADEConfigData`	`mergeConfigurations(java.util.List<CmsADEConfigData> configurations)` Merges a list of multiple configuration objects into a single configuration object.
`java.util.Set<java.lang.String>`	`parseAddFormatters(I_CmsXmlContentLocation node)` Parses the formatters to add.
`CmsADEConfigData`	`parseConfiguration(java.lang.String basePath, CmsXmlContent content)` Parses a configuration XML content and creates a configuration object from it.
`protected void`	`parseDetailPage(I_CmsXmlContentLocation node)` Parses the detail pages from an XML content node.
`CmsFolderOrName`	`parseFolderOrName(java.lang.String basePath, I_CmsXmlContentLocation location)` Parses a folder which may either be given as a path or as a folder name.
`CmsFormatterBean`	`parseFormatter(java.lang.String typeName, I_CmsXmlContentLocation node)` Parses a formatter bean.
`protected CmsFormatterChangeSet`	`parseFormatterChangeSet(I_CmsXmlContentLocation node)` Parses the formatter change set.
`protected void`	`parseFunctionReference(I_CmsXmlContentLocation node)` Parses a function reference node.
`void`	`parseModelPage(I_CmsXmlContentLocation node)` Parses model page data from the XML content.
`static CmsPropertyConfig`	`parseProperty(CmsObject cms, I_CmsXmlContentLocation field)` Helper method to parse a property.
`java.util.Set<java.lang.String>`	`parseRemoveFormatters(I_CmsXmlContentLocation node)` Parses the set of formatters to remove.
`void`	`parseResourceTypeConfig(java.lang.String basePath, I_CmsXmlContentLocation node)` Parses a resource type configuration element from the XML content.
`CmsADEConfigData`	`parseSitemapConfiguration(java.lang.String basePath, CmsResource configRes)` Parses the sitemap configuration given the configuration file and base path.
`CmsADEConfigData`	`readModuleConfigurations()` Reads the configurations of all modules and combines them into a single configuration object.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - DEFAULT_LOCALE
```
public static final java.util.Locale DEFAULT_LOCALE
```
    The default locale for configuration objects.
  - N_ADD_FORMATTER
```
public static final java.lang.String N_ADD_FORMATTER
```
    Node name for added formatters.
    
    另请参阅:
    常量字段值
  - N_ADD_FORMATTERS
```
public static final java.lang.String N_ADD_FORMATTERS
```
    Node name for the nested content with the added formatters.
    
    另请参阅:
    常量字段值
  - N_CREATE_CONTENTS_LOCALLY
```
public static final java.lang.String N_CREATE_CONTENTS_LOCALLY
```
    The create content locally node name.
    
    另请参阅:
    常量字段值
  - N_DEFAULT
```
public static final java.lang.String N_DEFAULT
```
    The default node name.
    
    另请参阅:
    常量字段值
  - N_DESCRIPTION
```
public static final java.lang.String N_DESCRIPTION
```
    The description node name.
    
    另请参阅:
    常量字段值
  - N_DETAIL_PAGE
```
public static final java.lang.String N_DETAIL_PAGE
```
    The detail page node name.
    
    另请参阅:
    常量字段值
  - N_DETAIL_PAGES_DISABLED
```
public static final java.lang.String N_DETAIL_PAGES_DISABLED
```
    The detail pages disabled node name.
    
    另请参阅:
    常量字段值
  - N_DISABLED
```
public static final java.lang.String N_DISABLED
```
    The disabled node name.
    
    另请参阅:
    常量字段值
  - N_DISCARD_MODEL_PAGES
```
public static final java.lang.String N_DISCARD_MODEL_PAGES
```
    The discard model pages node name.
    
    另请参阅:
    常量字段值
  - N_DISCARD_PROPERTIES
```
public static final java.lang.String N_DISCARD_PROPERTIES
```
    The discard properties node name.
    
    另请参阅:
    常量字段值
  - N_DISCARD_TYPES
```
public static final java.lang.String N_DISCARD_TYPES
```
    The discard types node name.
    
    另请参阅:
    常量字段值
  - N_DISPLAY_NAME
```
public static final java.lang.String N_DISPLAY_NAME
```
    The display name node name.
    
    另请参阅:
    常量字段值
  - N_ERROR
```
public static final java.lang.String N_ERROR
```
    The error node name.
    
    另请参阅:
    常量字段值
  - N_FOLDER
```
public static final java.lang.String N_FOLDER
```
    The folder node name.
    
    另请参阅:
    常量字段值
  - N_FORMATTER
```
public static final java.lang.String N_FORMATTER
```
    The formatter node name.
    
    另请参阅:
    常量字段值
  - N_FUNCTION
```
public static final java.lang.String N_FUNCTION
```
    The function node name.
    
    另请参阅:
    常量字段值
  - N_FUNCTION_REF
```
public static final java.lang.String N_FUNCTION_REF
```
    The function reference node name.
    
    另请参阅:
    常量字段值
  - N_IS_DEFAULT
```
public static final java.lang.String N_IS_DEFAULT
```
    The is default node name.
    
    另请参阅:
    常量字段值
  - N_IS_PREVIEW
```
public static final java.lang.String N_IS_PREVIEW
```
    The is preview node name.
    
    另请参阅:
    常量字段值
  - N_JSP
```
public static final java.lang.String N_JSP
```
    The JSP node name.
    
    另请参阅:
    常量字段值
  - N_MAX_WIDTH
```
public static final java.lang.String N_MAX_WIDTH
```
    The max width node name.
    
    另请参阅:
    常量字段值
  - N_MIN_WIDTH
```
public static final java.lang.String N_MIN_WIDTH
```
    The min width node name.
    
    另请参阅:
    常量字段值
  - N_MODEL_PAGE
```
public static final java.lang.String N_MODEL_PAGE
```
    The model page node name.
    
    另请参阅:
    常量字段值
  - N_NAME
```
public static final java.lang.String N_NAME
```
    The folder name node name.
    
    另请参阅:
    常量字段值
  - N_NAME_PATTERN
```
public static final java.lang.String N_NAME_PATTERN
```
    The name pattern node name.
    
    另请参阅:
    常量字段值
  - N_ORDER
```
public static final java.lang.String N_ORDER
```
    The order node name.
    
    另请参阅:
    常量字段值
  - N_PAGE
```
public static final java.lang.String N_PAGE
```
    The page node name.
    
    另请参阅:
    常量字段值
  - N_PATH
```
public static final java.lang.String N_PATH
```
    The folder path node name.
    
    另请参阅:
    常量字段值
  - N_PREFER_FOLDER
```
public static final java.lang.String N_PREFER_FOLDER
```
    The prefer folder node name.
    
    另请参阅:
    常量字段值
  - N_PROPERTY
```
public static final java.lang.String N_PROPERTY
```
    The property node name.
    
    另请参阅:
    常量字段值
  - N_PROPERTY_NAME
```
public static final java.lang.String N_PROPERTY_NAME
```
    The property name node name.
    
    另请参阅:
    常量字段值
  - N_REMOVE_FORMATTER
```
public static final java.lang.String N_REMOVE_FORMATTER
```
    Node name for removed formatters.
    
    另请参阅:
    常量字段值
  - N_REMOVE_FORMATTERS
```
public static final java.lang.String N_REMOVE_FORMATTERS
```
    Node name for the nested content with the removed formatters.
    
    另请参阅:
    常量字段值
  - N_RESOURCE_TYPE
```
public static final java.lang.String N_RESOURCE_TYPE
```
    The resource type node name.
    
    另请参阅:
    常量字段值
  - N_RULE_REGEX
```
public static final java.lang.String N_RULE_REGEX
```
    The regex rule node name.
    
    另请参阅:
    常量字段值
  - N_RULE_TYPE
```
public static final java.lang.String N_RULE_TYPE
```
    The rule type node name.
    
    另请参阅:
    常量字段值
  - N_TYPE
```
public static final java.lang.String N_TYPE
```
    The type node name.
    
    另请参阅:
    常量字段值
  - N_TYPE_NAME
```
public static final java.lang.String N_TYPE_NAME
```
    The type name node name.
    
    另请参阅:
    常量字段值
  - N_WIDGET
```
public static final java.lang.String N_WIDGET
```
    The widget node name.
    
    另请参阅:
    常量字段值
  - N_WIDGET_CONFIG
```
public static final java.lang.String N_WIDGET_CONFIG
```
    The widget configuration node name.
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - CmsConfigurationReader
```
public CmsConfigurationReader(CmsObject cms)
```
    Creates a new configuration reader.
    
    参数:
    cms - the CMS context which should be used to read the configuration data.
- 方法详细资料
  - getString
```
public static java.lang.String getString(CmsObject cms,
                         I_CmsXmlContentValueLocation location)
```
    Gets the string value of an XML content location.
    
    参数:
    cms - the CMS context to use
    location - an XML content location
    
    返回:
    the string value of that XML content location
  - parseProperty
```
public static CmsPropertyConfig parseProperty(CmsObject cms,
                              I_CmsXmlContentLocation field)
```
    Helper method to parse a property.
    
    参数:
    cms - the CMS context to use
    field - the location of the parent value
    
    返回:
    the parsed property configuration
  - getFunctionReferences
```
public java.util.List<CmsFunctionReference> getFunctionReferences()
```
    Returns the list of function references.
    
    返回:
    the list of function references
  - parseAddFormatters
```
public java.util.Set<java.lang.String> parseAddFormatters(I_CmsXmlContentLocation node)
```
    Parses the formatters to add.
    
    参数:
    node - the parent node
    
    返回:
    the set of keys of the formatters to add
  - parseConfiguration
```
public CmsADEConfigData parseConfiguration(java.lang.String basePath,
                                  CmsXmlContent content)
                                    throws CmsException
```
    Parses a configuration XML content and creates a configuration object from it.
    
    参数:
    basePath - the base path
    content - the XML content
    
    返回:
    the created configuration object with the data from the XML content
    
    抛出:
    
    CmsException - if something goes wrong
  - parseFolderOrName
```
public CmsFolderOrName parseFolderOrName(java.lang.String basePath,
                                I_CmsXmlContentLocation location)
                                  throws CmsException
```
    Parses a folder which may either be given as a path or as a folder name.
    
    参数:
    basePath - the base path for the configuration
    location - the XML content node from which to parse the folder
    
    返回:
    the folder bean
    
    抛出:
    
    CmsException - if something goes wrong
  - parseFormatter
```
public CmsFormatterBean parseFormatter(java.lang.String typeName,
                              I_CmsXmlContentLocation node)
```
    Parses a formatter bean.
    
    参数:
    typeName - the type name for which the formatter is being parsed
    node - the node from which to parse the formatter data
    
    返回:
    the formatter bean from the XML
  - parseModelPage
```
public void parseModelPage(I_CmsXmlContentLocation node)
                    throws CmsException
```
    Parses model page data from the XML content.
    
    参数:
    node - the XML content node
    
    抛出:
    
    CmsException - if something goes wrong
  - parseRemoveFormatters
```
public java.util.Set<java.lang.String> parseRemoveFormatters(I_CmsXmlContentLocation node)
```
    Parses the set of formatters to remove.
    
    参数:
    node - the parent node
    
    返回:
    the set of formatters to remove
  - parseResourceTypeConfig
```
public void parseResourceTypeConfig(java.lang.String basePath,
                           I_CmsXmlContentLocation node)
                             throws CmsException
```
    Parses a resource type configuration element from the XML content.
    
    参数:
    basePath - the base path of the configuration
    node - the XML configuration node
    
    抛出:
    
    CmsException - if something goes wrong
  - parseSitemapConfiguration
```
public CmsADEConfigData parseSitemapConfiguration(java.lang.String basePath,
                                         CmsResource configRes)
                                           throws CmsException
```
    Parses the sitemap configuration given the configuration file and base path.
    
    参数:
    basePath - the base path
    configRes - the configuration file resource
    
    返回:
    the parsed configuration data
    
    抛出:
    
    CmsException - if something goes wrong
  - readModuleConfigurations
```
public CmsADEConfigData readModuleConfigurations()
```
    Reads the configurations of all modules and combines them into a single configuration object.
    
    返回:
    the combined configuration object
  - getBoolean
```
protected boolean getBoolean(I_CmsXmlContentLocation parent,
                 java.lang.String name)
```
    Helper method to read a boolean value from the XML.
    If the element is not found in the XML, false is returned.
    
    参数:
    parent - the parent node
    name - the name of the XML content value
    
    返回:
    the boolean value
  - getString
```
protected java.lang.String getString(I_CmsXmlContentValueLocation location)
```
    Gets the string value of an XML content location.
    
    参数:
    location - an XML content location
    
    返回:
    the string value of that XML content location
  - mergeConfigurations
```
protected CmsADEConfigData mergeConfigurations(java.util.List<CmsADEConfigData> configurations)
```
    Merges a list of multiple configuration objects into a single configuration object.
    
    参数:
    configurations - the list of configuration objects.
    
    返回:
    the merged configuration object
  - parseDetailPage
```
protected void parseDetailPage(I_CmsXmlContentLocation node)
                        throws CmsException
```
    Parses the detail pages from an XML content node.
    
    参数:
    node - the XML content node
    
    抛出:
    
    CmsException - if something goes wrong
  - parseFormatterChangeSet
```
protected CmsFormatterChangeSet parseFormatterChangeSet(I_CmsXmlContentLocation node)
```
    Parses the formatter change set.
    
    参数:
    node - the parent node
    
    返回:
    the formatter change set
  - parseFunctionReference
```
protected void parseFunctionReference(I_CmsXmlContentLocation node)
```
    Parses a function reference node.
    
    参数:
    node - the function reference node

类 CmsConfigurationReader

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

DEFAULT_LOCALE

N_ADD_FORMATTER

N_ADD_FORMATTERS

N_CREATE_CONTENTS_LOCALLY

N_DEFAULT

N_DESCRIPTION

N_DETAIL_PAGE

N_DETAIL_PAGES_DISABLED

N_DISABLED

N_DISCARD_MODEL_PAGES

N_DISCARD_PROPERTIES

N_DISCARD_TYPES

N_DISPLAY_NAME

N_ERROR

N_FOLDER

N_FORMATTER

N_FUNCTION

N_FUNCTION_REF

N_IS_DEFAULT

N_IS_PREVIEW

N_JSP

N_MAX_WIDTH

N_MIN_WIDTH

N_MODEL_PAGE

N_NAME

N_NAME_PATTERN

N_ORDER

N_PAGE

N_PATH

N_PREFER_FOLDER

N_PROPERTY

N_PROPERTY_NAME

N_REMOVE_FORMATTER

N_REMOVE_FORMATTERS

N_RESOURCE_TYPE

N_RULE_REGEX

N_RULE_TYPE

N_TYPE

N_TYPE_NAME

N_WIDGET

N_WIDGET_CONFIG

构造器详细资料

CmsConfigurationReader

方法详细资料

getString

parseProperty

getFunctionReferences

parseAddFormatters

parseConfiguration

parseFolderOrName

parseFormatter

parseModelPage

parseRemoveFormatters

parseResourceTypeConfig

parseSitemapConfiguration

readModuleConfigurations

getBoolean

getString

mergeConfigurations

parseDetailPage

parseFormatterChangeSet

parseFunctionReference