Uses of Class
org.opencms.xml.CmsXmlContentDefinition

Packages that use CmsXmlContentDefinition

Package	Description
org.opencms.ade.contenteditor	Contains server side classes for the XML content editor.
org.opencms.jsp.util	Utility classes to be used for JSP pages.
org.opencms.monitor	Contains functions to monitor the OpenCms system status.
org.opencms.search.solr	The package contains the Solr search integration.
org.opencms.xml	Basic XML functionality and utilities used by OpenCms to maintain XML documents and content.
org.opencms.xml.containerpage	Contains functions for the ADE main pages, commonly called "Container Pages" in OpenCms.
org.opencms.xml.content	Contains functions for structured content storage using XML, commonly called "XML content" in OpenCms.
org.opencms.xml.page	Contains functions for unstructured content storage using XML, commonly called "XML pages" in OpenCms.
org.opencms.xml.types	Contains the basic XML content type definitions, used for XML content and XML pages.
org.opencms.xml.xml2json

Uses of CmsXmlContentDefinition in org.opencms.ade.contenteditor

Methods in org.opencms.ade.contenteditor with parameters of type CmsXmlContentDefinition

Modifier and Type	Method	Description
static List<CmsTabInfo>	CmsContentTypeVisitor.collectTabInfos(CmsObject cms, CmsXmlContentDefinition definition, CmsMessages messages)	Returns the tab informations for the given content definition.
static void	CmsAccessRestrictionInfo.collectTypesByPath(CmsXmlContentDefinition definition, String path, Map<String,I_CmsXmlSchemaType> typesByPath)	Helper method for collecting all nested schema types of a content definition in a map.
static CmsWidgetUtil.WidgetInfo	CmsWidgetUtil.collectWidgetInfo(CmsObject cms, CmsXmlContentDefinition rootContentDefinition, String path, CmsMessages messages, Locale overrideLocale)	Collects widget information for a given content definition and content value path.
static CmsAccessRestrictionInfo	CmsAccessRestrictionInfo.getRestrictionInfo(CmsObject cms, CmsXmlContentDefinition contentDef)	Gets the restriction info for the current user and content definition.
static String	CmsContentService.getTypeUri(CmsXmlContentDefinition xmlContentDefinition)	Returns the type URI.
boolean	CmsContentTypeVisitor.isEditorCompatible(CmsXmlContentDefinition xmlContentDefinition)	Checks if the content type widgets are compatible with the new content editor.
protected Map<String,CmsType>	CmsContentService.readTypes(CmsXmlContentDefinition xmlContentDefinition, Locale locale)	Reads the types from the given content definition and adds the to the map of already registered types if necessary.
void	CmsContentTypeVisitor.visitTypes(CmsXmlContentDefinition xmlContentDefinition, Locale messageLocale)	Visits all types within the XML content definition.

Uses of CmsXmlContentDefinition in org.opencms.jsp.util

Methods in org.opencms.jsp.util that return CmsXmlContentDefinition

Modifier and Type	Method	Description
CmsXmlContentDefinition	CmsSchemaInfo.Field.getContentDefinition()	Gets the content definition.

Constructors in org.opencms.jsp.util with parameters of type CmsXmlContentDefinition

Modifier	Constructor	Description
	CmsSchemaInfo(CmsObject cms, CmsXmlContentDefinition contentDef)	Creates a new instance.
	Field(CmsXmlContentDefinition contentDef)	Creates a new instance for the root level of a schema.

Uses of CmsXmlContentDefinition in org.opencms.monitor

Methods in org.opencms.monitor that return CmsXmlContentDefinition

Modifier and Type	Method	Description
CmsXmlContentDefinition	CmsMemoryMonitor.getCachedContentDefinition(String key)	Returns the xml content definition cached with the given cache key or null if not found.

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

Modifier and Type	Method	Description
void	CmsMemoryMonitor.cacheContentDefinition(String key, CmsXmlContentDefinition contentDefinition)	Caches the given content definition under the given cache key.

Uses of CmsXmlContentDefinition in org.opencms.search.solr

Methods in org.opencms.search.solr with parameters of type CmsXmlContentDefinition

Modifier and Type	Method	Description
static void	CmsSolrDocumentXmlContent.collectSchemaXpathsForSimpleValues(CmsObject cms, CmsXmlContentDefinition def, String path, Set<String> result)	Collects a list of all possible XPaths for a content definition.

Uses of CmsXmlContentDefinition in org.opencms.xml

Methods in org.opencms.xml that return CmsXmlContentDefinition

Modifier and Type	Method	Description
CmsXmlContentDefinition	CmsXmlEntityResolver.getCachedContentDefinition(String systemId)	Looks up the given XML content definition system id in the internal content definition cache.
CmsXmlContentDefinition	I_CmsXmlDocument.getContentDefinition()	Returns the content definition object used for this XML document.
static CmsXmlContentDefinition	CmsXmlContentDefinition.getContentDefinitionForResource(CmsObject cms, CmsResource resource)	Factory method that returns the XML content definition instance for a given resource.
static CmsXmlContentDefinition	CmsXmlContentDefinition.getContentDefinitionForType(CmsObject cms, String typeName)	Reads the content definition which is configured for a resource type.
static CmsXmlContentDefinition	CmsXmlContentDefinition.unmarshal(byte[] xmlData, String schemaLocation, EntityResolver resolver)	Factory method to unmarshal (read) a XML content definition instance from a byte array that contains XML data.
static CmsXmlContentDefinition	CmsXmlContentDefinition.unmarshal(String xmlData, String schemaLocation, EntityResolver resolver)	Factory method to unmarshal (read) a XML content definition instance from a String that contains XML data.
static CmsXmlContentDefinition	CmsXmlContentDefinition.unmarshal(String schemaLocation, EntityResolver resolver)	Factory method to unmarshal (read) a XML content definition instance from a given XML schema location.
static CmsXmlContentDefinition	CmsXmlContentDefinition.unmarshal(org.dom4j.Document document, String schemaLocation)	Factory method to unmarshal (read) a XML content definition instance from a XML document.
static CmsXmlContentDefinition	CmsXmlContentDefinition.unmarshal(CmsObject cms, String resourcename)	Factory method to unmarshal (read) a XML content definition instance from the OpenCms VFS resource name.
static CmsXmlContentDefinition	CmsXmlContentDefinition.unmarshal(InputSource source, String schemaLocation, EntityResolver resolver)	Factory method to unmarshal (read) a XML content definition instance from a XML InputSource.

Methods in org.opencms.xml that return types with arguments of type CmsXmlContentDefinition

Modifier and Type	Method	Description
Set<CmsXmlContentDefinition>	CmsXmlContentDefinition.getIncludes()	Returns the set of nested (included) XML content definitions.

Methods in org.opencms.xml with parameters of type CmsXmlContentDefinition

Modifier and Type	Method	Description
void	CmsXmlContentDefinition.addInclude(CmsXmlContentDefinition nestedSchema)	Adds a nested (included) XML content definition.
void	CmsXmlEntityResolver.cacheContentDefinition(String systemId, CmsXmlContentDefinition contentDefinition)	Caches an XML content definition based on the given system id and the online / offline status of this entity resolver instance.
protected abstract void	A_CmsXmlDocument.initDocument(org.dom4j.Document document, String encoding, CmsXmlContentDefinition contentDefinition)	Initializes an XML document based on the provided document, encoding and content definition.

Method parameters in org.opencms.xml with type arguments of type CmsXmlContentDefinition

Modifier and Type	Method	Description
I_CmsXmlSchemaType	CmsXmlContentTypeManager.getContentType(org.dom4j.Element typeElement, Set<CmsXmlContentDefinition> nestedDefinitions)	Generates an initialized instance of a XML content type definition from the given XML schema element.
protected static org.opencms.xml.CmsXmlComplexTypeSequence	CmsXmlContentDefinition.validateComplexTypeSequence(org.dom4j.Element element, Set<CmsXmlContentDefinition> includes)	Validates the given element as a complex type sequence.

Constructors in org.opencms.xml with parameters of type CmsXmlContentDefinition

Modifier	Constructor	Description
	CmsXmlDisplayOrderPathComparator(CmsXmlContentDefinition definition)	Constructs a comparator for paths that fit for the provided content definition.

Uses of CmsXmlContentDefinition in org.opencms.xml.containerpage

Methods in org.opencms.xml.containerpage with parameters of type CmsXmlContentDefinition

Modifier and Type	Method	Description
static CmsXmlContainerPage	CmsXmlContainerPageFactory.createDocument(CmsObject cms, Locale locale, String encoding, CmsXmlContentDefinition contentDefinition)	Create a new instance of a container page based on the given content definition, that will have one language node for the given locale all initialized with default values.
static CmsXmlGroupContainer	CmsXmlGroupContainerFactory.createDocument(CmsObject cms, Locale locale, String encoding, CmsXmlContentDefinition contentDefinition)	Create a new instance of a group container based on the given content definition, that will have one language node for the given locale all initialized with default values.
protected void	CmsXmlContainerPage.initDocument(org.dom4j.Document document, String encoding, CmsXmlContentDefinition definition)
protected void	CmsXmlContainerPage.initDocument(CmsObject cms, org.dom4j.Document document, String encoding, CmsXmlContentDefinition definition)
protected void	CmsXmlGroupContainer.initDocument(org.dom4j.Document document, String encoding, CmsXmlContentDefinition definition)

Constructors in org.opencms.xml.containerpage with parameters of type CmsXmlContentDefinition

Modifier	Constructor	Description
protected	CmsXmlContainerPage(CmsObject cms, Locale locale, String encoding, CmsXmlContentDefinition contentDefinition)	Create a new container page based on the given content definition, that will have one language node for the given locale all initialized with default values.
protected	CmsXmlGroupContainer(CmsObject cms, Locale locale, String encoding, CmsXmlContentDefinition contentDefinition)	Create a new container page based on the given content definition, that will have one language node for the given locale all initialized with default values.

Uses of CmsXmlContentDefinition in org.opencms.xml.content

Fields in org.opencms.xml.content declared as CmsXmlContentDefinition

Modifier and Type	Field	Description
protected CmsXmlContentDefinition	CmsXmlContent.m_contentDefinition	The XML content definition object (i.e.

Methods in org.opencms.xml.content that return CmsXmlContentDefinition

Modifier and Type	Method	Description
CmsXmlContentDefinition	CmsXmlContent.getContentDefinition()
protected CmsXmlContentDefinition	CmsXmlContent.getContentDefinition(EntityResolver resolver)	Returns the content definition object for this xml content object.

Methods in org.opencms.xml.content with parameters of type CmsXmlContentDefinition

Modifier and Type	Method	Description
protected void	CmsXmlContent.addBookmarkForElement(org.dom4j.Element element, Locale locale, org.dom4j.Element parent, String parentPath, CmsXmlContentDefinition parentDef)	Creates a new bookmark for the given element.
protected void	CmsDefaultXmlContentHandler.addCheckRule(CmsXmlContentDefinition contentDefinition, String elementName, String invalidate, String type)	Adds a check rule for a specified element.
protected void	CmsDefaultXmlContentHandler.addConfiguration(CmsXmlContentDefinition contentDefinition, String elementName, String configurationValue)	Adds a configuration value for an element widget.
protected void	CmsDefaultXmlContentHandler.addDefault(CmsXmlContentDefinition contentDefinition, String elementName, String defaultValue, String resolveMacrosValue)	Adds a default value for an element.
protected void	CmsDefaultXmlContentHandler.addDefaultCheckRules(CmsXmlContentDefinition rootContentDefinition, I_CmsXmlSchemaType schemaType, String elementPath)	Adds all needed default check rules recursively for the given schema type.
protected void	CmsDefaultXmlContentHandler.addDisplayType(CmsXmlContentDefinition contentDefinition, String elementName, I_CmsXmlContentHandler.DisplayType displayType)	Adds the given element to the compact view set.
protected void	CmsDefaultXmlContentHandler.addMapping(CmsXmlContentDefinition contentDefinition, String elementName, String mapping, String useDefault)	Adds an element mapping.
protected void	CmsDefaultXmlContentHandler.addNestedFormatter(String elementName, CmsXmlContentDefinition contentDefinition)	Adds a nested formatter element.
protected void	CmsDefaultXmlContentHandler.addSearchField(CmsXmlContentDefinition contentDefinition, CmsSearchField field)	Deprecated.
protected void	CmsDefaultXmlContentHandler.addSearchField(CmsXmlContentDefinition contentDefinition, CmsSearchField field, I_CmsXmlContentHandler.MappingType type)	Adds a Solr field for an element.
protected void	CmsDefaultXmlContentHandler.addSearchSetting(CmsXmlContentDefinition contentDefinition, String elementName, I_CmsXmlContentValue.CmsSearchContentConfig value)	Adds a search setting for an element.
protected void	CmsDefaultXmlContentHandler.addSimpleSearchSetting(CmsXmlContentDefinition contentDef, String name, String value)	Adds search settings as defined by 'simple' syntax in fields.
protected void	CmsDefaultXmlContentHandler.addValidationRule(CmsXmlContentDefinition contentDefinition, String elementName, String regex, String message, boolean isWarning)	Adds a validation rule for a specified element.
protected void	CmsDefaultXmlContentHandler.addWidget(CmsXmlContentDefinition contentDefinition, String elementName, String name)	Adds a GUI widget for a specified element.
static CmsXmlContent	CmsXmlContentFactory.createDocument(CmsObject cms, Locale locale, String encoding, CmsXmlContentDefinition contentDefinition)	Create a new instance of an XML content based on the given content definiton, that will have one language node for the given locale all initialized with default values.
protected void	CmsDefaultXmlContentHandler.initDefaultValues(org.dom4j.Element root, CmsXmlContentDefinition contentDefinition)	Initializes the default values for this content handler.
protected void	CmsXmlContent.initDocument(org.dom4j.Document document, String encoding, CmsXmlContentDefinition definition)
protected void	CmsXmlContent.initDocument(CmsObject cms, org.dom4j.Document document, String encoding, CmsXmlContentDefinition definition)	Initializes an XML document based on the provided document, encoding and content definition.
protected void	CmsDefaultXmlContentHandler.initField(org.dom4j.Element elem, CmsXmlContentDefinition contentDef)	Processes a single field definition.
protected void	CmsDefaultXmlContentHandler.initFields(org.dom4j.Element parent, CmsXmlContentDefinition contentDef)	Processes all field declarations in the schema.
protected void	CmsDefaultXmlContentHandler.initFormatters(org.dom4j.Element root, CmsXmlContentDefinition contentDefinition)	Initializes the formatters for this content handler.
protected void	CmsDefaultXmlContentHandler.initHeadIncludes(org.dom4j.Element root, CmsXmlContentDefinition contentDefinition)	Initializes the head includes for this content handler.
void	CmsDefaultXmlContentHandler.initialize(org.dom4j.Element appInfoElement, CmsXmlContentDefinition contentDefinition)
void	I_CmsXmlContentHandler.initialize(org.dom4j.Element appInfoElement, CmsXmlContentDefinition contentDefinition)	Initializes this content handler for the given XML content definition by analyzing the "appinfo" node.
protected void	CmsDefaultXmlContentHandler.initLayouts(org.dom4j.Element root, CmsXmlContentDefinition contentDefinition)	Initializes the layout for this content handler.
protected void	CmsDefaultXmlContentHandler.initMappings(org.dom4j.Element root, CmsXmlContentDefinition contentDefinition)	Initializes the element mappings for this content handler.
protected void	CmsDefaultXmlContentHandler.initModelFolder(org.dom4j.Element root, CmsXmlContentDefinition contentDefinition)	Initializes the folder containing the model file(s) for this content handler.
protected void	CmsDefaultXmlContentHandler.initNestedFormatters(org.dom4j.Element element, CmsXmlContentDefinition contentDefinition)	Initializes the nested formatter fields.
protected void	CmsDefaultXmlContentHandler.initPreview(org.dom4j.Element root, CmsXmlContentDefinition contentDefinition)	Initializes the preview location for this content handler.
protected void	CmsDefaultXmlContentHandler.initRelations(org.dom4j.Element root, CmsXmlContentDefinition contentDefinition)	Initializes the relation configuration for this content handler.
protected void	CmsDefaultXmlContentHandler.initResourceBundle(org.dom4j.Element root, CmsXmlContentDefinition contentDefinition, boolean single)	Initializes the resource bundle to use for localized messages in this content handler.
protected void	CmsDefaultXmlContentHandler.initSearchSettings(org.dom4j.Element root, CmsXmlContentDefinition contentDefinition)	Initializes the search exclusions values for this content handler.
protected void	CmsDefaultXmlContentHandler.initSettings(org.dom4j.Element root, CmsXmlContentDefinition contentDefinition)	Initializes the element settings for this content handler.
protected void	CmsDefaultXmlContentHandler.initSynchronizations(org.dom4j.Element root, CmsXmlContentDefinition contentDefinition)	Initializes the locale synchronizations elements.
protected void	CmsDefaultXmlContentHandler.initTabs(org.dom4j.Element root, CmsXmlContentDefinition contentDefinition)	Initializes the tabs for this content handler.
protected void	CmsDefaultXmlContentHandler.initTemplates(org.dom4j.Element root, CmsXmlContentDefinition contentDefinition)	Initializes the forbidden template contexts.
protected void	CmsDefaultXmlContentHandler.initValidationRules(org.dom4j.Element root, CmsXmlContentDefinition contentDefinition)	Initializes the validation rules this content handler.
protected void	CmsDefaultXmlContentHandler.initVisibilities(org.dom4j.Element root, CmsXmlContentDefinition contentDefinition)	Initializes the content visibility settings.
protected void	CmsXmlContent.processSchemaNode(org.dom4j.Element root, String rootPath, Locale locale, CmsXmlContentDefinition definition)	Processes a document node and extracts the values of the node according to the provided XML content definition.
static Map<String,String>	CmsXmlContentPropertyHelper.readProperties(CmsXmlContent xmlContent, Locale locale, org.dom4j.Element element, String elemPath, CmsXmlContentDefinition elemDef)	Reads the properties from property-enabled xml content values.
static org.dom4j.Document	CmsVersionTransformer.transformDocumentToCurrentVersion(CmsObject cms, org.dom4j.Document document, CmsXmlContentDefinition contentDefinition)	Converts an XML content document to the current version using the version transformation XSLT file which is configured in the schema.

Constructors in org.opencms.xml.content with parameters of type CmsXmlContentDefinition

Modifier	Constructor	Description
protected	CmsXmlContent(CmsObject cms, Locale locale, String encoding, CmsXmlContentDefinition contentDefinition)	Create a new XML content based on the given content definiton, that will have one language node for the given locale all initialized with default values.

Uses of CmsXmlContentDefinition in org.opencms.xml.page

Methods in org.opencms.xml.page that return CmsXmlContentDefinition

Modifier and Type	Method	Description
CmsXmlContentDefinition	CmsXmlPage.getContentDefinition()

Methods in org.opencms.xml.page with parameters of type CmsXmlContentDefinition

Modifier and Type	Method	Description
protected void	CmsXmlPage.initDocument(org.dom4j.Document document, String encoding, CmsXmlContentDefinition definition)

Uses of CmsXmlContentDefinition in org.opencms.xml.types

Methods in org.opencms.xml.types that return CmsXmlContentDefinition

Modifier and Type	Method	Description
CmsXmlContentDefinition	A_CmsXmlContentValue.getContentDefinition()
CmsXmlContentDefinition	I_CmsXmlSchemaType.getContentDefinition()	Returns the content definition this schema type belongs to.
CmsXmlContentDefinition	CmsXmlNestedContentDefinition.getNestedContentDefinition()	Returns the nested content definition.

Methods in org.opencms.xml.types with parameters of type CmsXmlContentDefinition

Modifier and Type	Method	Description
void	A_CmsXmlContentValue.setContentDefinition(CmsXmlContentDefinition contentDefinition)
void	I_CmsXmlSchemaType.setContentDefinition(CmsXmlContentDefinition contentDefinition)	Sets the content definition this schema type belongs to.

Constructors in org.opencms.xml.types with parameters of type CmsXmlContentDefinition

Modifier	Constructor	Description
	CmsXmlNestedContentDefinition(CmsXmlContentDefinition contentDefinition, String name, String minOccurs, String maxOccurs)	Creates a new nested content definition.
	CmsXmlNestedContentDefinition(CmsXmlContentDefinition contentDefinition, I_CmsXmlDocument document, org.dom4j.Element element, Locale locale, I_CmsXmlSchemaType type)	Creates a new XML content value for the nested content definition.

Uses of CmsXmlContentDefinition in org.opencms.xml.xml2json

Methods in org.opencms.xml.xml2json that return CmsXmlContentDefinition

Modifier and Type	Method	Description
CmsXmlContentDefinition	CmsXmlContentTree.Node.getContentDefinition()	Gets the content definition.

Methods in org.opencms.xml.xml2json with parameters of type CmsXmlContentDefinition

Modifier and Type	Method	Description
CmsXmlContentTree.Node	CmsXmlContentTree.createNode(org.dom4j.Element elem, CmsXmlContentDefinition contentDef)	Creates a node for the given content definition and DOM element.

Constructors in org.opencms.xml.xml2json with parameters of type CmsXmlContentDefinition

Modifier	Constructor	Description
	Node(CmsXmlContentTree.NodeType type, I_CmsXmlContentValue value, CmsXmlContentDefinition contentDef, org.dom4j.Element elem, List<CmsXmlContentTree.Field> fields)	Creates a new instance.