Uses of Class
org.opencms.file.CmsProperty

Packages that use CmsProperty

Package	Description
org.opencms.ade.sitemap	Server side of the sitemap view.
org.opencms.cmis
org.opencms.db	Low-level database connection and access functionality.
org.opencms.db.generic	Generic (ANSI-SQL) implementation of the OpenCms database connector.
org.opencms.file	This important package provides the methods to access the OpenCms VFS repository with the permissions of an authenticated user.
org.opencms.file.types	The implementations of the core resource types for the VFS are located here.
org.opencms.file.wrapper	This package contains classes and interfaces used to access OpenCms through a wrapped CmsObject.
org.opencms.gwt	Provides core support for GWT.
org.opencms.importexport	Contains functions to import and export resources from the OpenCms VFS.
org.opencms.module	OpenCms modules provide a powerful, standardized way to extend the core OpenCms functionality.
org.opencms.monitor	Contains functions to monitor the OpenCms system status.
org.opencms.search.fields	These classes control the mapping of the OpenCms content to the Lucene search fields.
org.opencms.search.solr	The package contains the Solr search integration.
org.opencms.site.xmlsitemap	Contains classes related to XML sitemap generation.

Uses of CmsProperty in org.opencms.ade.sitemap

Methods in org.opencms.ade.sitemap with parameters of type CmsProperty

Modifier and Type	Method and Description
static CmsClientProperty	CmsVfsSitemapService.createClientProperty(CmsProperty prop, boolean preserveOrigin) Creates a client property bean from a server-side property.

Uses of CmsProperty in org.opencms.cmis

Methods in org.opencms.cmis that return types with arguments of type CmsProperty

Modifier and Type	Method and Description
protected java.util.List<CmsProperty>	A_CmsCmisRepository.getOpenCmsProperties(java.util.Map<java.lang.String,org.apache.chemistry.opencmis.commons.data.PropertyData<?>> properties) Helper method to create OpenCms property objects from a map of CMIS properties.

Uses of CmsProperty in org.opencms.db

Methods in org.opencms.db that return CmsProperty

Modifier and Type	Method and Description
CmsProperty	CmsDriverManager.readPropertyObject(CmsDbContext dbc, CmsResource resource, java.lang.String key, boolean search) Reads a property object from a resource specified by a property name.
CmsProperty	CmsDriverManager.readPropertyObject(CmsDbContext dbc, CmsResource resource, java.lang.String key, boolean search, java.util.Locale locale) Reads a property object from a resource specified by a property name.
CmsProperty	I_CmsVfsDriver.readPropertyObject(CmsDbContext dbc, java.lang.String key, CmsProject project, CmsResource resource) Reads a property object from the database specified by it's key name mapped to a resource.
CmsProperty	CmsSecurityManager.readPropertyObject(CmsRequestContext context, CmsResource resource, java.lang.String key, boolean search) Reads a property object from a resource specified by a property name.
CmsProperty	CmsSecurityManager.readPropertyObject(CmsRequestContext context, CmsResource resource, java.lang.String key, boolean search, java.util.Locale locale) Reads a property object from a resource specified by a property name.

Methods in org.opencms.db that return types with arguments of type CmsProperty

Modifier and Type	Method and Description
java.util.List<CmsProperty>	CmsDriverManager.readHistoryPropertyObjects(CmsDbContext dbc, I_CmsHistoryResource historyResource) Reads the list of all CmsProperty objects that belongs to the given historical resource.
java.util.List<CmsProperty>	CmsSecurityManager.readHistoryPropertyObjects(CmsRequestContext context, I_CmsHistoryResource resource) Reads the list of all CmsProperty objects that belong to the given historical resource.
java.util.List<CmsProperty>	I_CmsHistoryDriver.readProperties(CmsDbContext dbc, I_CmsHistoryResource historicalResource) Returns a list of all properties of a historical file or folder.
java.util.List<CmsProperty>	I_CmsVfsDriver.readPropertyObjects(CmsDbContext dbc, CmsProject project, CmsResource resource) Reads all property objects mapped to a specified resource from the database.
java.util.List<CmsProperty>	CmsDriverManager.readPropertyObjects(CmsDbContext dbc, CmsResource resource, boolean search) Reads all property objects mapped to a specified resource from the database.
java.util.List<CmsProperty>	CmsSecurityManager.readPropertyObjects(CmsRequestContext context, CmsResource resource, boolean search) Reads all property objects from a resource.

Methods in org.opencms.db with parameters of type CmsProperty

Modifier and Type	Method and Description
void	I_CmsVfsDriver.writePropertyObject(CmsDbContext dbc, CmsProject project, CmsResource resource, CmsProperty property) Writes a property object to the database mapped to a specified resource.
void	CmsDriverManager.writePropertyObject(CmsDbContext dbc, CmsResource resource, CmsProperty property) Writes a property for a specified resource.
void	CmsSecurityManager.writePropertyObject(CmsRequestContext context, CmsResource resource, CmsProperty property) Writes a property for a specified resource.

Method parameters in org.opencms.db with type arguments of type CmsProperty

Modifier and Type	Method and Description
CmsResource	CmsDriverManager.createResource(CmsDbContext dbc, java.lang.String resourcePath, CmsResource resource, byte[] content, java.util.List<CmsProperty> properties, boolean importCase) Creates a new resource with the provided content and properties.
CmsResource	CmsDriverManager.createResource(CmsDbContext dbc, java.lang.String resourcename, int type, byte[] content, java.util.List<CmsProperty> properties) Creates a new resource of the given resource type with the provided content and properties.
CmsResource	CmsSecurityManager.createResource(CmsRequestContext context, java.lang.String resourcePath, CmsResource resource, byte[] content, java.util.List<CmsProperty> properties) Creates a new resource with the provided content and properties.
CmsResource	CmsSecurityManager.createResource(CmsRequestContext context, java.lang.String resourcename, int type, byte[] content, java.util.List<CmsProperty> properties) Creates a new resource of the given resource type with the provided content and properties.
CmsResource	CmsDriverManager.createSibling(CmsDbContext dbc, CmsResource source, java.lang.String destination, java.util.List<CmsProperty> properties) Creates a new sibling of the source resource.
CmsResource	CmsSecurityManager.createSibling(CmsRequestContext context, CmsResource source, java.lang.String destination, java.util.List<CmsProperty> properties) Creates a new sibling of the source resource.
CmsResource	CmsSecurityManager.importResource(CmsRequestContext context, java.lang.String resourcePath, CmsResource resource, byte[] content, java.util.List<CmsProperty> properties, boolean importCase) Creates a new resource with the provided content and properties.
void	CmsDriverManager.replaceResource(CmsDbContext dbc, CmsResource resource, int type, byte[] content, java.util.List<CmsProperty> properties) Replaces the content, type and properties of a resource.
void	CmsSecurityManager.replaceResource(CmsRequestContext context, CmsResource resource, int type, byte[] content, java.util.List<CmsProperty> properties) Replaces the content, type and properties of a resource.
void	I_CmsHistoryDriver.writeProperties(CmsDbContext dbc, CmsResource resource, java.util.List<CmsProperty> properties, int publishTag) Writes the properties of a resource to the history.
void	I_CmsVfsDriver.writePropertyObjects(CmsDbContext dbc, CmsProject project, CmsResource resource, java.util.List<CmsProperty> properties) Writes a list of property objects to the database mapped to a specified resource.
void	CmsDriverManager.writePropertyObjects(CmsDbContext dbc, CmsResource resource, java.util.List<CmsProperty> properties, boolean updateState) Writes a list of properties for a specified resource.
void	CmsSecurityManager.writePropertyObjects(CmsRequestContext context, CmsResource resource, java.util.List<CmsProperty> properties) Writes a list of properties for a specified resource.
void	I_CmsHistoryDriver.writeResource(CmsDbContext dbc, CmsResource resource, java.util.List<CmsProperty> properties, int publishTag) Writes a resource to the history.

Uses of CmsProperty in org.opencms.db.generic

Methods in org.opencms.db.generic that return CmsProperty

Modifier and Type	Method and Description
CmsProperty	CmsVfsDriver.readPropertyObject(CmsDbContext dbc, java.lang.String key, CmsProject project, CmsResource resource)

Methods in org.opencms.db.generic that return types with arguments of type CmsProperty

Modifier and Type	Method and Description
java.util.List<CmsProperty>	CmsHistoryDriver.readProperties(CmsDbContext dbc, I_CmsHistoryResource resource)
java.util.List<CmsProperty>	CmsVfsDriver.readPropertyObjects(CmsDbContext dbc, CmsProject project, CmsResource resource)

Methods in org.opencms.db.generic with parameters of type CmsProperty

Modifier and Type	Method and Description
protected void	CmsUserDriver.internalWriteOrgUnitProperty(CmsDbContext dbc, CmsResource resource, CmsProperty property) Writes a property for an organizational unit resource, online AND offline.
void	CmsVfsDriver.writePropertyObject(CmsDbContext dbc, CmsProject project, CmsResource resource, CmsProperty property)

Method parameters in org.opencms.db.generic with type arguments of type CmsProperty

Modifier and Type	Method and Description
protected void	CmsHistoryDriver.internalAddToPropMap(java.util.Map<java.lang.String,CmsProperty> propertyMap, I_CmsHistoryResource resource, java.lang.String propertyKey, java.lang.String propertyValue, int mappingType) Updates the property map for the given resource with the given property data.
protected void	CmsProjectDriver.internalWriteHistory(CmsDbContext dbc, CmsResource resource, CmsResourceState state, java.util.List<CmsProperty> properties, CmsUUID publishHistoryId, int publishTag) Writes the needed history entries.
void	CmsHistoryDriver.writeProperties(CmsDbContext dbc, CmsResource resource, java.util.List<CmsProperty> properties, int publishTag)
void	CmsVfsDriver.writePropertyObjects(CmsDbContext dbc, CmsProject project, CmsResource resource, java.util.List<CmsProperty> properties)
void	CmsHistoryDriver.writeResource(CmsDbContext dbc, CmsResource resource, java.util.List<CmsProperty> properties, int publishTag)

Uses of CmsProperty in org.opencms.file

Methods in org.opencms.file that return CmsProperty

Modifier and Type	Method and Description
CmsProperty	CmsProperty.clone() Creates a clone of this property.
CmsProperty	CmsProperty.cloneAsProperty() Creates a clone of this property that already is of type CmsProperty.
static CmsProperty	CmsProperty.get(java.lang.String name, java.util.List<CmsProperty> list) Searches in a list for the first occurrence of a CmsProperty object with the given name.
static CmsProperty	CmsProperty.getNullProperty() Returns the null property object.
CmsProperty	CmsObject.readPropertyObject(CmsResource resource, java.lang.String property, boolean search) Reads a property object from a resource specified by a property name.
CmsProperty	CmsObject.readPropertyObject(CmsResource resource, java.lang.String property, boolean search, java.util.Locale locale) Reads the locale specific version of a property object from a resource specified by a property name.
CmsProperty	CmsObject.readPropertyObject(java.lang.String resourcePath, java.lang.String property, boolean search) Reads a property object from a resource specified by a property name.
CmsProperty	CmsObject.readPropertyObject(java.lang.String resourcePath, java.lang.String property, boolean search, java.util.Locale locale) Reads the locale specific version of a property object from a resource specified by a property name.
static CmsProperty	CmsProperty.wrapIfNull(CmsProperty prop) Wraps a null value into a null property, and returns all other values unchanged.

Methods in org.opencms.file that return types with arguments of type CmsProperty

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,CmsProperty>	CmsProperty.getPropertyMap(java.util.List<CmsProperty> list) Transforms a list of CmsProperty objects with structure and resource values into a map with CmsProperty object values keyed by property keys.
java.util.List<CmsProperty>	CmsObject.readHistoryPropertyObjects(I_CmsHistoryResource resource) Reads the list of all CmsProperty objects that belong to the given historical resource version.
java.util.List<CmsProperty>	CmsObject.readPropertyObjects(CmsResource resource, boolean search) Reads all property objects from a resource.
java.util.List<CmsProperty>	CmsObject.readPropertyObjects(java.lang.String resourcePath, boolean search) Reads all property objects from a resource.
static java.util.List<CmsProperty>	CmsProperty.setAutoCreatePropertyDefinitions(java.util.List<CmsProperty> list, boolean value) Calls setAutoCreatePropertyDefinition(boolean) for each property object in the given List with the given value parameter.
static java.util.List<CmsProperty>	CmsProperty.setFrozen(java.util.List<CmsProperty> list) Calls setFrozen(boolean) for each CmsProperty object in the given List if it is not already frozen.
static java.util.List<CmsProperty>	CmsProperty.toList(java.util.Map<java.lang.String,java.lang.String> map) Transforms a Map of String values into a list of CmsProperty objects with the property name set from the Map key, and the structure value set from the Map value.
static java.util.Map<java.lang.String,CmsProperty>	CmsProperty.toObjectMap(java.lang.Iterable<CmsProperty> properties) Stores a collection of properties in a map, with the property names as keys.

Methods in org.opencms.file with parameters of type CmsProperty

Modifier and Type	Method and Description
int	CmsProperty.compareTo(CmsProperty obj) Compares this property to another Object.
boolean	CmsProperty.isIdentical(CmsProperty property) Tests if a given CmsProperty is identical to this CmsProperty object.
static CmsProperty	CmsProperty.wrapIfNull(CmsProperty prop) Wraps a null value into a null property, and returns all other values unchanged.
void	CmsObject.writePropertyObject(java.lang.String resourcename, CmsProperty property) Writes a property for a specified resource.

Method parameters in org.opencms.file with type arguments of type CmsProperty

Modifier and Type	Method and Description
CmsResource	CmsObject.createResource(java.lang.String sitePath, CmsResource resource, byte[] content, java.util.List<CmsProperty> properties) Creates a resource with the given properties and content.
CmsResource	CmsObject.createResource(java.lang.String resourcename, I_CmsResourceType type, byte[] content, java.util.List<CmsProperty> properties) Creates a new resource of the given resource type with the provided content and properties.
CmsResource	CmsObject.createResource(java.lang.String resourcename, int type, byte[] content, java.util.List<CmsProperty> properties) Deprecated. Use CmsObject.createResource(String, I_CmsResourceType, byte[], List) instead. Resource types should always be referenced either by its type class (preferred) or by type name. Use of int based resource type references will be discontinued in a future OpenCms release.
CmsResource	CmsObject.createSibling(java.lang.String source, java.lang.String destination, java.util.List<CmsProperty> properties) Creates a new sibling of the source resource.
static CmsProperty	CmsProperty.get(java.lang.String name, java.util.List<CmsProperty> list) Searches in a list for the first occurrence of a CmsProperty object with the given name.
static java.util.Map<java.lang.String,CmsProperty>	CmsProperty.getPropertyMap(java.util.List<CmsProperty> list) Transforms a list of CmsProperty objects with structure and resource values into a map with CmsProperty object values keyed by property keys.
CmsResource	CmsObject.importResource(java.lang.String resourcename, CmsResource resource, byte[] content, java.util.List<CmsProperty> properties) Imports a resource to the OpenCms VFS.
void	CmsObject.replaceResource(java.lang.String resourcename, I_CmsResourceType type, byte[] content, java.util.List<CmsProperty> properties) Replaces the content, type and properties of a resource.
void	CmsObject.replaceResource(java.lang.String resourcename, int type, byte[] content, java.util.List<CmsProperty> properties) Deprecated. Use CmsObject.replaceResource(String, I_CmsResourceType, byte[], List) instead. Resource types should always be referenced either by its type class (preferred) or by type name. Use of int based resource type references will be discontinued in a future OpenCms release.
static java.util.List<CmsProperty>	CmsProperty.setAutoCreatePropertyDefinitions(java.util.List<CmsProperty> list, boolean value) Calls setAutoCreatePropertyDefinition(boolean) for each property object in the given List with the given value parameter.
static java.util.List<CmsProperty>	CmsProperty.setFrozen(java.util.List<CmsProperty> list) Calls setFrozen(boolean) for each CmsProperty object in the given List if it is not already frozen.
static java.util.Map<java.lang.String,java.lang.String>	CmsProperty.toMap(java.util.List<CmsProperty> list) Transforms a list of CmsProperty objects into a Map which uses the property name as Map key (String), and the property value as Map value (String).
static java.util.Map<java.lang.String,CmsProperty>	CmsProperty.toObjectMap(java.lang.Iterable<CmsProperty> properties) Stores a collection of properties in a map, with the property names as keys.
void	CmsObject.writePropertyObjects(CmsResource res, java.util.List<CmsProperty> properties) Writes a list of properties for a specified resource.
void	CmsObject.writePropertyObjects(java.lang.String resourcename, java.util.List<CmsProperty> properties) Writes a list of properties for a specified resource.

Uses of CmsProperty in org.opencms.file.types

Fields in org.opencms.file.types with type parameters of type CmsProperty

Modifier and Type	Field and Description
protected java.util.List<CmsProperty>	A_CmsResourceType.m_defaultProperties The list of configured default properties.

Methods in org.opencms.file.types that return types with arguments of type CmsProperty

Modifier and Type	Method and Description
java.util.List<CmsProperty>	CmsResourceTypeLocaleIndependentXmlContent.getConfiguredDefaultProperties()
java.util.List<CmsProperty>	A_CmsResourceType.getConfiguredDefaultProperties() Returns the default properties for this resource type in an unmodifiable List.
java.util.List<CmsProperty>	I_CmsResourceType.getConfiguredDefaultProperties() Returns the configured default properties for this resource type in an unmodifiable List.
java.util.List<CmsProperty>	CmsResourceTypeImage.CmsImageAdjuster.getProperties() Returns the image properties.
protected java.util.List<CmsProperty>	A_CmsResourceType.processDefaultProperties(java.util.List<CmsProperty> properties, CmsMacroResolver resolver) Returns a list of property objects that are attached to the resource on creation.
protected java.util.List<CmsProperty>	CmsResourceTypeImage.tryAddImageSizeFromSvg(byte[] content, java.util.List<CmsProperty> properties) Tries to use the viewbox from the SVG data to determine the image size and add it to the list of properties.

Methods in org.opencms.file.types with parameters of type CmsProperty

Modifier and Type	Method and Description
void	A_CmsResourceType.addDefaultProperty(CmsProperty property) Adds a default property to this resource type, allowed only during the configuration phase.
void	A_CmsResourceType.writePropertyObject(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsProperty property)
void	I_CmsResourceType.writePropertyObject(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsProperty property) Writes a property for a specified resource.

Method parameters in org.opencms.file.types with type arguments of type CmsProperty

Modifier and Type	Method and Description
CmsResource	A_CmsResourceTypeFolderBase.createResource(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	CmsResourceTypeXmlContainerPage.createResource(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	CmsResourceTypeImage.createResource(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	CmsResourceTypeXmlPage.createResource(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	A_CmsResourceType.createResource(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	I_CmsResourceType.createResource(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, byte[] content, java.util.List<CmsProperty> properties) Creates a new resource of the given resource type with the provided content and properties.
CmsResource	CmsResourceTypeXmlContent.createResource(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	A_CmsResourceType.createSibling(CmsObject cms, CmsSecurityManager securityManager, CmsResource source, java.lang.String destination, java.util.List<CmsProperty> properties)
CmsResource	I_CmsResourceType.createSibling(CmsObject cms, CmsSecurityManager securityManager, CmsResource source, java.lang.String destination, java.util.List<CmsProperty> properties) Creates a new sibling of the source resource.
protected java.util.Locale	CmsResourceTypeLocaleIndependentXmlContent.getLocaleForNewContent(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, java.util.List<CmsProperty> properties) This overridden method ensures that configurations will always be created with an english locale node.
protected java.util.Locale	CmsResourceTypeXmlAdeConfiguration.getLocaleForNewContent(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, java.util.List<CmsProperty> properties) This overridden method ensures that configurations will always be created with an english locale node.
protected java.util.Locale	CmsResourceTypeXmlContent.getLocaleForNewContent(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, java.util.List<CmsProperty> properties) Gets the locale which should be used for creating an empty content.
CmsResource	CmsResourceTypeImage.importResource(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, CmsResource resource, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	A_CmsResourceType.importResource(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, CmsResource resource, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	I_CmsResourceType.importResource(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, CmsResource resource, byte[] content, java.util.List<CmsProperty> properties) Imports a resource to the OpenCms VFS.
protected java.util.List<CmsProperty>	A_CmsResourceType.processDefaultProperties(java.util.List<CmsProperty> properties, CmsMacroResolver resolver) Returns a list of property objects that are attached to the resource on creation.
void	A_CmsResourceType.replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, I_CmsResourceType type, byte[] content, java.util.List<CmsProperty> properties)
void	I_CmsResourceType.replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, I_CmsResourceType type, byte[] content, java.util.List<CmsProperty> properties) Replaces the content, type and properties of a resource.
void	A_CmsResourceTypeFolderBase.replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type, byte[] content, java.util.List<CmsProperty> properties)
void	CmsResourceTypeImage.replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type, byte[] content, java.util.List<CmsProperty> properties)
void	CmsResourceTypePlain.replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type, byte[] content, java.util.List<CmsProperty> properties)
void	A_CmsResourceType.replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type, byte[] content, java.util.List<CmsProperty> properties) Deprecated. Use A_CmsResourceType.replaceResource(CmsObject, CmsSecurityManager, CmsResource, I_CmsResourceType, byte[], List) instead. Resource types should always be referenced either by its type class (preferred) or by type name. Use of int based resource type references will be discontinued in a future OpenCms release.
void	I_CmsResourceType.replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type, byte[] content, java.util.List<CmsProperty> properties) Deprecated. Use I_CmsResourceType.replaceResource(CmsObject, CmsSecurityManager, CmsResource, I_CmsResourceType, byte[], List) instead. Resource types should always be referenced either by this type class (preferred) or by type name. Use of int based resource type references will be discontinued in a future OpenCms release.
void	CmsResourceTypeJsp.replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type, byte[] content, java.util.List<CmsProperty> properties)
protected java.util.List<CmsProperty>	CmsResourceTypeImage.tryAddImageSizeFromSvg(byte[] content, java.util.List<CmsProperty> properties) Tries to use the viewbox from the SVG data to determine the image size and add it to the list of properties.
void	A_CmsResourceType.writePropertyObjects(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, java.util.List<CmsProperty> properties)
void	I_CmsResourceType.writePropertyObjects(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, java.util.List<CmsProperty> properties) Writes a list of properties for a specified resource.

Constructor parameters in org.opencms.file.types with type arguments of type CmsProperty

Constructor and Description
CmsImageAdjuster(byte[] content, java.lang.String rootPath, java.util.List<CmsProperty> properties, CmsImageScaler downScaler) Creates a new image data container.

Uses of CmsProperty in org.opencms.file.wrapper

Methods in org.opencms.file.wrapper that return CmsProperty

Modifier and Type	Method and Description
CmsProperty	CmsObjectWrapper.readPropertyObject(CmsResource resource, java.lang.String property, boolean search) Delegate method for CmsObject.readPropertyObject(CmsResource, String, boolean).

Method parameters in org.opencms.file.wrapper with type arguments of type CmsProperty

Modifier and Type	Method and Description
CmsResource	CmsResourceWrapperReplaceDeleted.createResource(CmsObject cms, java.lang.String resourcename, int type, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	CmsResourceWrapperXmlPage.createResource(CmsObject cms, java.lang.String resourcename, int type, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	A_CmsResourceExtensionWrapper.createResource(CmsObject cms, java.lang.String resourcename, int type, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	CmsResourceWrapperPropertyFile.createResource(CmsObject cms, java.lang.String resourcename, int type, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	CmsResourceWrapperModules.createResource(CmsObject cms, java.lang.String resourcename, int type, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	A_CmsResourceWrapper.createResource(CmsObject cms, java.lang.String resourcename, int type, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	CmsResourceWrapperPreventCreateNameCI.createResource(CmsObject cms, java.lang.String resourcepath, int type, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	I_CmsResourceWrapper.createResource(CmsObject cms, java.lang.String resourcename, int type, byte[] content, java.util.List<CmsProperty> properties) Creates a new resource of the given resource type with the provided content and properties.
CmsResource	CmsObjectWrapper.createResource(java.lang.String resourcename, int type, byte[] content, java.util.List<CmsProperty> properties) Creates a new resource of the given resource type with the provided content and properties.

Uses of CmsProperty in org.opencms.gwt

Methods in org.opencms.gwt that return types with arguments of type CmsProperty

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,CmsProperty>	CmsGwtService.getPropertiesByName(java.util.List<CmsProperty> properties) Converts a list of properties to a map.
protected java.util.Map<java.lang.String,CmsProperty>	CmsPropertyEditorHelper.getPropertiesByName(java.util.List<CmsProperty> properties) Converts a list of properties to a map.

Method parameters in org.opencms.gwt with type arguments of type CmsProperty

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,CmsClientProperty>	CmsPropertyEditorHelper.convertProperties(java.util.List<CmsProperty> properties) Converts CmsProperty objects to CmsClientProperty objects.
protected java.util.Map<java.lang.String,CmsProperty>	CmsGwtService.getPropertiesByName(java.util.List<CmsProperty> properties) Converts a list of properties to a map.
protected java.util.Map<java.lang.String,CmsProperty>	CmsPropertyEditorHelper.getPropertiesByName(java.util.List<CmsProperty> properties) Converts a list of properties to a map.

Uses of CmsProperty in org.opencms.importexport

Fields in org.opencms.importexport with type parameters of type CmsProperty

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.util.List<CmsProperty>>	A_CmsImport.m_linkPropertyStorage Deprecated. Storage for all pointer properties which must be converted into links.
protected java.util.Map<java.lang.String,CmsProperty>	CmsImportVersion10.m_properties The map of properties for current imported resource.

Methods in org.opencms.importexport that return types with arguments of type CmsProperty

Modifier and Type	Method and Description
protected java.util.List<CmsProperty>	A_CmsImport.readPropertiesFromManifest(org.dom4j.Element parentElement, java.util.List<java.lang.String> ignoredPropertyKeys) Deprecated. Reads all properties below a specified parent element from the manifest.xml.

Methods in org.opencms.importexport with parameters of type CmsProperty

Modifier and Type	Method and Description
protected boolean	CmsExport.isIgnoredProperty(CmsProperty property) Checks if a property should be written to the export or not.

Method parameters in org.opencms.importexport with type arguments of type CmsProperty

Modifier and Type	Method and Description
protected java.util.Locale	A_CmsImport.getLocale(java.lang.String destination, java.util.List<CmsProperty> properties) Deprecated. Returns the appropriate locale for the given destination.
protected CmsResource	CmsImportVersion5.importResource(java.lang.String source, java.lang.String destination, I_CmsResourceType type, java.lang.String uuidstructure, java.lang.String uuidresource, long datelastmodified, java.lang.String userlastmodified, long datecreated, java.lang.String usercreated, long datereleased, long dateexpired, java.lang.String flags, java.util.List<CmsProperty> properties) Deprecated. Imports a resource (file or folder) into the cms.

Uses of CmsProperty in org.opencms.module

Methods in org.opencms.module that return types with arguments of type CmsProperty

Modifier and Type	Method and Description
java.util.Map<java.lang.String,CmsProperty>	CmsResourceImportData.getProperties() Gets the map of properties, with property names as keys.

Constructor parameters in org.opencms.module with type arguments of type CmsProperty

Constructor and Description
CmsResourceImportData(CmsResource resource, java.lang.String path, byte[] content, java.util.List<CmsProperty> properties, java.util.List<CmsAccessControlEntry> aces, java.util.List<CmsImportVersion10.RelationData> relationData, boolean hasStructureId, boolean hasDateLastModified) Creats a new instance.

Uses of CmsProperty in org.opencms.monitor

Methods in org.opencms.monitor that return CmsProperty

Modifier and Type	Method and Description
CmsProperty	CmsMemoryMonitor.getCachedProperty(java.lang.String key) Returns the property cached with the given cache key or null if not found.

Methods in org.opencms.monitor that return types with arguments of type CmsProperty

Modifier and Type	Method and Description
java.util.List<CmsProperty>	CmsMemoryMonitor.getCachedPropertyList(java.lang.String key) Returns the property list cached with the given cache key or null if not found.

Methods in org.opencms.monitor with parameters of type CmsProperty

Modifier and Type	Method and Description
void	CmsMemoryMonitor.cacheProperty(java.lang.String key, CmsProperty property) Caches the given property under the given cache key.

Method parameters in org.opencms.monitor with type arguments of type CmsProperty

Modifier and Type	Method and Description
void	CmsMemoryMonitor.cachePropertyList(java.lang.String key, java.util.List<CmsProperty> propertyList) Caches the given property list under the given cache key.

Uses of CmsProperty in org.opencms.search.fields

Method parameters in org.opencms.search.fields with type arguments of type CmsProperty

Modifier and Type	Method and Description
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendAdditionalValuesToDcoument(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Overriding this method allows to append some 'extra' values/fields to a document without overriding the CmsSearchFieldConfiguration.createDocument(org.opencms.file.CmsObject, org.opencms.file.CmsResource, org.opencms.search.I_CmsSearchIndex, org.opencms.search.extractors.I_CmsExtractionResult) method itself.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendAdditionalValuesToDcoument(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Overriding this method allows to append some 'extra' values/fields to a document without overriding the CmsSearchFieldConfiguration.createDocument(org.opencms.file.CmsObject, org.opencms.file.CmsResource, org.opencms.search.I_CmsSearchIndex, org.opencms.search.extractors.I_CmsExtractionResult) method itself.
protected I_CmsSearchDocument	CmsSearchFieldConfigurationOldCategories.appendCategories(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by resource category information based on properties.
protected I_CmsSearchDocument	CmsSearchFieldConfigurationOldCategories.appendCategories(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by resource category information based on properties.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendCategories(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by resource category information based on properties.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendCategories(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by resource category information based on properties.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendContentBlob(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by a field that contains the extracted content blob.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendContentBlob(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by a field that contains the extracted content blob.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendDates(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by fields for date of creation, content and last modification.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendDates(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by fields for date of creation, content and last modification.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendFieldMapping(I_CmsSearchDocument document, CmsSearchField field, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by the mappings for the given field.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendFieldMapping(I_CmsSearchDocument document, CmsSearchField field, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by the mappings for the given field.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendFieldMappings(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by the configured field mappings.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendFieldMappings(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by the configured field mappings.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendFileSize(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by the "size" field.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendFileSize(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by the "size" field.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendLocales(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by the "res_locales" field.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendLocales(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by the "res_locales" field.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendPath(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by fields for VFS path lookup.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendPath(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by fields for VFS path lookup.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendProperties(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Appends all direct properties, that are not empty or white space only to the document.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendProperties(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Appends all direct properties, that are not empty or white space only to the document.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendType(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by a field that contains the resource type name.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendType(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by a field that contains the resource type name.
java.lang.String	CmsSearchFieldMapping.getStringValue(CmsObject cms, CmsResource res, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched)
java.lang.String	CmsSearchFieldMapping.getStringValue(CmsObject cms, CmsResource res, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched)
java.lang.String	I_CmsSearchFieldMapping.getStringValue(CmsObject cms, CmsResource res, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Returns the String value extracted form the provided data according to the rules of this mapping type.
java.lang.String	I_CmsSearchFieldMapping.getStringValue(CmsObject cms, CmsResource res, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Returns the String value extracted form the provided data according to the rules of this mapping type.

Uses of CmsProperty in org.opencms.search.solr

Method parameters in org.opencms.search.solr with type arguments of type CmsProperty

Modifier and Type	Method and Description
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendAdditionalValuesToDcoument(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendAdditionalValuesToDcoument(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendDates(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendDates(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendFieldMapping(I_CmsSearchDocument document, CmsSearchField sfield, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendFieldMapping(I_CmsSearchDocument document, CmsSearchField sfield, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendFieldMappings(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendFieldMappings(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendLocales(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendLocales(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendProperties(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendProperties(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched)

Uses of CmsProperty in org.opencms.site.xmlsitemap

Method parameters in org.opencms.site.xmlsitemap with type arguments of type CmsProperty

Modifier and Type	Method and Description
protected static java.lang.String	CmsXmlSitemapGenerator.getChangeFrequency(java.util.List<CmsProperty> properties) Gets the change frequency for a sitemap entry from a list of properties.
protected static double	CmsXmlSitemapGenerator.getPriority(java.util.List<CmsProperty> properties) Gets the page priority from a list of properties.