/*
* Copyright (c) 2005-2016 Vincent Vandenschrick. All rights reserved.
*
* This file is part of the Jspresso framework.
*
* Jspresso 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 3 of the License, or
* (at your option) any later version.
*
* Jspresso 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.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Jspresso. If not, see <http://www.gnu.org/licenses/>.
*/
package org.jspresso.framework.model.descriptor.basic;
import java.util.Arrays;
import java.util.Collection;
import java.util.Locale;
import org.jspresso.framework.model.descriptor.IEnumerationPropertyDescriptor;
import org.jspresso.framework.model.descriptor.IPropertyDescriptor;
import org.jspresso.framework.model.descriptor.IReferencePropertyDescriptor;
import org.jspresso.framework.util.bean.integrity.IntegrityException;
import org.jspresso.framework.util.descriptor.IDescriptor;
import org.jspresso.framework.util.i18n.ITranslationProvider;
/**
* Abstract base descriptor for properties whose values are enumerated strings.
* An example of such a property is <i>gender</i> whose value can be <i>M</i>
* (for "Male") or <i>F</i> (for "Female"). Actual property
* values can be codes that are translated for inclusion in the UI. Such
* properties are usually rendered as combo-boxes.
*
* @author Vincent Vandenschrick
*/
public abstract class AbstractEnumerationPropertyDescriptor extends
BasicScalarPropertyDescriptor implements IEnumerationPropertyDescriptor {
private String enumerationName;
private Integer maxLength;
private boolean queryMultiselect = false;
/**
* {@inheritDoc}
*/
@Override
public AbstractEnumerationPropertyDescriptor clone() {
AbstractEnumerationPropertyDescriptor clonedDescriptor = (AbstractEnumerationPropertyDescriptor) super
.clone();
return clonedDescriptor;
}
/**
* {@inheritDoc}
*/
@Override
public String getEnumerationName() {
return enumerationName;
}
/**
* Gets the maxLength.
*
* @return the maxLength.
*/
@Override
public Integer getMaxLength() {
if (maxLength != null) {
return maxLength;
}
int max = 1;
for (String value : getEnumerationValues()) {
if (value != null && value.length() > max) {
max = value.length();
}
}
return max;
}
/**
* {@inheritDoc}
*/
@Override
public Class<?> getModelType() {
return String.class;
}
/**
* This property allows to customize the i18n keys used to translate the
* enumeration values, thus keeping the actual values shorter. For instance
* consider the <i>gender</i> enumeration, composed of the <i>M</i> (for
* "Male") and <i>F</i> (for "Female") values. Setting an
* enumeration name to "GENDER" will instruct Jspresso to look for
* translations named "GENDER_M" and "GENDER_F". This
* would allow for using <i>M</i> and <i>F</i> in other enumeration domains
* with different semantics and translations.
*
* @param enumerationName
* the enumerationName to set.
*/
public void setEnumerationName(String enumerationName) {
this.enumerationName = enumerationName;
}
/**
* Sets the maxLength.
*
* @param maxLength
* the maxLength to set.
*/
public void setMaxLength(Integer maxLength) {
this.maxLength = maxLength;
}
/**
* Should this enumeration be transformed into a list when building a filter
* screen ? This will allow to place disjunctions on enumeration value.
*
* @return {@code true} if this enumeration be transformed into a list
* when building a filter screen.
*/
public boolean isQueryMultiselect() {
return queryMultiselect;
}
/**
* This property allows to control if the enumeration property view should be
* transformed into a multi-selectable property view in order to allow for
* value disjunctions in filters. Default value is {@code false}.
*
* @param queryMultiselect
* the queryMultiselect to set.
*/
public void setQueryMultiselect(boolean queryMultiselect) {
this.queryMultiselect = queryMultiselect;
}
/**
* {@inheritDoc}
*/
@Override
public String getI18nValue(String value,
ITranslationProvider translationProvider, Locale locale) {
if (isTranslated()) {
return translationProvider.getTranslation(computeEnumerationKey(value),
locale);
}
return value;
}
/**
* Computes an enumeration key.
*
* @param value
* the enumeration value.
* @return the enumeration key.
*/
protected String computeEnumerationKey(Object value) {
return getEnumerationName() + "." + value;
}
/**
* Pre-process setter.
*
* @param component the component
* @param newValue the new value
*/
@SuppressWarnings("SuspiciousMethodCalls")
@Override
public void preprocessSetter(final Object component, final Object newValue) {
if (newValue != null && !"".equals(newValue) && !getEnumerationValues().contains(newValue)) {
IntegrityException ie = new IntegrityException("[" + getName()
+ "] value (" + newValue + ") is not allowed on ["
+ component + "]. Allowed values are: " + getEnumerationValues()) {
private static final long serialVersionUID = 1896266926060894852L;
@Override
public String getI18nMessage(ITranslationProvider translationProvider,
Locale locale) {
return translationProvider.getTranslation(
"integrity.property.outOfRange", new Object[] {
getI18nValue(String.valueOf(newValue), translationProvider, locale),
getI18nName(translationProvider, locale), getEnumerationValues(),
component
}, locale);
}
};
throw ie;
}
super.preprocessSetter(component, newValue);
}
/**
* {@inheritDoc}
*/
@SuppressWarnings("unchecked")
@Override
public IReferencePropertyDescriptor<IDescriptor> createLovReferenceDescriptor() {
BasicReferencePropertyDescriptor<IDescriptor> enumRefPropertyDescriptor = new BasicReferencePropertyDescriptor<>();
enumRefPropertyDescriptor.setName(getName());
BasicComponentDescriptor<IDescriptor> elementDescriptor = (BasicComponentDescriptor<IDescriptor>) (
(BasicComponentDescriptor<IDescriptor>) BasicDescriptorDescriptor.INSTANCE)
.clone();
elementDescriptor.setI18nNameKey(getName());
elementDescriptor.setRenderedProperties(Arrays.asList("description"));
BasicPropertyDescriptor descriptionDescriptor =
(BasicPropertyDescriptor) elementDescriptor.getPropertyDescriptor("description").clone();
descriptionDescriptor.setI18nNameKey(getName());
Collection<IPropertyDescriptor> pds = elementDescriptor.getPropertyDescriptors();
pds.add(descriptionDescriptor);
elementDescriptor.setPropertyDescriptors(pds);
enumRefPropertyDescriptor.setReferencedDescriptor(elementDescriptor);
return enumRefPropertyDescriptor;
}
}