org.opencms.xml.types.CmsXmlPlainTextStringValue Maven / Gradle / Ivy
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software GmbH & Co. KG, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.xml.types;
import org.opencms.file.CmsObject;
import org.opencms.util.CmsHtmlExtractor;
import org.opencms.xml.I_CmsXmlDocument;
import java.util.Locale;
import org.dom4j.Element;
/**
* Describes the XML content type "OpenCmsPlainTextString".
*
* @since 7.5.2
*/
public class CmsXmlPlainTextStringValue extends A_CmsXmlValueCdataBase {
/** The name of this type as used in the XML schema. */
public static final String TYPE_NAME = "OpenCmsPlainTextString";
/**
* Creates a new, empty schema type descriptor of type "OpenCmsString".
*/
public CmsXmlPlainTextStringValue() {
// empty constructor is required for class registration
}
/**
* Creates a new XML content value of type "OpenCmsString".
*
* @param document the XML content instance this value belongs to
* @param element the XML element that contains this value
* @param locale the locale this value is created for
* @param type the type instance to create the value for
*/
public CmsXmlPlainTextStringValue(
I_CmsXmlDocument document,
Element element,
Locale locale,
I_CmsXmlSchemaType type) {
super(document, element, locale, type);
}
/**
* Creates a new schema type descriptor for the type "OpenCmsString".
*
* @param name the name of the XML node containing the value according to the XML schema
* @param minOccurs minimum number of occurrences of this type according to the XML schema
* @param maxOccurs maximum number of occurrences of this type according to the XML schema
*/
public CmsXmlPlainTextStringValue(String name, String minOccurs, String maxOccurs) {
super(name, minOccurs, maxOccurs);
}
/**
* @see org.opencms.xml.types.A_CmsXmlContentValue#createValue(I_CmsXmlDocument, org.dom4j.Element, Locale)
*/
public I_CmsXmlContentValue createValue(I_CmsXmlDocument document, Element element, Locale locale) {
return new CmsXmlPlainTextStringValue(document, element, locale, this);
}
/**
* @see org.opencms.xml.types.I_CmsXmlContentValue#getPlainText(org.opencms.file.CmsObject)
*/
@Override
public String getPlainText(CmsObject cms) {
try {
return CmsHtmlExtractor.extractText(getStringValue(cms), m_document.getEncoding());
} catch (Exception exc) {
return null;
}
}
/**
* @see org.opencms.xml.types.I_CmsXmlSchemaType#getSchemaDefinition()
*/
public String getSchemaDefinition() {
return "