Package org.opencms.file

Class CmsPropertyDefinition

java.lang.Object

org.opencms.file.CmsPropertyDefinition

All Implemented Interfaces:

Cloneable, Comparable<CmsPropertyDefinition>

public class CmsPropertyDefinition
extends Object
implements Cloneable, Comparable<CmsPropertyDefinition>

Defines a property name, so that CmsProperty instances can be created with that name.

Since:

6.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CmsPropertyDefinition.CmsPropertyType	Enumeration class for property types.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME_CONSTRAINTS	The name constraints when generating new properties.
static final String	PROPERTY_ACTIV	Property for the active method in the administration view.
static final String	PROPERTY_AVAILABLE_LOCALES	Property for the allowed set of locales.
static final String	PROPERTY_BODY_CLASS	Property to control the Java class for body.
static final String	PROPERTY_CACHE	The name of the VFS property that controls the caching.
static final String	PROPERTY_CATEGORY_BACKGROUND	Property for configuring background color for a category in the explorer's category column.
static final String	PROPERTY_CATEGORY_HIDDEN	Property used to hide categories from the category widgets in the page/content editor.
static final String	PROPERTY_CATEGORY_REPOSITORY	The property to read an additional category folder from.
static final String	PROPERTY_CONTAINER_INFO	Property to define the function detail container for a template.
static final String	PROPERTY_CONTENT_CONVERSION	Property for the content conversion.
static final String	PROPERTY_CONTENT_ENCODING	Property for the content encoding.
static final String	PROPERTY_CONTENT_NAME_PATTERN	If configured on a folder, when copying contents in the folder or any of its subfolders through ADE, the copies will be placed in the same folder as the original, and given a file name according to the name pattern.
static final String	PROPERTY_COPYRIGHT	Property for the content encoding.
static final String	PROPERTY_DEFAULT_FILE	Property for the default file in folders.
static final String	PROPERTY_DELETE_EXPIRED	Property for the days a resource has to be expired to be deleted by the CmsDeleteExpiredResourcesJob.
static final String	PROPERTY_DESCRIPTION	Property for the description.
static final String	PROPERTY_DESCRIPTION_HTML	Property for the description in HTML format.
static final String	PROPERTY_DISPLAY_ORDER	Property to set the display order of a content in lists.
static final String	PROPERTY_ELEMENT_MODEL	The name of the property which controls whether an element will be used as a copy model by the container page editor.
static final String	PROPERTY_ELEMENT_REPLACEMENTS	May contain a path to an element replacement configuration, for use in the 'copy page' dialog.
static final String	PROPERTY_ENABLE_NOTIFICATION	Property for the resource title.
static final String	PROPERTY_EXPORT	Property for the static export.
static final String	PROPERTY_EXPORT_TYPE	Property used to record the resource type for resources whose type is unknown at import time, so they can be exported with that type later.
static final String	PROPERTY_EXPORTNAME	Property for the resource export name, during export this name is used instead of the resource name.
static final String	PROPERTY_EXPORTSUFFIX	Property for JSP additional suffix during static export, default is "html".
static final String	PROPERTY_FOLDERS_AVAILABLE	Property to control the folders where template or default bodies should be available.
static final String	PROPERTY_GALLERIES_FOLDER	Property stating where to create new gallery folders.
static final String	PROPERTY_GOOGLE_API_KEY	Property containing the maps API key.
static final String	PROPERTY_GOOGLE_API_KEY_WORKPLACE	Property containing the maps API key.
static final String	PROPERTY_HISTORY_REMOVE_DELETED	Property to control whether historic versions should be removed when deleted resources are published.
static final String	PROPERTY_IMAGE_FOCAL_POINT	Name of the property in which the focal point is stored.
static final String	PROPERTY_IMAGE_SIZE	Property constant for "image.size".
static final String	PROPERTY_INSTANCEDATE_COPYFIELD	The property for defining the date (as Solr field) that should be used for sorting in lists.
static final String	PROPERTY_KEYWORDS	Property for the keywords.
static final String	PROPERTY_LINKS_FORCEABSOLUTE_ENABLED	Property to enable __forceAbsoluteLinks request parameter for a resource.
static final String	PROPERTY_LOCALE	Property for the current locale.
static final String	PROPERTY_LOCALE_INDEPENDENT_DETAILS	Property to mark detail pages to have locale independent detail only containers.
static final String	PROPERTY_LOCALE_NOTRANSLATION	Property for the 'do not translate' marking in the sitemap editor.
static final String	PROPERTY_LOGIN_FORM	Property for the login form.
static final String	PROPERTY_NAVIMAGE	Property constant for "NavImage".
static final String	PROPERTY_NAVINFO	Property constant for "NavInfo".
static final String	PROPERTY_NAVPOS	Property for the navigation position.
static final String	PROPERTY_NAVTEXT	Property for the navigation text.
static final String	PROPERTY_NOTIFICATION_INTERVAL	Property for the resource title.
static final String	PROPERTY_RELATIVEROOT	Property for the relative root link substitution.
static final String	PROPERTY_RESTYPES_AVAILABLE	Property name that defines the available resource types for the "new" dialog.
static final String	PROPERTY_SEARCH_CATEGORY	Property to sort search results in categories.
static final String	PROPERTY_SEARCH_EXCLUDE	Property to exclude individual resources from search index generation.
static final String	PROPERTY_SEARCH_EXCLUDE_ONLINE	Property to exclude individual resources from search results online (Solr only).
static final String	PROPERTY_SEARCH_PRIORITY	Property to boost certain search results.
static final String	PROPERTY_SECONDARY_LOCALES	Property for secondary locales for use in the locale compare view in the sitemap editor.
static final String	PROPERTY_SECURE	Property for the secure transmission of resources.
static final String	PROPERTY_STYLESHEET	Property for the stylesheet of files.
static final String	PROPERTY_TEMPLATE	Property to control the template.
static final String	PROPERTY_TEMPLATE_COMPATILIBITY	Property to customize for which templates elements should be displayed in the gallery when using the CmsTransformerTemplateProvider.
static final String	PROPERTY_TEMPLATE_DISPLAY_TYPES	Property for specifying a list of container types used to match formatters in the display formatter selection widget.
static final String	PROPERTY_TEMPLATE_ELEMENTS	Property to control the template elements.
static final String	PROPERTY_TEMPLATE_IMAGE	Property for the template image.
static final String	PROPERTY_TEMPLATE_PROVIDER	Property to configure the value which should be used instead of the template path when selecting the template in the GUI.
static final String	PROPERTY_TITLE	Property for the resource title.
static final String	PROPERTY_UDR_CONFIG	Property for user data request configuration.
static final String	PROPERTY_UDR_DEFAULTOU	Property used to configure default organizational unit.
static final String	PROPERTY_URLNAME_REPLACE	Name of the property used to control whether mapped URL names should replace previous URL names.
static final String	PROPERTY_VISIBLE	Property for the visible method in the administration view.
static final String	PROPERTY_XMLSITEMAP_CHANGEFREQ	Property for the XML sitemap change frequency.
static final String	PROPERTY_XMLSITEMAP_PRIORITY	Property for the XML sitemap priority.
static final int	PROPERYDEFINITION_RESOURCE	The property definition type for resources.
static final CmsPropertyDefinition.CmsPropertyType	TYPE_LINK	Property value is treated as a link or list of links.
static final CmsPropertyDefinition.CmsPropertyType	TYPE_NORMAL	Property value is not a link.

Constructor Summary

Constructors

Constructor	Description
CmsPropertyDefinition(CmsUUID id, String name)	Creates a new property definition object with the type TYPE_NORMAL.
CmsPropertyDefinition(CmsUUID id, String name, CmsPropertyDefinition.CmsPropertyType propertyType)	Creates a new property definition object.

Method Summary

Modifier and Type	Method	Description
static void	checkPropertyName(String name)	Checks if the provided property name is a valid property name, that is contains only valid characters.
Object	clone()	Returns a clone of this Objects instance.
int	compareTo(CmsPropertyDefinition obj)
boolean	equals(Object obj)
CmsUUID	getId()	Returns the id of this property definition.
String	getName()	Returns the name of this property definition.
static CmsPropertyDefinition	getNullPropertyDefinition()	Returns the null property definition.
CmsPropertyDefinition.CmsPropertyType	getType()	Returns the the type of this property definition.
int	hashCode()
void	setType(CmsPropertyDefinition.CmsPropertyType type)	Sets the type for this property definition.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

NAME_CONSTRAINTS

public static final String NAME_CONSTRAINTS

The name constraints when generating new properties.

See Also:

• Constant Field Values

PROPERTY_ACTIV

public static final String PROPERTY_ACTIV

Property for the active method in the administration view.

See Also:

• Constant Field Values

PROPERTY_AVAILABLE_LOCALES

public static final String PROPERTY_AVAILABLE_LOCALES

Property for the allowed set of locales.

See Also:

• Constant Field Values

PROPERTY_BODY_CLASS

public static final String PROPERTY_BODY_CLASS

Property to control the Java class for body.

See Also:

• Constant Field Values

PROPERTY_CACHE

public static final String PROPERTY_CACHE

The name of the VFS property that controls the caching.

See Also:

• Constant Field Values

PROPERTY_CATEGORY_BACKGROUND

public static final String PROPERTY_CATEGORY_BACKGROUND

Property for configuring background color for a category in the explorer's category column.

See Also:

• Constant Field Values

PROPERTY_CATEGORY_HIDDEN

public static final String PROPERTY_CATEGORY_HIDDEN

Property used to hide categories from the category widgets in the page/content editor.

If this property is set to 'true' on a category, it should never be set to 'false' on one of its subcategory.

See Also:

• Constant Field Values

PROPERTY_CATEGORY_REPOSITORY

public static final String PROPERTY_CATEGORY_REPOSITORY

The property to read an additional category folder from.

See Also:

• Constant Field Values

PROPERTY_CONTAINER_INFO

public static final String PROPERTY_CONTAINER_INFO

Property to define the function detail container for a template.

See Also:

• Constant Field Values

PROPERTY_CONTENT_CONVERSION

public static final String PROPERTY_CONTENT_CONVERSION

Property for the content conversion.

See Also:

• Constant Field Values

PROPERTY_CONTENT_ENCODING

public static final String PROPERTY_CONTENT_ENCODING

Property for the content encoding.

See Also:

• Constant Field Values

PROPERTY_CONTENT_NAME_PATTERN

public static final String PROPERTY_CONTENT_NAME_PATTERN

If configured on a folder, when copying contents in the folder or any of its subfolders through ADE, the copies will be placed in the same folder as the original, and given a file name according to the name pattern.

See Also:

• Constant Field Values

PROPERTY_COPYRIGHT

public static final String PROPERTY_COPYRIGHT

Property for the content encoding.

See Also:

• Constant Field Values

PROPERTY_DEFAULT_FILE

public static final String PROPERTY_DEFAULT_FILE

Property for the default file in folders.

See Also:

• Constant Field Values

PROPERTY_DELETE_EXPIRED

public static final String PROPERTY_DELETE_EXPIRED

Property for the days a resource has to be expired to be deleted by the CmsDeleteExpiredResourcesJob.

See Also:

• Constant Field Values

PROPERTY_DESCRIPTION

public static final String PROPERTY_DESCRIPTION

Property for the description.

See Also:

• Constant Field Values

PROPERTY_DESCRIPTION_HTML

public static final String PROPERTY_DESCRIPTION_HTML

Property for the description in HTML format.

See Also:

• Constant Field Values

PROPERTY_DISPLAY_ORDER

public static final String PROPERTY_DISPLAY_ORDER

Property to set the display order of a content in lists.

See Also:

• Constant Field Values

PROPERTY_ELEMENT_MODEL

public static final String PROPERTY_ELEMENT_MODEL

The name of the property which controls whether an element will be used as a copy model by the container page editor.

See Also:

• Constant Field Values

PROPERTY_ELEMENT_REPLACEMENTS

public static final String PROPERTY_ELEMENT_REPLACEMENTS

May contain a path to an element replacement configuration, for use in the 'copy page' dialog.

See Also:

• Constant Field Values

PROPERTY_ENABLE_NOTIFICATION

public static final String PROPERTY_ENABLE_NOTIFICATION

Property for the resource title.

See Also:

• Constant Field Values

PROPERTY_EXPORT

public static final String PROPERTY_EXPORT

Property for the static export.

See Also:

• Constant Field Values

PROPERTY_EXPORT_TYPE

public static final String PROPERTY_EXPORT_TYPE

Property used to record the resource type for resources whose type is unknown at import time, so they can be exported with that type later.

See Also:

• Constant Field Values

PROPERTY_EXPORTNAME

public static final String PROPERTY_EXPORTNAME

Property for the resource export name, during export this name is used instead of the resource name.

See Also:

• Constant Field Values

PROPERTY_EXPORTSUFFIX

public static final String PROPERTY_EXPORTSUFFIX

Property for JSP additional suffix during static export, default is "html".

See Also:

• Constant Field Values

PROPERTY_FOLDERS_AVAILABLE

public static final String PROPERTY_FOLDERS_AVAILABLE

Property to control the folders where template or default bodies should be available.

See Also:

• Constant Field Values

PROPERTY_GALLERIES_FOLDER

public static final String PROPERTY_GALLERIES_FOLDER

Property stating where to create new gallery folders.

See Also:

• Constant Field Values

PROPERTY_GOOGLE_API_KEY

public static final String PROPERTY_GOOGLE_API_KEY

Property containing the maps API key.

See Also:

• Constant Field Values

PROPERTY_GOOGLE_API_KEY_WORKPLACE

public static final String PROPERTY_GOOGLE_API_KEY_WORKPLACE

Property containing the maps API key.

See Also:

• Constant Field Values

PROPERTY_HISTORY_REMOVE_DELETED

public static final String PROPERTY_HISTORY_REMOVE_DELETED

Property to control whether historic versions should be removed when deleted resources are published.

See Also:

• Constant Field Values

PROPERTY_IMAGE_FOCAL_POINT

public static final String PROPERTY_IMAGE_FOCAL_POINT

Name of the property in which the focal point is stored.

See Also:

• Constant Field Values

PROPERTY_IMAGE_SIZE

public static final String PROPERTY_IMAGE_SIZE

Property constant for "image.size".

See Also:

• Constant Field Values

PROPERTY_INSTANCEDATE_COPYFIELD

public static final String PROPERTY_INSTANCEDATE_COPYFIELD

The property for defining the date (as Solr field) that should be used for sorting in lists.

See Also:

• Constant Field Values

PROPERTY_KEYWORDS

public static final String PROPERTY_KEYWORDS

Property for the keywords.

See Also:

• Constant Field Values

PROPERTY_LINKS_FORCEABSOLUTE_ENABLED

public static final String PROPERTY_LINKS_FORCEABSOLUTE_ENABLED

Property to enable __forceAbsoluteLinks request parameter for a resource.

See Also:

• Constant Field Values

PROPERTY_LOCALE

public static final String PROPERTY_LOCALE

Property for the current locale.

See Also:

• Constant Field Values

PROPERTY_LOCALE_INDEPENDENT_DETAILS

public static final String PROPERTY_LOCALE_INDEPENDENT_DETAILS

Property to mark detail pages to have locale independent detail only containers.

See Also:

• Constant Field Values

PROPERTY_LOCALE_NOTRANSLATION

public static final String PROPERTY_LOCALE_NOTRANSLATION

Property for the 'do not translate' marking in the sitemap editor.

See Also:

• Constant Field Values

PROPERTY_LOGIN_FORM

public static final String PROPERTY_LOGIN_FORM

Property for the login form.

See Also:

• Constant Field Values

PROPERTY_NAVIMAGE

public static final String PROPERTY_NAVIMAGE

Property constant for "NavImage".

See Also:

• Constant Field Values

PROPERTY_NAVINFO

public static final String PROPERTY_NAVINFO

Property constant for "NavInfo".

See Also:

• Constant Field Values

PROPERTY_NAVPOS

public static final String PROPERTY_NAVPOS

Property for the navigation position.

See Also:

• Constant Field Values

PROPERTY_NAVTEXT

public static final String PROPERTY_NAVTEXT

Property for the navigation text.

See Also:

• Constant Field Values

PROPERTY_NOTIFICATION_INTERVAL

public static final String PROPERTY_NOTIFICATION_INTERVAL

Property for the resource title.

See Also:

• Constant Field Values

PROPERTY_RELATIVEROOT

public static final String PROPERTY_RELATIVEROOT

Property for the relative root link substitution.

See Also:

• Constant Field Values

PROPERTY_RESTYPES_AVAILABLE

public static final String PROPERTY_RESTYPES_AVAILABLE

Property name that defines the available resource types for the "new" dialog.

See Also:

• Constant Field Values

PROPERTY_SEARCH_CATEGORY

public static final String PROPERTY_SEARCH_CATEGORY

Property to sort search results in categories.

See Also:

• Constant Field Values

PROPERTY_SEARCH_EXCLUDE

public static final String PROPERTY_SEARCH_EXCLUDE

Property to exclude individual resources from search index generation.

See Also:

• Constant Field Values

PROPERTY_SEARCH_EXCLUDE_ONLINE

public static final String PROPERTY_SEARCH_EXCLUDE_ONLINE

Property to exclude individual resources from search results online (Solr only).

See Also:

• Constant Field Values

PROPERTY_SEARCH_PRIORITY

public static final String PROPERTY_SEARCH_PRIORITY

Property to boost certain search results.

See Also:

• Constant Field Values

PROPERTY_SECONDARY_LOCALES

public static final String PROPERTY_SECONDARY_LOCALES

Property for secondary locales for use in the locale compare view in the sitemap editor.

See Also:

• Constant Field Values

PROPERTY_SECURE

public static final String PROPERTY_SECURE

Property for the secure transmission of resources.

See Also:

• Constant Field Values

PROPERTY_STYLESHEET

public static final String PROPERTY_STYLESHEET

Property for the stylesheet of files.

See Also:

• Constant Field Values

PROPERTY_TEMPLATE

public static final String PROPERTY_TEMPLATE

Property to control the template.

See Also:

• Constant Field Values

PROPERTY_TEMPLATE_COMPATILIBITY

public static final String PROPERTY_TEMPLATE_COMPATILIBITY

Property to customize for which templates elements should be displayed in the gallery when using the CmsTransformerTemplateProvider.

See Also:

• Constant Field Values

PROPERTY_TEMPLATE_DISPLAY_TYPES

public static final String PROPERTY_TEMPLATE_DISPLAY_TYPES

Property for specifying a list of container types used to match formatters in the display formatter selection widget.

See Also:

• Constant Field Values

PROPERTY_TEMPLATE_ELEMENTS

public static final String PROPERTY_TEMPLATE_ELEMENTS

Property to control the template elements.

See Also:

• Constant Field Values

PROPERTY_TEMPLATE_IMAGE

public static final String PROPERTY_TEMPLATE_IMAGE

Property for the template image.

See Also:

• Constant Field Values

PROPERTY_TEMPLATE_PROVIDER

public static final String PROPERTY_TEMPLATE_PROVIDER

Property to configure the value which should be used instead of the template path when selecting the template in the GUI. Please note that this does not have to actually be a template provider configuration string, this is just the most common use case.

See Also:

• Constant Field Values

PROPERTY_TITLE

public static final String PROPERTY_TITLE

Property for the resource title.

See Also:

• Constant Field Values

PROPERTY_UDR_CONFIG

public static final String PROPERTY_UDR_CONFIG

Property for user data request configuration.

See Also:

• Constant Field Values

PROPERTY_UDR_DEFAULTOU

public static final String PROPERTY_UDR_DEFAULTOU

Property used to configure default organizational unit.

See Also:

• Constant Field Values

PROPERTY_URLNAME_REPLACE

public static final String PROPERTY_URLNAME_REPLACE

Name of the property used to control whether mapped URL names should replace previous URL names.

See Also:

• Constant Field Values

PROPERTY_VISIBLE

public static final String PROPERTY_VISIBLE

Property for the visible method in the administration view.

See Also:

• Constant Field Values

PROPERTY_XMLSITEMAP_CHANGEFREQ

public static final String PROPERTY_XMLSITEMAP_CHANGEFREQ

Property for the XML sitemap change frequency.

See Also:

• Constant Field Values

PROPERTY_XMLSITEMAP_PRIORITY

public static final String PROPERTY_XMLSITEMAP_PRIORITY

Property for the XML sitemap priority.

See Also:

• Constant Field Values

PROPERYDEFINITION_RESOURCE

public static final int PROPERYDEFINITION_RESOURCE

The property definition type for resources.

See Also:

• Constant Field Values

TYPE_LINK

public static final CmsPropertyDefinition.CmsPropertyType TYPE_LINK

Property value is treated as a link or list of links.

TYPE_NORMAL

public static final CmsPropertyDefinition.CmsPropertyType TYPE_NORMAL

Property value is not a link.

Constructor Details

CmsPropertyDefinition

public CmsPropertyDefinition(CmsUUID id,
 String name)

Creates a new property definition object with the type TYPE_NORMAL.

Parameters:

id - the id of the property definition

name - the name of the property definition

CmsPropertyDefinition

public CmsPropertyDefinition(CmsUUID id,
 String name,
 CmsPropertyDefinition.CmsPropertyType propertyType)

Creates a new property definition object.

Parameters:

id - the id of the property definition

name - the name of the property definition

propertyType - the type of the property

Method Details

checkPropertyName

public static void checkPropertyName(String name)
                              throws CmsIllegalArgumentException

Checks if the provided property name is a valid property name, that is contains only valid characters.

A property name can only be composed of digits, standard ASCII letters and the symbols defined in NAME_CONSTRAINTS.

Parameters:

name - the property name to check

Throws:

CmsIllegalArgumentException - if the given property name is not valid

getNullPropertyDefinition

public static CmsPropertyDefinition getNullPropertyDefinition()

Returns the null property definition.

Returns:

the null property definition

clone

public Object clone()

Returns a clone of this Objects instance.

Overrides:

clone in class Object

Returns:

a clone of this instance

compareTo

public int compareTo(CmsPropertyDefinition obj)

Specified by:

compareTo in interface Comparable<CmsPropertyDefinition>

See Also:

• Comparable.compareTo(java.lang.Object)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

• Object.equals(java.lang.Object)

getId

public CmsUUID getId()

Returns the id of this property definition.

Returns:

id the id of this Propertydefinition

getName

public String getName()

Returns the name of this property definition.

Returns:

name The name of this property definition

getType

public CmsPropertyDefinition.CmsPropertyType getType()

Returns the the type of this property definition.

Returns:

the type of this property definition

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

• Object.hashCode()

setType

public void setType(CmsPropertyDefinition.CmsPropertyType type)

Sets the type for this property definition.

Parameters:

type - the type to set

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()