/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH (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, 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.main.CmsIllegalArgumentException;
import org.opencms.main.CmsRuntimeException;
import org.opencms.util.CmsStringUtil;
import org.opencms.xml.I_CmsXmlDocument;
import java.util.Locale;
import org.dom4j.Element;
/**
* Base class for XML content value implementations that require only a simple XML plain text node.<p>
*
* @since 6.0.0
*/
public abstract class A_CmsXmlValueTextBase extends A_CmsXmlContentValue {
/** The String value of the element node. */
protected String m_stringValue;
/**
* Default constructor for a xml content type
* that initializes some internal values.<p>
*/
protected A_CmsXmlValueTextBase() {
super();
}
/**
* Initializes the required members for this XML content value.<p>
*
* @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
*/
protected A_CmsXmlValueTextBase(I_CmsXmlDocument document, Element element, Locale locale, I_CmsXmlSchemaType type) {
super(document, element, locale, type);
m_stringValue = element.getText();
}
/**
* Initializes the schema type descriptor values for this type descriptor.<p>
*
* @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
*/
protected A_CmsXmlValueTextBase(String name, String minOccurs, String maxOccurs) {
super(name, minOccurs, maxOccurs);
}
/**
* @see org.opencms.xml.types.I_CmsXmlContentValue#getStringValue(CmsObject)
*/
public String getStringValue(CmsObject cms) throws CmsRuntimeException {
return m_stringValue;
}
/**
* @see org.opencms.xml.types.I_CmsXmlContentValue#setStringValue(org.opencms.file.CmsObject, java.lang.String)
*/
public void setStringValue(CmsObject cms, String value) throws CmsIllegalArgumentException {
m_element.clearContent();
if (CmsStringUtil.isNotEmpty(value)) {
m_element.addText(value);
}
m_stringValue = value;
}
}