Package org.opencms.ade.configuration

Class CmsADEConfigDataInternal

java.lang.Object

org.opencms.ade.configuration.CmsADEConfigDataInternal

public class CmsADEConfigDataInternal
extends java.lang.Object

Represents a parsed sitemap or module configuration.

This is the internal representation stored in the cache. The configuration class which is actually returned by CmsADEManager, and which contains most of the logic related to sitemap configurations, is CmsADEConfigData.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CmsADEConfigDataInternal.AttributeValue	Represents the value of an attribute, with additional information about where the value originated from.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_createContentsLocally	The "create contents locally" flag.
protected boolean	m_discardInheritedModelPages	Should inherited model pages be discarded?
protected boolean	m_discardInheritedTypes	Should inherited types be discarded?
protected org.opencms.ade.configuration.CmsConfigurationReader.DiscardPropertiesMode	m_discardPropertiesMode	The 'discard properties' mode.
protected CmsFormatterChangeSet	m_formatterChangeSet	The configured formatter changes.
protected boolean	m_includeInSiteSelector	True if subsite should be included in site selector.
protected boolean	m_isModuleConfig	True if this is a module configuration, not a normal sitemap configuration.
protected java.util.List<CmsUUID>	m_masterConfigs	The master configuration structure ids.
protected java.lang.Boolean	m_useFormatterKeys	Mode for using formatter keys / the new container page format.

Constructor Summary

Constructors

Modifier	Constructor	Description
	CmsADEConfigDataInternal(java.lang.String basePath)	Creates an empty configuration data object with a given base path.
	CmsADEConfigDataInternal(CmsObject cms, CmsResource resource, boolean isModuleConfig, java.lang.String basePath, java.util.List<CmsUUID> masterConfigs, java.util.List<CmsResourceTypeConfig> resourceTypeConfig, boolean discardInheritedTypes, java.util.List<CmsPropertyConfig> propertyConfig, org.opencms.ade.configuration.CmsConfigurationReader.DiscardPropertiesMode discardPropertiesMode, java.util.List<CmsDetailPageInfo> detailPageInfos, java.util.List<CmsModelPageConfigWithoutResource> modelPages, java.util.List<CmsFunctionReference> functionReferences, boolean discardInheritedModelPages, boolean createContentsLocally, boolean preferDetailPagesForLocalContents, boolean excludeExternalDetailContents, boolean includeInSiteSelector, CmsFormatterChangeSet formatterChangeSet, boolean removeAllFunctions, java.util.Set<CmsUUID> functionIds, java.util.Set<CmsUUID> functionsToRemove, java.lang.Boolean useFormatterKeys, CmsTypeOrderingMode orderingMode, java.util.Map<java.lang.String,java.lang.String> attributes)	Creates a new configuration data instance.
protected	CmsADEConfigDataInternal(CmsResource resource, boolean isModuleConfig, java.lang.String basePath, java.util.List<CmsUUID> masterConfigs, java.util.List<CmsResourceTypeConfig> resourceTypeConfig, boolean discardInheritedTypes, java.util.List<CmsPropertyConfig> propertyConfig, org.opencms.ade.configuration.CmsConfigurationReader.DiscardPropertiesMode discardPropertiesMode, java.util.List<CmsDetailPageInfo> detailPageInfos, java.util.List<CmsModelPageConfig> modelPages, java.util.List<CmsFunctionReference> functionReferences, boolean discardInheritedModelPages, boolean createContentsLocally, boolean preferDetailPagesForLocalContents, boolean excludeExternalDetailContents, boolean includeInSiteSelector, CmsFormatterChangeSet formatterChangeSet, boolean removeAllFunctions, java.util.Set<CmsUUID> functionIds)	Creates a new configuration data instance.

Method Summary

Modifier and Type	Method	Description
static CmsADEConfigDataInternal	emptyConfiguration(java.lang.String basePath)	Creates an empty configuration for a given base path.
java.util.Map<java.lang.String,CmsADEConfigDataInternal.AttributeValue>	getAttributes()	Gets the map of attributes for this sitemap configuration.
java.lang.String	getBasePath()	Gets the base path.
org.opencms.ade.configuration.CmsConfigurationReader.DiscardPropertiesMode	getDiscardPropertiesMode()	Gets the 'discard properties' mode.
java.util.Collection<CmsUUID>	getDynamicFunctions()	Returns the set of configured dynamic functions, regardless of whether the 'remove all formatters' option is enabled.
CmsFormatterChangeSet	getFormatterChangeSet()	Gets the formatter change set.
java.util.List<CmsFunctionReference>	getFunctionReferences()	Gets the dynamic function references.
java.util.Collection<CmsUUID>	getFunctionsToRemove()	Gets the ids of dynamic functions to remove.
java.util.List<CmsUUID>	getMasterConfigs()	Gets the structure ids of the master configuration files.
java.util.List<CmsDetailPageInfo>	getOwnDetailPages()	Returns the ownDetailPages.
java.util.List<CmsModelPageConfig>	getOwnModelPageConfig()	Returns the ownModelPageConfig.
java.util.List<CmsPropertyConfig>	getOwnPropertyConfigurations()	Returns the ownPropertyConfigurations.
java.util.List<CmsResourceTypeConfig>	getOwnResourceTypes()	Gets the resource types defined in this configuration.
CmsResource	getResource()	Returns the resource.
CmsTypeOrderingMode	getTypeOrderingMode()	Gets the type ordering mode.
java.lang.Boolean	getUseFormatterKeys()	Gets the 'use formatter keys' mode.
boolean	isCreateContentsLocally()	Returns true if contents should be created in the sub-sitemap.
boolean	isDiscardInheritedModelPages()	Returns true if inherited model pages should be discarded.
boolean	isDiscardInheritedProperties()	Returns true if inherited properties should be discarded.
boolean	isDiscardInheritedTypes()	Returns true if inherited types should be discarded.
boolean	isExcludeExternalDetailContents()	Returns true if detail pages inside this subsite (and descendant subsites) should not be used for contents outside the subsite (and descendant subsites).
boolean	isIncludeInSiteSelector()	Returns true if the subsite should be included in the site selector.
boolean	isModuleConfig()	Returns the isModuleConfig.
boolean	isPreferDetailPagesForLocalContents()	Returns true if detail pages from this sitemap should be preferred for creating links to detail contents located inside this sitemap.
boolean	isRemoveAllFunctions()	True if all functions should be removed by this sitemap configuration.
protected void	mergeParent(CmsADEConfigDataInternal parent)	Merges the parent's data into this object.
protected void	processModuleOrdering()	Handle the ordering from the module configurations.

Methods inherited from class java.lang.Object

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

Field Detail

m_createContentsLocally

protected boolean m_createContentsLocally

The "create contents locally" flag.

m_discardInheritedModelPages

protected boolean m_discardInheritedModelPages

Should inherited model pages be discarded?

m_discardInheritedTypes

protected boolean m_discardInheritedTypes

Should inherited types be discarded?

m_useFormatterKeys

protected java.lang.Boolean m_useFormatterKeys

Mode for using formatter keys / the new container page format.

m_discardPropertiesMode

protected org.opencms.ade.configuration.CmsConfigurationReader.DiscardPropertiesMode m_discardPropertiesMode

The 'discard properties' mode.

m_formatterChangeSet

protected CmsFormatterChangeSet m_formatterChangeSet

The configured formatter changes.

m_includeInSiteSelector

protected boolean m_includeInSiteSelector

True if subsite should be included in site selector.

m_isModuleConfig

protected boolean m_isModuleConfig

True if this is a module configuration, not a normal sitemap configuration.

m_masterConfigs

protected java.util.List<CmsUUID> m_masterConfigs

The master configuration structure ids.

Constructor Detail

CmsADEConfigDataInternal

public CmsADEConfigDataInternal(CmsObject cms,
                                CmsResource resource,
                                boolean isModuleConfig,
                                java.lang.String basePath,
                                java.util.List<CmsUUID> masterConfigs,
                                java.util.List<CmsResourceTypeConfig> resourceTypeConfig,
                                boolean discardInheritedTypes,
                                java.util.List<CmsPropertyConfig> propertyConfig,
                                org.opencms.ade.configuration.CmsConfigurationReader.DiscardPropertiesMode discardPropertiesMode,
                                java.util.List<CmsDetailPageInfo> detailPageInfos,
                                java.util.List<CmsModelPageConfigWithoutResource> modelPages,
                                java.util.List<CmsFunctionReference> functionReferences,
                                boolean discardInheritedModelPages,
                                boolean createContentsLocally,
                                boolean preferDetailPagesForLocalContents,
                                boolean excludeExternalDetailContents,
                                boolean includeInSiteSelector,
                                CmsFormatterChangeSet formatterChangeSet,
                                boolean removeAllFunctions,
                                java.util.Set<CmsUUID> functionIds,
                                java.util.Set<CmsUUID> functionsToRemove,
                                java.lang.Boolean useFormatterKeys,
                                CmsTypeOrderingMode orderingMode,
                                java.util.Map<java.lang.String,java.lang.String> attributes)

Creates a new configuration data instance.

Parameters:

cms - the CMS context

resource - the resource from which this configuration data was read

isModuleConfig - true if this is a module configuration

basePath - the base path

masterConfigs - structure ids of master configuration files

resourceTypeConfig - the resource type configuration

discardInheritedTypes - the "discard inherited types" flag

propertyConfig - the property configuration

discardPropertiesMode - the "discard inherited properties" mode

detailPageInfos - the detail page configuration

modelPages - the model page configuration

functionReferences - the function reference configuration

discardInheritedModelPages - the "discard inherited model pages" flag

createContentsLocally - the "create contents locally" flag

preferDetailPagesForLocalContents - the "preferDetailPagesForLocalContents" flag

excludeExternalDetailContents - the "excludeExternalDetailContents" flag

includeInSiteSelector - the "includeInSiteSelector" flag

formatterChangeSet - the formatter changes

removeAllFunctions - flag indicating whether all functions should be removed

functionIds - the dynamic functions available

functionsToRemove - the function ids to remove

useFormatterKeys - mode for using formatter keys / the new container page format

orderingMode - the mode used to order the resource types

attributes - the map of attributes

CmsADEConfigDataInternal

public CmsADEConfigDataInternal(java.lang.String basePath)

Creates an empty configuration data object with a given base path.

Parameters:

basePath - the base path

CmsADEConfigDataInternal

protected CmsADEConfigDataInternal(CmsResource resource,
                                   boolean isModuleConfig,
                                   java.lang.String basePath,
                                   java.util.List<CmsUUID> masterConfigs,
                                   java.util.List<CmsResourceTypeConfig> resourceTypeConfig,
                                   boolean discardInheritedTypes,
                                   java.util.List<CmsPropertyConfig> propertyConfig,
                                   org.opencms.ade.configuration.CmsConfigurationReader.DiscardPropertiesMode discardPropertiesMode,
                                   java.util.List<CmsDetailPageInfo> detailPageInfos,
                                   java.util.List<CmsModelPageConfig> modelPages,
                                   java.util.List<CmsFunctionReference> functionReferences,
                                   boolean discardInheritedModelPages,
                                   boolean createContentsLocally,
                                   boolean preferDetailPagesForLocalContents,
                                   boolean excludeExternalDetailContents,
                                   boolean includeInSiteSelector,
                                   CmsFormatterChangeSet formatterChangeSet,
                                   boolean removeAllFunctions,
                                   java.util.Set<CmsUUID> functionIds)

Creates a new configuration data instance.

Parameters:

resource - the resource from which this configuration data was read

isModuleConfig - true if this is a module configuration

basePath - the base path

masterConfigs - structure ids of master configuration files

resourceTypeConfig - the resource type configuration

discardInheritedTypes - the "discard inherited types" flag

propertyConfig - the property configuration

discardPropertiesMode - the "discard inherited properties" mode

detailPageInfos - the detail page configuration

modelPages - the model page configuration

functionReferences - the function reference configuration

discardInheritedModelPages - the "discard inherited model pages" flag

createContentsLocally - the "create contents locally" flag

preferDetailPagesForLocalContents - the "preferDetailPagesForLocalContents" flag

excludeExternalDetailContents - the "excludeExternalDetailContents" flag

includeInSiteSelector - the "includeInSiteSelector" flag

formatterChangeSet - the formatter changes

removeAllFunctions - flag indicating whether all functions should be removed

functionIds - the dynamic functions available

Method Detail

emptyConfiguration

public static CmsADEConfigDataInternal emptyConfiguration(java.lang.String basePath)

Creates an empty configuration for a given base path.

Parameters:

basePath - the base path

Returns:

the empty configuration object

getAttributes

public java.util.Map<java.lang.String,CmsADEConfigDataInternal.AttributeValue> getAttributes()

Gets the map of attributes for this sitemap configuration.

Returns:

the map of attributes

getBasePath

public java.lang.String getBasePath()

Gets the base path.

Returns:

the base path

getDiscardPropertiesMode

public org.opencms.ade.configuration.CmsConfigurationReader.DiscardPropertiesMode getDiscardPropertiesMode()

Gets the 'discard properties' mode.

Returns:

the discard properties mode

getDynamicFunctions

public java.util.Collection<CmsUUID> getDynamicFunctions()

Returns the set of configured dynamic functions, regardless of whether the 'remove all formatters' option is enabled.

Returns:

the dynamic functions

getFormatterChangeSet

public CmsFormatterChangeSet getFormatterChangeSet()

Gets the formatter change set.

Returns:

the formatter change set.

getFunctionReferences

public java.util.List<CmsFunctionReference> getFunctionReferences()

Gets the dynamic function references.

Returns:

the dynamic function references

getFunctionsToRemove

public java.util.Collection<CmsUUID> getFunctionsToRemove()

Gets the ids of dynamic functions to remove.

Returns:

the ids of dynamic functions to remove

getMasterConfigs

public java.util.List<CmsUUID> getMasterConfigs()

Gets the structure ids of the master configuration files.

Returns:

the structure ids of the master configurations

getOwnDetailPages

public java.util.List<CmsDetailPageInfo> getOwnDetailPages()

Returns the ownDetailPages.

Returns:

the ownDetailPages

getOwnModelPageConfig

public java.util.List<CmsModelPageConfig> getOwnModelPageConfig()

Returns the ownModelPageConfig.

Returns:

the ownModelPageConfig

getOwnPropertyConfigurations

public java.util.List<CmsPropertyConfig> getOwnPropertyConfigurations()

Returns the ownPropertyConfigurations.

Returns:

the ownPropertyConfigurations

getOwnResourceTypes

public java.util.List<CmsResourceTypeConfig> getOwnResourceTypes()

Gets the resource types defined in this configuration.

Returns:

the resource type configurations

getResource

public CmsResource getResource()

Returns the resource.

Returns:

the resource

getTypeOrderingMode

public CmsTypeOrderingMode getTypeOrderingMode()

Gets the type ordering mode.

Returns:

the type ordering mode

getUseFormatterKeys

public java.lang.Boolean getUseFormatterKeys()

Gets the 'use formatter keys' mode.

If true, container pages will be written in the new format, including using formatter keys when possible.

Returns:

the 'use formatter keys' mode

isCreateContentsLocally

public boolean isCreateContentsLocally()

Returns true if contents should be created in the sub-sitemap.

Returns:

true if contents should be created in the sub-sitemap

isDiscardInheritedModelPages

public boolean isDiscardInheritedModelPages()

Returns true if inherited model pages should be discarded.

Returns:

true if inherited model pages should be discarded.

isDiscardInheritedProperties

public boolean isDiscardInheritedProperties()

Returns true if inherited properties should be discarded.

Returns:

true if inherited property configurations should be discardded.

isDiscardInheritedTypes

public boolean isDiscardInheritedTypes()

Returns true if inherited types should be discarded.

Returns:

true if inherited types should be discarded

isExcludeExternalDetailContents

public boolean isExcludeExternalDetailContents()

Returns true if detail pages inside this subsite (and descendant subsites) should not be used for contents outside the subsite (and descendant subsites).

Returns:

true if external detail contents should be excluded

isIncludeInSiteSelector

public boolean isIncludeInSiteSelector()

Returns true if the subsite should be included in the site selector.

Returns:

true if the subsite should be included in the site selector

isModuleConfig

public boolean isModuleConfig()

Returns the isModuleConfig.

Returns:

the isModuleConfig

isPreferDetailPagesForLocalContents

public boolean isPreferDetailPagesForLocalContents()

Returns true if detail pages from this sitemap should be preferred for creating links to detail contents located inside this sitemap.

Returns:

true if detail pages from this sitemap should be preferred

isRemoveAllFunctions

public boolean isRemoveAllFunctions()

True if all functions should be removed by this sitemap configuration.

Returns:

true if all functions should be removed

mergeParent

protected void mergeParent(CmsADEConfigDataInternal parent)

Merges the parent's data into this object.

Parameters:

parent - the parent configuration data

processModuleOrdering

protected void processModuleOrdering()

Handle the ordering from the module configurations.