com.opencms.workplace
Class CmsXmlLanguageFileContent

java.lang.Object
  |
  +--com.opencms.template.A_CmsXmlContent
        |
        +--com.opencms.workplace.CmsXmlLanguageFileContent

All Implemented Interfaces:

Cloneable, I_CmsContent, I_CmsLogChannels, I_CmsXmlContent

public class CmsXmlLanguageFileContent

extends A_CmsXmlContent

Provides backward compatibility with pre 5.0 XML-style localization.

The use of this class is deprecated and it is provided only to make old modules work without modifications. It is suggested that you modify you modules to use the 5.0 style ResourceBundle approach, because of performance issues.

Support for XML-style locales will be removed in a future release.

Version:

$Revision: 1.36 $ $Date: 2002/12/06 23:16:46 $

Author:

Alexander Lucas

Field Summary

Fields inherited from class com.opencms.template.A_CmsXmlContent

C_ERR_NODATABLOCK, C_MINIMUM_CLASSNAME, C_PARAMTYPES_HANDLING_METHODS, C_PARAMTYPES_USER_METHODS, C_REGISTER_FIRST_RUN, C_REGISTER_MAIN_RUN, C_TEMPLATE_EXTENSION, C_TEMPLATEPATH, m_cms, m_firstRunTags, m_knownTags, m_mainProcessTags

Fields inherited from interface com.opencms.boot.I_CmsLogChannels

C_FLEX_CACHE, C_FLEX_LOADER, C_LOGGING, C_MODULE_CRITICAL, C_MODULE_DEBUG, C_MODULE_INFO, C_OPENCMS_CACHE, C_OPENCMS_CRITICAL, C_OPENCMS_CRONSCHEDULER, C_OPENCMS_DEBUG, C_OPENCMS_ELEMENTCACHE, C_OPENCMS_INFO, C_OPENCMS_INIT, C_OPENCMS_POOL, C_OPENCMS_STATICEXPORT, C_OPENCMS_STREAMING, C_PREPROCESSOR_IS_LOGGING

Constructor Summary

CmsXmlLanguageFileContent(CmsObject cms, String locale)
Constructor for creating a new language file object containing the content of the corresponding system language file for the actual user.

Method Summary

String	getContentDescription() Gets a description of this content type.
String	getLanguageValue(String tag) Gets the language value vor the requested tag.
String	getXmlDocumentTagName() Gets the expected tagname for the XML documents of this content type
boolean	hasLanguageValue(String tag) Checks if there exists a language value vor the requested tag.

Methods inherited from class com.opencms.template.A_CmsXmlContent

callAllUncalledMethodsSoThatEclipseDoesntComplainAboutThem, callUserMethod, clearFileCache, clearFileCache, clearFileCache, clone, createNewFile, fastSetData, getAbsoluteFilename, getAllData, getClassName, getData, getDataValue, getEncoding, getFilename, getProcessedData, getProcessedData, getProcessedData, getProcessedData, getProcessedDataValue, getProcessedDataValue, getProcessedDataValue, getProcessedDataValue, getTagValue, getXmlDocument, getXmlParser, getXmlText, getXmlText, getXmlText, getXmlText, getXmlText, getXmlText, hasData, init, init, init, parse, parse, processDocument, processNode, processNode, readIncludeFile, readIncludeFile, registerTag, registerTag, removeData, removeFromFileCache, setData, setData, setEncoding, setParsedData, throwException, throwException, throwException, throwException, toString, treeWalker, treeWalkerWidth, write

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsXmlLanguageFileContent

public CmsXmlLanguageFileContent(CmsObject cms,
                                 String locale)
                          throws CmsException

Constructor for creating a new language file object containing the content of the corresponding system language file for the actual user.

Parameters:

cms - CmsObject object for accessing system resources.

locale - name of the locale to initialize

Method Detail

getContentDescription

public String getContentDescription()

Gets a description of this content type.

Specified by:

getContentDescription in class A_CmsXmlContent

Returns:

Content type description.

getLanguageValue

public String getLanguageValue(String tag)
                        throws CmsException

Gets the language value vor the requested tag.

Parameters:

tag - requested tag.

Returns:

Language value.

CmsException

getXmlDocumentTagName

public String getXmlDocumentTagName()

Gets the expected tagname for the XML documents of this content type

Specified by:

getXmlDocumentTagName in class A_CmsXmlContent

Returns:

Expected XML tagname.

hasLanguageValue

public boolean hasLanguageValue(String tag)

Checks if there exists a language value vor the requested tag.

Parameters:

tag - requested tag.

Returns:

Language value.