org.opencms.xml.content.CmsXmlContentProperty Maven / Gradle / Ivy
Show all versions of opencms-gwt Show documentation
/*
* 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, 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.content;
import org.opencms.util.CmsStringUtil;
import java.io.Serializable;
/**
* Describes both VFS properties and Container Page Element settings, used by the GWT client.
*
* Warning: This class is used by GWT client-side code (See GwtBase.gwt.xml for a list of
* classes used by GWT client-side code). If you change this class, either make sure that
* your changes are compatible with GWT, or write a separate client version of the class
* and put it into super_src.
*
* @since 8.0.0
*/
public class CmsXmlContentProperty implements Serializable {
/** Type constants. */
public enum PropType {
/** Type constant string. */
string,
/** Type constant VFS list. */
vfslist;
/**
* Checks if the given type is {@link #vfslist}.
*
* @param type the type to check
*
* @return true if the given type is {@link #vfslist}
*/
public static boolean isVfsList(String type) {
if (type == null) {
return false;
}
return valueOf(type.toLowerCase()) == vfslist;
}
}
/** The property visibility options. */
public enum Visibility {
/** Visible only on the element. */
element,
/** Visible in both element and list parent as an individual setting. */
elementAndParentIndividual,
/** Visible in both element and list parent as a shared setting. */
elementAndParentShared,
/** Visible only on list parent, as individual setting. */
parentIndividual,
/** Visible only on list parent, as shared setting. */
parentShared;
/**
* True if it should be visible on the element itself.
*
* @return true if visible on the element
**/
public boolean isVisibleOnElement() {
return (this == Visibility.element)
|| (this == elementAndParentIndividual)
|| (this == elementAndParentShared);
}
}
/** XML node name constants. */
public enum XmlNode {
/** Value file list node name. */
FileList,
/** Container or property name node name. */
Name,
/** Element properties node name. */
Properties,
/** Value string node name. */
String,
/** File list URI node name. */
Uri,
/** Value node name. */
Value;
}
/** IDs separator constant. */
public static final String PROP_SEPARATOR = ",";
/** The serialization uid. */
private static final long serialVersionUID = -7718747702874213381L;
/** The property visibility. */
protected Visibility m_visibility;
/** Alias names, separated by pipes, possibly null. */
private String m_aliasName;
/** Default value. */
private String m_default;
/** The description. */
private String m_description;
/** The error message. */
private String m_error;
/** The include name. */
private String m_includeName;
/** The name of the property. */
private String m_name;
/** The nice name. */
private String m_niceName;
/** The "prefer folder" option. */
private String m_preferFolder;
/** The validation rule regex. */
private String m_ruleRegex;
/** The validation rule type. */
private String m_ruleType;
/** The value which indicates whether the user can influence how this property is going to be inherited. */
private String m_selectInherit;
/** newvalue:oldvalue pairs separated by pipes. */
private String m_translation;
/** The property type. */
private String m_type;
/** The widget to use in the editor. */
private String m_widget;
/** The widget configuration. */
private String m_widgetConfiguration;
/**
* Public constructor.
*
* @param name the property name
* @param type the property type (string|uri)
* @param widget the widget
* @param widgetConfiguration the widget configuration
* @param ruleRegex the validation rule regex
* @param ruleType the validation rule type
* @param default1 the default value
* @param niceName the nice-name
* @param description the description
* @param error the error message
* @param preferFolder the "prefer folder" option
*/
public CmsXmlContentProperty(
String name,
String type,
String widget,
String widgetConfiguration,
String ruleRegex,
String ruleType,
String default1,
String niceName,
String description,
String error,
String preferFolder
) {
this(
name,
null,
type,
null, // visibility
widget,
widgetConfiguration,
ruleRegex,
ruleType,
default1,
niceName,
description,
error,
preferFolder,
null);
}
/**
* Public constructor.
*
* @param name the property name
* @param aliasName the alias name (can also contain multiple aliases separated by pipes)
* @param type the property type (string|uri)
* @param visibility the visibility of the property, used in the container page element context
* @param widget the widget
* @param widgetConfiguration the widget configuration
* @param ruleRegex the validation rule regex
* @param ruleType the validation rule type
* @param default1 the default value
* @param niceName the nice-name
* @param description the description
* @param error the error message
* @param preferFolder the "prefer folder" option
* @param translation the value translation string (newval1:oldval1|newval2:oldval2|...)
*/
public CmsXmlContentProperty(
String name,
String aliasName,
String type,
Visibility visibility,
String widget,
String widgetConfiguration,
String ruleRegex,
String ruleType,
String default1,
String niceName,
String description,
String error,
String preferFolder,
String translation
) {
super();
m_name = name;
m_type = type;
m_visibility = visibility;
m_widget = widget;
m_widgetConfiguration = widgetConfiguration;
m_ruleRegex = ruleRegex;
m_ruleType = ruleType;
m_default = default1;
m_niceName = niceName;
m_description = description;
m_error = error;
m_preferFolder = preferFolder;
m_aliasName = CmsStringUtil.isEmptyOrWhitespaceOnly(aliasName) ? null : aliasName;
m_translation = CmsStringUtil.isEmptyOrWhitespaceOnly(translation) ? null : translation;
}
/**
* Serialization constructor.
*/
protected CmsXmlContentProperty() {
// empty
}
/**
* Gets the fist non-null value.
*
* @param o1 the first value
* @param o2 the second value
*
* @return the first non-null value
*/
private static T firstNotNull(T o1, T o2) {
if (o1 != null) {
return o1;
}
return o2;
}
/**
* Copies this property definition.
*
* @return a new copy of the current property definition
*/
public CmsXmlContentProperty copy() {
return new CmsXmlContentProperty(
m_name,
m_aliasName,
m_type,
m_visibility,
m_widget,
m_widgetConfiguration,
m_ruleRegex,
m_ruleType,
m_default,
m_niceName,
m_description,
m_error,
m_preferFolder,
m_translation);
}
/**
* Gets the alias name (can also be a list of alias names separated by pipes).
*
* @return the alias name(s)
*/
public String getAliasName() {
return m_aliasName;
}
/**
* Gets the configured visibility, without using a default value.
*
* @return the configured visibility
*/
public Visibility getConfiguredVisibility() {
return m_visibility;
}
/**
* Gets the configured widget, without using a default if it is null.
*
* @return the configured widget
*/
public String getConfiguredWidget() {
return m_widget;
}
/**
* Returns the default.
*
* @return the default
*/
public String getDefault() {
return m_default;
}
/**
* Returns the description.
*
* @return the description
*/
public String getDescription() {
return m_description;
}
/**
* Returns the error.
*
* @return the error
*/
public String getError() {
return m_error;
}
/**
* Gets the include name.
*
* This is only used for element settings in formatters, where defaults from setting configuration files
* can be imported. The returned value is used to look up the setting name to look up for such an import in the
* setting configuration file.
*
* @param defaultValue the value that should be returned if no include name is configured
* @return the include name
*/
public String getIncludeName(String defaultValue) {
if (m_includeName != null) {
return m_includeName;
}
return defaultValue;
}
/**
* Returns the property name.
*
* @return the property name
*/
public String getName() {
return m_name;
}
/**
* Returns the niceName.
*
* @return the niceName
*/
public String getNiceName() {
return m_niceName;
}
/**
* Returns the ruleRegex.
*
* @return the ruleRegex
*/
public String getRuleRegex() {
return m_ruleRegex;
}
/**
* Returns the rule type.
*
* @return the rule type
*/
public String getRuleType() {
return m_ruleType;
}
/**
* Returns a value which indicates whether the user can control the inheritance of this property.
*
* @return the "select-inherit" property
*/
public String getSelectInherit() {
return m_selectInherit;
}
/**
* Gets the value translation string, which has the form newval1:oldval1|newval2:oldval2|... .
*
* @return the value translation string
*/
public String getTranslationStr() {
return m_translation;
}
/**
* Returns the property type.
*
* @return the property type
*/
public String getType() {
return m_type;
}
/**
* Returns the visibility of the property, used in the container page element context.
*
* @param defaultValue the default value to return if the visibility is not set
*
* @return the visibility of the property
*/
public Visibility getVisibility(Visibility defaultValue) {
if (m_visibility == null) {
return defaultValue;
}
return m_visibility;
}
/**
* Returns the widget.
*
* @return the widget
*/
public String getWidget() {
if (m_widget == null) {
return "string";
}
return m_widget;
}
/**
* Returns the widgetConfiguration.
*
* @return the widgetConfiguration
*/
public String getWidgetConfiguration() {
return m_widgetConfiguration;
}
/**
* Returns the value of the "prefer folder" option.
*
* This flag determines whether a property entered in the sitemap entry editor should be stored by default at the folder
* or at the default file of a sitemap entry. It only has an effect if the sitemap entry being edited doesn't already
* have a value for that property at either location.
*
* @return the "prefer folder" flag
*/
public boolean isPreferFolder() {
return (m_preferFolder == null) || Boolean.valueOf(m_preferFolder).booleanValue();
}
/**
* Merges this object with another one containing default values.
*
* This method does not modify this object or the object passed as a parameter.
* The resulting object's fields will be filled with the values from the default if they're null in this object.
*
* @param defaults the object with the defaults
*
* @return the result of merging this object with the defaults
*/
public CmsXmlContentProperty mergeDefaults(CmsXmlContentProperty defaults) {
return new CmsXmlContentProperty(
firstNotNull(m_name, defaults.m_name),
firstNotNull(m_aliasName, defaults.m_aliasName),
firstNotNull(m_type, defaults.m_type),
firstNotNull(m_visibility, defaults.m_visibility),
firstNotNull(m_widget, defaults.m_widget),
firstNotNull(m_widgetConfiguration, defaults.m_widgetConfiguration),
firstNotNull(m_ruleRegex, defaults.m_ruleRegex),
firstNotNull(m_ruleType, defaults.m_ruleType),
firstNotNull(m_default, defaults.m_default),
firstNotNull(m_niceName, defaults.m_niceName),
firstNotNull(m_description, defaults.m_description),
firstNotNull(m_error, defaults.m_error),
firstNotNull(m_preferFolder, defaults.m_preferFolder),
firstNotNull(m_translation, defaults.m_translation));
}
/**
* Returns a modified copy of this bean with a different widget configuration.
*
* @param config the new widget configuration
* @return the copy with the modified widget configuration
*/
public CmsXmlContentProperty withConfig(String config) {
return new CmsXmlContentProperty(
m_name,
m_aliasName,
m_type,
m_visibility,
m_widget,
config,
m_ruleRegex,
m_ruleType,
m_default,
m_niceName,
m_description,
m_error,
m_preferFolder,
m_translation);
}
/**
* Copies a property definition, but replaces an empty widget with a given widget.
*
* @param defaultWidget the widget to use if the set widget is empty
*
* @return the copied property definition
*/
public CmsXmlContentProperty withDefaultWidget(String defaultWidget) {
return new CmsXmlContentProperty(
m_name,
m_aliasName,
m_type,
m_visibility,
CmsStringUtil.isEmptyOrWhitespaceOnly(m_widget) ? defaultWidget : m_widget,
m_widgetConfiguration,
m_ruleRegex,
m_ruleType,
m_default,
m_niceName,
m_description,
m_error,
m_preferFolder,
m_translation);
}
/**
* Creates a copy of this object with its include name set to a specific value.
*
* @param includeName the include name to use
*
* @return the copy with the include name set
*/
public CmsXmlContentProperty withIncludeName(String includeName) {
CmsXmlContentProperty result = copy();
if (includeName != null) {
includeName = includeName.trim();
}
result.m_includeName = includeName;
return result;
}
/**
* Copies a property definition, but replaces the nice name attribute.
*
* @param name the new nice name attribute
*
* @return the copied property definition
*/
public CmsXmlContentProperty withName(String name) {
return new CmsXmlContentProperty(
name,
m_aliasName,
m_type,
m_visibility,
m_widget,
m_widgetConfiguration,
m_ruleRegex,
m_ruleType,
m_default,
m_niceName,
m_description,
m_error,
m_preferFolder,
m_translation);
}
/**
* Copies a property definition, but replaces the nice name attribute.
*
* @param niceName the new nice name attribute
*
* @return the copied property definition
*/
public CmsXmlContentProperty withNiceName(String niceName) {
return new CmsXmlContentProperty(
m_name,
m_aliasName,
m_type,
m_visibility,
m_widget,
m_widgetConfiguration,
m_ruleRegex,
m_ruleType,
m_default,
niceName,
m_description,
m_error,
m_preferFolder,
m_translation);
}
/**
* Copies the property definition, but replaces the fields related to validation.
*
* @param pattern the validation pattern
* @param type the validation type
* @param error the validation error message
*
* @return the copied property definition
*/
public CmsXmlContentProperty withValidation(String pattern, String type, String error) {
return new CmsXmlContentProperty(
m_name,
m_aliasName,
m_type,
m_visibility,
m_widget,
m_widgetConfiguration,
pattern,
type,
m_default,
m_niceName,
m_description,
error,
m_preferFolder,
m_translation);
}
}