A_CmsXmlDocument

java.lang.Object
- org.opencms.xml.A_CmsXmlDocument

所有已实现的接口:

I_CmsXmlDocument

直接已知子类:

CmsXmlContent, CmsXmlPage
```
public abstract class A_CmsXmlDocument
extends java.lang.Object
implements I_CmsXmlDocument
```
Provides basic XML document handling functions useful when dealing with XML documents that are stored in the OpenCms VFS.

从以下版本开始:

6.0.0

字段概要

字段
限定符和类型	字段和说明
`protected java.lang.String`	`m_conversion` The content conversion to use for this XML document.
`protected org.dom4j.Document`	`m_document` The document object of the document.
`protected java.util.Map<java.lang.String,java.util.Set<java.util.Locale>>`	`m_elementLocales` Maps element names to available locales.
`protected java.util.Map<java.util.Locale,java.util.Set<java.lang.String>>`	`m_elementNames` Maps locales to available element names.
`protected java.lang.String`	`m_encoding` The encoding to use for this XML document.
`protected CmsFile`	`m_file` The file that contains the document data (note: is not set when creating an empty or document based document).
`protected java.util.Set<java.util.Locale>`	`m_locales` Set of locales contained in this document.

构造器概要

构造器
限定符构造器和说明

protected A_CmsXmlDocument()
Default constructor for a XML document that initializes some internal values.

构造器
限定符	构造器和说明
`protected`	`A_CmsXmlDocument()` Default constructor for a XML document that initializes some internal values.

方法概要

方法
限定符和类型	方法和说明
`protected void`	`addBookmark(java.lang.String path, java.util.Locale locale, boolean enabled, I_CmsXmlContentValue value)` Adds a bookmark for the given value.
`protected void`	`addLocale(java.util.Locale locale)` Adds a locale to the set of locales of the XML document.
`protected void`	`clearBookmarks()` Clears the XML document bookmarks.
`void`	`copyLocale(java.util.List<java.util.Locale> possibleSources, java.util.Locale destination)` Copies the content from the first matching source locale that exists in this XML document to the given destination locale in this XML document.
`void`	`copyLocale(java.util.Locale source, java.util.Locale destination)` Copies the content of the given source locale to the given destination locale in this XML document.
`CmsFile`	`correctXmlStructure(CmsObject cms)` Corrects the structure of this XML document.
`protected org.dom4j.Element`	`createDeepElementCopy(org.dom4j.Element element, java.util.Set<java.lang.String> copyElements)` Creates a partial deep element copy according to the set of element paths.
`java.util.Locale`	`getBestMatchingLocale(java.util.Locale locale)` Returns the first matching locale (eventually simplified) from the available locales.
`protected I_CmsXmlContentValue`	`getBookmark(java.lang.String bookmark)` Returns the bookmarked value for the given bookmark, which must be a valid bookmark name.
`protected I_CmsXmlContentValue`	`getBookmark(java.lang.String path, java.util.Locale locale)` Returns the bookmarked value for the given name.
`protected static java.lang.String`	`getBookmarkName(java.lang.String name, java.util.Locale locale)` Creates the bookmark name for a localized element to be used in the bookmark lookup table.
`protected java.util.Set<java.lang.String>`	`getBookmarks()` Returns the names of all bookmarked elements.
`java.lang.String`	`getConversion()` Returns the content conversion parameter used for this XML document.
`java.lang.String`	`getEncoding()` Returns the encoding used for this XML document.
`CmsFile`	`getFile()` Returns the file this document was generated from, may be `null` if the file not available.
`int`	`getIndexCount(java.lang.String path, java.util.Locale locale)` Returns the index count of existing values for the given path, or `-1` if no such path exists.
`java.util.List<java.util.Locale>`	`getLocales()` Returns a List of all locales that have at last one value in this XML document.
`java.util.List<java.util.Locale>`	`getLocales(java.lang.String path)` Returns a List of all locales that have the named element set in this document.
`java.util.List<java.lang.String>`	`getNames(java.util.Locale locale)` Returns a List of all available elements paths (Strings) used in this document for the given locale.
`java.lang.String`	`getStringValue(CmsObject cms, java.lang.String path, java.util.Locale locale)` Returns the first content value for the given path as a String, or `null` if no such value exists.
`java.lang.String`	`getStringValue(CmsObject cms, java.lang.String path, java.util.Locale locale, int index)` Returns the content value for the given path and the selected index as a String, or `null` if no such value exists.
`java.util.List<I_CmsXmlContentValue>`	`getSubValues(java.lang.String path, java.util.Locale locale)` Returns all content values (of type `I_CmsXmlContentValue`) directly below the given path available in this document for the given locale.
`I_CmsXmlContentValue`	`getValue(java.lang.String path, java.util.Locale locale)` Returns the content value Object for the given path, or `null` if no such value exists.
`I_CmsXmlContentValue`	`getValue(java.lang.String path, java.util.Locale locale, int index)` Returns the content value Object for the given path and the selected index, or `null` if no such value exists.
`protected I_CmsXmlContentValue`	`getValueInternal(java.lang.String path, java.util.Locale locale)` Internal method to look up a value, requires that the name already has been "normalized" for the bookmark lookup.
`java.util.List<I_CmsXmlContentValue>`	`getValues(java.util.Locale locale)` Returns all available content values (of type `I_CmsXmlContentValue`) in this document for the given locale.
`java.util.List<I_CmsXmlContentValue>`	`getValues(java.lang.String path, java.util.Locale locale)` Returns all content values (of type `I_CmsXmlContentValue`) with the given path available in this document for the given locale.
`boolean`	`hasLocale(java.util.Locale locale)` Returns `true` if the given locale exists in this XML document.
`boolean`	`hasValue(java.lang.String path, java.util.Locale locale)` Returns `true` if a value with the given path exists for the selected locale in this XML document, or `false` otherwise.
`boolean`	`hasValue(java.lang.String path, java.util.Locale locale, int index)` Returns `true` if a value with the given path and the provided index exists for the selected locale in this XML document, or `false` otherwise.
`void`	`initDocument()` Initializes this XML document, required after structural changes to the internal XML.
`protected abstract void`	`initDocument(org.dom4j.Document document, java.lang.String encoding, CmsXmlContentDefinition contentDefinition)` Initializes an XML document based on the provided document, encoding and content definition.
`protected boolean`	`isAutoCorrectionEnabled()` Returns `true` if the auto correction feature is enabled for saving this XML content.
`boolean`	`isEnabled(java.lang.String path, java.util.Locale locale)` Returns `true` if a value with the given path exists for the selected locale in this XML document, and that value is enabled, or `false` otherwise.
`boolean`	`isEnabled(java.lang.String path, java.util.Locale locale, int index)` Returns `true` if a value with the given path and the provided index exists for the selected locale in this XML document, and that value is enabled, or `false` otherwise.
`byte[]`	`marshal()` Marshals (writes) the content of the current XML document into a byte array using the selected encoding.
`protected java.io.OutputStream`	`marshal(java.io.OutputStream out, java.lang.String encoding)` Marshals (writes) the content of the current XML document into an output stream.
`void`	`moveLocale(java.util.Locale source, java.util.Locale destination)` Moves the content of the given source locale to the given destination locale in this XML document.
`protected I_CmsXmlContentValue`	`removeBookmark(java.lang.String path, java.util.Locale locale)` Removes the bookmark for an element with the given name and locale.
`void`	`removeLocale(java.util.Locale locale)` Removes the given locale from this XML document.
`void`	`setConversion(java.lang.String conversion)` Sets the content conversion mode for this document.
`java.lang.String`	`toString()`
`void`	`validateXmlStructure(org.xml.sax.EntityResolver resolver)` Validates the XML structure of the document with the DTD or XML schema used by the document.

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

从接口继承的方法 org.opencms.xml.I_CmsXmlDocument
addLocale, getContentDefinition, getHandler, getLinkProcessor, validate

- 字段详细资料
  - m_conversion
```
protected java.lang.String m_conversion
```
    The content conversion to use for this XML document.
  - m_document
```
protected org.dom4j.Document m_document
```
    The document object of the document.
  - m_elementLocales
```
protected java.util.Map<java.lang.String,java.util.Set<java.util.Locale>> m_elementLocales
```
    Maps element names to available locales.
  - m_elementNames
```
protected java.util.Map<java.util.Locale,java.util.Set<java.lang.String>> m_elementNames
```
    Maps locales to available element names.
  - m_encoding
```
protected java.lang.String m_encoding
```
    The encoding to use for this XML document.
  - m_file
```
protected CmsFile m_file
```
    The file that contains the document data (note: is not set when creating an empty or document based document).
  - m_locales
```
protected java.util.Set<java.util.Locale> m_locales
```
    Set of locales contained in this document.
- 构造器详细资料
  - A_CmsXmlDocument
```
protected A_CmsXmlDocument()
```
    Default constructor for a XML document that initializes some internal values.
- 方法详细资料
  - getBookmarkName
```
protected static final java.lang.String getBookmarkName(java.lang.String name,
                               java.util.Locale locale)
```
    Creates the bookmark name for a localized element to be used in the bookmark lookup table.
    
    参数:
    name - the element name
    locale - the element locale
    
    返回:
    the bookmark name for a localized element
  - copyLocale
```
public void copyLocale(java.util.List<java.util.Locale> possibleSources,
              java.util.Locale destination)
                throws CmsXmlException
```
    从接口复制的说明: I_CmsXmlDocument
    
    Copies the content from the first matching source locale that exists in this XML document to the given destination locale in this XML document.
    The list of possible sources, has to be sorted in order of preference. The first match that exists in this XML document is used as source for the destination locale. No "locale simplification" ("en_EN" to "en" etc.) is performed for the match.
    
    指定者:
    
    copyLocale 在接口中 I_CmsXmlDocument
    
    参数:
    possibleSources - the possible source locales in order of preference, must contain objects of type Locale
    destination - the destination locale
    
    抛出:
    
    CmsXmlException - in case non of the source locales did not exist, or the destination locale already exists in the document, or if something else goes wrong
    另请参阅:
    I_CmsXmlDocument.copyLocale(java.util.List, java.util.Locale)
  - copyLocale
```
public void copyLocale(java.util.Locale source,
              java.util.Locale destination)
                throws CmsXmlException
```
    从接口复制的说明: I_CmsXmlDocument
    
    Copies the content of the given source locale to the given destination locale in this XML document.
    
    指定者:
    
    copyLocale 在接口中 I_CmsXmlDocument
    
    参数:
    source - the source locale
    destination - the destination locale
    
    抛出:
    
    CmsXmlException - in case either the source locale did not exist, or the destination locale already exists in the document, or if something else goes wrong
    另请参阅:
    I_CmsXmlDocument.copyLocale(java.util.Locale, java.util.Locale)
  - correctXmlStructure
```
public CmsFile correctXmlStructure(CmsObject cms)
                            throws CmsXmlException
```
    Corrects the structure of this XML document.
    
    参数:
    cms - the current OpenCms user context
    
    返回:
    the file that contains the corrected XML structure
    
    抛出:
    
    CmsXmlException - if something goes wrong
  - getBestMatchingLocale
```
public java.util.Locale getBestMatchingLocale(java.util.Locale locale)
```
    从接口复制的说明: I_CmsXmlDocument
    
    Returns the first matching locale (eventually simplified) from the available locales.
    In case no match is found, code null is returned.
    
    指定者:
    
    getBestMatchingLocale 在接口中 I_CmsXmlDocument
    
    参数:
    locale - the requested locale
    
    返回:
    the matching locale available within the document
    另请参阅:
    I_CmsXmlDocument.getBestMatchingLocale(java.util.Locale)
  - getConversion
```
public java.lang.String getConversion()
```
    从接口复制的说明: I_CmsXmlDocument
    
    Returns the content conversion parameter used for this XML document.
    
    指定者:
    
    getConversion 在接口中 I_CmsXmlDocument
    
    返回:
    the content conversion parameter used for this XML document
    另请参阅:
    I_CmsXmlDocument.getConversion()
  - getEncoding
```
public java.lang.String getEncoding()
```
    从接口复制的说明: I_CmsXmlDocument
    
    Returns the encoding used for this XML document.
    
    指定者:
    
    getEncoding 在接口中 I_CmsXmlDocument
    
    返回:
    the encoding used for this XML document
    另请参阅:
    I_CmsXmlDocument.getEncoding()
  - getFile
```
public CmsFile getFile()
```
    从接口复制的说明: I_CmsXmlDocument
    
    Returns the file this document was generated from, may be null if the file not available.
    The file may not be available if the document was generated from a String or a pure XML document.
    
    指定者:
    
    getFile 在接口中 I_CmsXmlDocument
    
    返回:
    the file this document was generated from
    另请参阅:
    I_CmsXmlDocument.getFile()
  - getIndexCount
```
public int getIndexCount(java.lang.String path,
                java.util.Locale locale)
```
    从接口复制的说明: I_CmsXmlDocument
    
    Returns the index count of existing values for the given path, or -1 if no such path exists.
    
    指定者:
    
    getIndexCount 在接口中 I_CmsXmlDocument
    
    参数:
    path - the path to get the index count for
    locale - the locale to get the index count for
    
    返回:
    the index count for the given key name
    另请参阅:
    I_CmsXmlDocument.getIndexCount(java.lang.String, java.util.Locale)
  - getLocales
```
public java.util.List<java.util.Locale> getLocales()
```
    从接口复制的说明: I_CmsXmlDocument
    
    Returns a List of all locales that have at last one value in this XML document.
    
    指定者:
    
    getLocales 在接口中 I_CmsXmlDocument
    
    返回:
    a List of all locales that have at last one value in this XML document
    另请参阅:
    I_CmsXmlDocument.getLocales()
  - getLocales
```
public java.util.List<java.util.Locale> getLocales(java.lang.String path)
```
    Returns a List of all locales that have the named element set in this document.
    If no locale for the given element name is available, an empty list is returned.
    
    指定者:
    
    getLocales 在接口中 I_CmsXmlDocument
    
    参数:
    path - the element to look up the locale List for
    
    返回:
    a List of all Locales that have the named element set in this document
  - getNames
```
public java.util.List<java.lang.String> getNames(java.util.Locale locale)
```
    从接口复制的说明: I_CmsXmlDocument
    
    Returns a List of all available elements paths (Strings) used in this document for the given locale.
    If no element for the given locale is available, an empty list is returned.
    
    指定者:
    
    getNames 在接口中 I_CmsXmlDocument
    
    参数:
    locale - the locale to look up the elements paths for
    
    返回:
    a List of all available elements paths (Strings) used in this document for the given locale
    另请参阅:
    I_CmsXmlDocument.getNames(java.util.Locale)
  - getStringValue
```
public java.lang.String getStringValue(CmsObject cms,
                              java.lang.String path,
                              java.util.Locale locale)
```
    从接口复制的说明: I_CmsXmlDocument
    
    Returns the first content value for the given path as a String, or null if no such value exists.
    
    指定者:
    
    getStringValue 在接口中 I_CmsXmlDocument
    
    参数:
    cms - the current OpenCms user context
    path - the path to get the content value for
    locale - the locale to get the content value for
    
    返回:
    the first content value for the given path as a String
    另请参阅:
    I_CmsXmlDocument.getStringValue(org.opencms.file.CmsObject, java.lang.String, java.util.Locale)
  - getStringValue
```
public java.lang.String getStringValue(CmsObject cms,
                              java.lang.String path,
                              java.util.Locale locale,
                              int index)
```
    从接口复制的说明: I_CmsXmlDocument
    
    Returns the content value for the given path and the selected index as a String, or null if no such value exists.
    
    指定者:
    
    getStringValue 在接口中 I_CmsXmlDocument
    
    参数:
    cms - the current OpenCms user context
    path - the path to get the content value for
    locale - the locale to get the content value for
    index - the index position to get the value from
    
    返回:
    the content value for the given path and the selected index as a String
    另请参阅:
    I_CmsXmlDocument.getStringValue(CmsObject, java.lang.String, Locale, int)
  - getSubValues
```
public java.util.List<I_CmsXmlContentValue> getSubValues(java.lang.String path,
                                                java.util.Locale locale)
```
    从接口复制的说明: I_CmsXmlDocument
    
    Returns all content values (of type I_CmsXmlContentValue) directly below the given path available in this document for the given locale.
    If no content value for the given path is available with this locale, an empty list is returned.
    
    指定者:
    
    getSubValues 在接口中 I_CmsXmlDocument
    
    参数:
    path - the path to get the sub content values for
    locale - the locale to get the sub content values for
    
    返回:
    all content values (of type I_CmsXmlContentValue) directly below the given path available in this document for the given locale
    另请参阅:
    I_CmsXmlDocument.getSubValues(java.lang.String, java.util.Locale)
  - getValue
```
public I_CmsXmlContentValue getValue(java.lang.String path,
                            java.util.Locale locale)
```
    从接口复制的说明: I_CmsXmlDocument
    
    Returns the content value Object for the given path, or null if no such value exists.
    You can provide an index by appending a number in square brackets to the path parameter like this "Title[1]". If no index is provided, 1 is used for the index position.
    
    指定者:
    
    getValue 在接口中 I_CmsXmlDocument
    
    参数:
    path - the path to get the content value for
    locale - the locale to get the content value for
    
    返回:
    the content value Object for the given path
    另请参阅:
    I_CmsXmlDocument.getValue(java.lang.String, java.util.Locale)
  - getValue
```
public I_CmsXmlContentValue getValue(java.lang.String path,
                            java.util.Locale locale,
                            int index)
```
    从接口复制的说明: I_CmsXmlDocument
    
    Returns the content value Object for the given path and the selected index, or null if no such value exists.
    
    指定者:
    
    getValue 在接口中 I_CmsXmlDocument
    
    参数:
    path - the path to get the content value for
    locale - the locale to get the content value for
    index - the index position to get the value from
    
    返回:
    the content value Object for the given path and the selected index
    另请参阅:
    I_CmsXmlDocument.getValue(java.lang.String, java.util.Locale, int)
  - getValues
```
public java.util.List<I_CmsXmlContentValue> getValues(java.util.Locale locale)
```
    从接口复制的说明: I_CmsXmlDocument
    
    Returns all available content values (of type I_CmsXmlContentValue) in this document for the given locale.
    If no content value for the given locale is available, an empty list is returned.
    
    指定者:
    
    getValues 在接口中 I_CmsXmlDocument
    
    参数:
    locale - the locale to get the content values for
    
    返回:
    all available content values (of type I_CmsXmlContentValue) in this document for the given locale
    另请参阅:
    I_CmsXmlDocument.getValues(java.util.Locale)
  - getValues
```
public java.util.List<I_CmsXmlContentValue> getValues(java.lang.String path,
                                             java.util.Locale locale)
```
    从接口复制的说明: I_CmsXmlDocument
    
    Returns all content values (of type I_CmsXmlContentValue) with the given path available in this document for the given locale.
    If no content value for the given path is available with this locale, an empty list is returned.
    
    指定者:
    
    getValues 在接口中 I_CmsXmlDocument
    
    参数:
    path - the path to get the content values for
    locale - the locale to get the content values for
    
    返回:
    all content values (of type I_CmsXmlContentValue) with the given path available in this document for the given locale
    另请参阅:
    I_CmsXmlDocument.getValues(java.lang.String, java.util.Locale)
  - hasLocale
```
public boolean hasLocale(java.util.Locale locale)
```
    从接口复制的说明: I_CmsXmlDocument
    
    Returns true if the given locale exists in this XML document.
    
    指定者:
    
    hasLocale 在接口中 I_CmsXmlDocument
    
    参数:
    locale - the locale to check
    
    返回:
    true if the given locale exists in this XML document, false otherwise
    另请参阅:
    I_CmsXmlDocument.hasLocale(java.util.Locale)
  - hasValue
```
public boolean hasValue(java.lang.String path,
               java.util.Locale locale)
```
    从接口复制的说明: I_CmsXmlDocument
    
    Returns true if a value with the given path exists for the selected locale in this XML document, or false otherwise.
    You can provide an index by appending a number in square brackets to the path parameter like this "Title[1]". If no index is provided, 1 is used for the index position.
    
    指定者:
    
    hasValue 在接口中 I_CmsXmlDocument
    
    参数:
    path - the path to check
    locale - the locale to check
    
    返回:
    true if a value with the given path exists for the selected locale in this XML document
    另请参阅:
    I_CmsXmlDocument.hasValue(java.lang.String, java.util.Locale)
  - hasValue
```
public boolean hasValue(java.lang.String path,
               java.util.Locale locale,
               int index)
```
    从接口复制的说明: I_CmsXmlDocument
    
    Returns true if a value with the given path and the provided index exists for the selected locale in this XML document, or false otherwise.
    
    指定者:
    
    hasValue 在接口中 I_CmsXmlDocument
    
    参数:
    path - the path to check
    locale - the locale to check
    index - the index position to check
    
    返回:
    true if a value with the given path and the provided index exists for the selected locale in this XML document
    另请参阅:
    I_CmsXmlDocument.hasValue(java.lang.String, java.util.Locale, int)
  - initDocument
```
public void initDocument()
```
    从接口复制的说明: I_CmsXmlDocument
    
    Initializes this XML document, required after structural changes to the internal XML.
    If nodes in the XML are added, removed or moved, the document needs to be initialized in order to update the internal data structures.
    
    指定者:
    
    initDocument 在接口中 I_CmsXmlDocument
    
    另请参阅:
    I_CmsXmlDocument.initDocument()
  - isEnabled
```
public boolean isEnabled(java.lang.String path,
                java.util.Locale locale)
```
    从接口复制的说明: I_CmsXmlDocument
    
    Returns true if a value with the given path exists for the selected locale in this XML document, and that value is enabled, or false otherwise.
    This is only used with implementations that support enabling and disabling individual values, such as CmsXmlPage. If enabling / disabling values is not supported, this is identical to I_CmsXmlDocument.hasValue(String, Locale).
    You can provide an index by appending a number in square brackets to the path parameter like this "Title[1]". If no index is provided, 1 is used for the index position.
    
    指定者:
    
    isEnabled 在接口中 I_CmsXmlDocument
    
    参数:
    path - the path to check
    locale - the locale to check
    
    返回:
    true if a value with the given path exists for the selected locale in this XML document, and that value is enabled
    另请参阅:
    I_CmsXmlDocument.isEnabled(java.lang.String, java.util.Locale)
  - isEnabled
```
public boolean isEnabled(java.lang.String path,
                java.util.Locale locale,
                int index)
```
    从接口复制的说明: I_CmsXmlDocument
    
    Returns true if a value with the given path and the provided index exists for the selected locale in this XML document, and that value is enabled, or false otherwise.
    This is only used with implementations that support enabling and disabling individual values, such as CmsXmlPage. If enabling / disabling values is not supported, this is identical to I_CmsXmlDocument.hasValue(String, Locale, int).
    
    指定者:
    
    isEnabled 在接口中 I_CmsXmlDocument
    
    参数:
    path - the path to check
    locale - the locale to check
    index - the index position to check
    
    返回:
    true if a value with the given path and the provided index exists for the selected locale in this XML document, and that value is enabled
    另请参阅:
    I_CmsXmlDocument.isEnabled(java.lang.String, java.util.Locale, int)
  - marshal
```
public byte[] marshal()
               throws CmsXmlException
```
    Marshals (writes) the content of the current XML document into a byte array using the selected encoding.
    
    返回:
    the content of the current XML document written into a byte array
    
    抛出:
    
    CmsXmlException - if something goes wrong
  - moveLocale
```
public void moveLocale(java.util.Locale source,
              java.util.Locale destination)
                throws CmsXmlException
```
    从接口复制的说明: I_CmsXmlDocument
    
    Moves the content of the given source locale to the given destination locale in this XML document.
    
    指定者:
    
    moveLocale 在接口中 I_CmsXmlDocument
    
    参数:
    source - the source locale
    destination - the destination locale
    
    抛出:
    
    CmsXmlException - in case either the source locale does not exist, or the destination locale already exists in the document, or if something else goes wrong
    另请参阅:
    I_CmsXmlDocument.moveLocale(java.util.Locale, java.util.Locale)
  - removeLocale
```
public void removeLocale(java.util.Locale locale)
                  throws CmsXmlException
```
    从接口复制的说明: I_CmsXmlDocument
    
    Removes the given locale from this XML document.
    
    指定者:
    
    removeLocale 在接口中 I_CmsXmlDocument
    
    参数:
    locale - the locale to remove
    
    抛出:
    
    CmsXmlException - in case the locale did not exist in the document, or if something else goes wrong
    另请参阅:
    I_CmsXmlDocument.removeLocale(java.util.Locale)
  - setConversion
```
public void setConversion(java.lang.String conversion)
```
    Sets the content conversion mode for this document.
    
    参数:
    conversion - the conversion mode to set for this document
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object
    
    另请参阅:
    Object.toString()
  - validateXmlStructure
```
public void validateXmlStructure(org.xml.sax.EntityResolver resolver)
                          throws CmsXmlException
```
    Validates the XML structure of the document with the DTD or XML schema used by the document.
    This is required in case someone modifies the XML structure of a document using the "edit control code" option.
    
    参数:
    resolver - the XML entity resolver to use
    
    抛出:
    
    CmsXmlException - if the validation fails
  - addBookmark
```
protected void addBookmark(java.lang.String path,
               java.util.Locale locale,
               boolean enabled,
               I_CmsXmlContentValue value)
```
    Adds a bookmark for the given value.
    
    参数:
    path - the lookup path to use for the bookmark
    locale - the locale to use for the bookmark
    enabled - if true, the value is enabled, if false it is disabled
    value - the value to bookmark
  - addLocale
```
protected void addLocale(java.util.Locale locale)
```
    Adds a locale to the set of locales of the XML document.
    
    参数:
    locale - the locale to add
  - clearBookmarks
```
protected void clearBookmarks()
```
    Clears the XML document bookmarks.
  - createDeepElementCopy
```
protected org.dom4j.Element createDeepElementCopy(org.dom4j.Element element,
                                      java.util.Set<java.lang.String> copyElements)
```
    Creates a partial deep element copy according to the set of element paths.
    Only elements contained in that set will be copied.
    
    参数:
    element - the element to copy
    copyElements - the set of paths for elements to copy
    
    返回:
    a partial deep copy of element
  - getBookmark
```
protected I_CmsXmlContentValue getBookmark(java.lang.String bookmark)
```
    Returns the bookmarked value for the given bookmark, which must be a valid bookmark name. Use getBookmarks() to get the list of all valid bookmark names.
    
    参数:
    bookmark - the bookmark name to look up
    
    返回:
    the bookmarked value for the given bookmark
  - getBookmark
```
protected I_CmsXmlContentValue getBookmark(java.lang.String path,
                               java.util.Locale locale)
```
    Returns the bookmarked value for the given name.
    
    参数:
    path - the lookup path to use for the bookmark
    locale - the locale to get the bookmark for
    
    返回:
    the bookmarked value
  - getBookmarks
```
protected java.util.Set<java.lang.String> getBookmarks()
```
    Returns the names of all bookmarked elements.
    
    返回:
    the names of all bookmarked elements
  - getValueInternal
```
protected I_CmsXmlContentValue getValueInternal(java.lang.String path,
                                    java.util.Locale locale)
```
    Internal method to look up a value, requires that the name already has been "normalized" for the bookmark lookup. This is required to find names like "title/subtitle" which are stored internally as "title[0]/subtitle[0]" in the bookmarks.
    
    参数:
    path - the path to look up
    locale - the locale to look up
    
    返回:
    the value found in the bookmarks
  - initDocument
```
protected abstract void initDocument(org.dom4j.Document document,
                java.lang.String encoding,
                CmsXmlContentDefinition contentDefinition)
```
    Initializes an XML document based on the provided document, encoding and content definition.
    
    参数:
    document - the base XML document to use for initializing
    encoding - the encoding to use when marshalling the document later
    contentDefinition - the content definition to use
  - isAutoCorrectionEnabled
```
protected boolean isAutoCorrectionEnabled()
```
    Returns true if the auto correction feature is enabled for saving this XML content.
    
    返回:
    true if the auto correction feature is enabled for saving this XML content
  - marshal
```
protected java.io.OutputStream marshal(java.io.OutputStream out,
                           java.lang.String encoding)
                                throws CmsXmlException
```
    Marshals (writes) the content of the current XML document into an output stream.
    
    参数:
    out - the output stream to write to
    encoding - the encoding to use
    
    返回:
    the output stream with the XML content
    
    抛出:
    
    CmsXmlException - if something goes wrong
  - removeBookmark
```
protected I_CmsXmlContentValue removeBookmark(java.lang.String path,
                                  java.util.Locale locale)
```
    Removes the bookmark for an element with the given name and locale.
    
    参数:
    path - the lookup path to use for the bookmark
    locale - the locale of the element
    
    返回:
    the element removed from the bookmarks or null

类 A_CmsXmlDocument

字段概要

构造器概要

方法概要

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

从接口继承的方法 org.opencms.xml.I_CmsXmlDocument

字段详细资料

m_conversion

m_document

m_elementLocales

m_elementNames

m_encoding

m_file

m_locales

构造器详细资料

A_CmsXmlDocument

方法详细资料

getBookmarkName

copyLocale

copyLocale

correctXmlStructure

getBestMatchingLocale

getConversion

getEncoding

getFile

getIndexCount

getLocales

getLocales

getNames

getStringValue

getStringValue

getSubValues

getValue

getValue

getValues

getValues

hasLocale

hasValue

hasValue

initDocument

isEnabled

isEnabled

marshal

moveLocale

removeLocale

setConversion

toString

validateXmlStructure

addBookmark

addLocale

clearBookmarks

createDeepElementCopy

getBookmark

getBookmark

getBookmarks

getValueInternal

initDocument

isAutoCorrectionEnabled

marshal

removeBookmark