Attachment #146551 for bug #183055

View | Details | Raw Unified | Return to bug 183055 | Differences between

and this patch





/**
 * @since 1.0
 * 
 */
public class BindingMessages {


	 * Returns the resource object with the given key in the resource bundle for
	 * JFace Data Binding. If there isn't any value under the given key, the key
	 * is returned.
	 * 
	 * @param key
	 *            the resource name
	 * @return the string

	/**
	 * Returns a formatted string with the given key in the resource bundle for
	 * JFace Data Binding.
	 * 
	 * @param key
	 * @param arguments
	 * @return formatted string, the key if the key is invalid
	 */
	public static String getFormattedString(String key, Object[] arguments) {
		try {
			return formatMessage(getString(key), arguments);
		} catch (MissingResourceException e) {
			return key;
		}
	}

	/**
	 * Formats the given message pattern with the provided arguments.
	 * 
	 * @param pattern
	 * @param arguments
	 * @return formatted string
	 */
	public static String formatMessage(String pattern, Object[] arguments) {
		return MessageFormat.format(pattern, arguments);
	}
}





import org.eclipse.core.databinding.conversion.IConverter;

import com.ibm.icu.text.DateFormat;

/**
 * Convert a String to a java.util.Date, respecting the current locale
 * 
 * @since 1.0
 */
public class StringToDateConverter extends DateConversionSupport implements
		IConverter {

	/**
	 * 
	 */
	public StringToDateConverter() {
		super();
	}

	/**
	 * 
	 * @param formats
	 */
	public StringToDateConverter(DateFormat[] formats) {
		super(formats);
	}

	public Object convert(Object source) {
		return parse(source.toString());
	}


	public Object getToType() {
		return Date.class;
	}
}




 * </p>
 */
public abstract class DateConversionSupport {
	private final static int DATE_FORMAT = DateFormat.SHORT;
	private final static int DEFAULT_FORMATTER_INDEX = 0;

	private final static int NUM_VIRTUAL_FORMATTERS = 1;

	/**
	 * Alternative formatters for date, time and date/time. Raw milliseconds are
	 * covered as a special case.
	 */
	private final DateFormat[] formatters;

	/**
	 * 
	 */
	public DateConversionSupport() {
		// TODO: These could be shared, but would have to be synchronized.
		this(new DateFormat[] {
				new SimpleDateFormat(BindingMessages
						.getString(BindingMessages.DATE_FORMAT_DATE_TIME)),
				new SimpleDateFormat(BindingMessages
						.getString(BindingMessages.DATEFORMAT_TIME)),
				DateFormat.getDateTimeInstance(DATE_FORMAT, DateFormat.SHORT),
				DateFormat.getDateInstance(DATE_FORMAT),
				DateFormat.getTimeInstance(DateFormat.SHORT),
				DateFormat.getDateTimeInstance(DATE_FORMAT, DateFormat.MEDIUM),
				DateFormat.getTimeInstance(DateFormat.MEDIUM) });
	}

	/**
	 * 
	 * @param formats
	 */
	public DateConversionSupport(DateFormat[] formats) {
		this.formatters = formats;
	}

	/**
	 * Tries all available formatters to parse the given string according to the
	 * default locale or as a raw millisecond value and returns the result of the
	 * first successful run.
	 * 
	 * @param str A string specifying a date according to the default locale or in raw milliseconds
	 * @return The parsed date, or null, if no available formatter could interpret the input string
	 */
	protected Date parse(String str) {
		for (int formatterIdx = 0; formatterIdx < formatters.length; formatterIdx++) {
			Date parsed = parse(str, formatterIdx);
			if (parsed != null) {
				return parsed;
			}
		}
		return null;
	}

	protected Date parse(String str, int formatterIdx) {
		if (formatterIdx >= 0) {
			ParsePosition pos = new ParsePosition(0);
			if (str == null) {
				return null;
			}
			Date date = formatters[formatterIdx].parse(str, pos);
			if (pos.getErrorIndex() != -1 || pos.getIndex() != str.length()) {
				return null;
			}
			return date;
		}
		try {
			long millisecs = Long.parseLong(str);
			return new Date(millisecs);
		}
		catch(NumberFormatException exc) {

	 * @return a string representation of the given date according to the default locale
	 */
	protected String format(Date date) {
		return format(date, DEFAULT_FORMATTER_INDEX);
	}

	protected String format(Date date, int formatterIdx) {
		if (date == null)
			return null;
		if (formatterIdx >= 0) {
			return formatters[formatterIdx].format(date);
		}
		return String.valueOf(date.getTime());
	}

	protected int numFormatters() {
		return formatters.length + NUM_VIRTUAL_FORMATTERS;
	}

	/**

	 * This is for testing purposes only and should not be a part of the API if
	 * this class was to be exposed.
	 * </p>
	 * 
	 * @param index
	 * @return date format
	 */





/**
 * Utility class for the parsing of strings to numbers.
 * 
 * @since 1.0
 */
public class StringToNumberParser {


	/**
	 * The result of a parse operation.
	 * 
	 * @since 1.0
	 */
	public static class ParseResult {

		 * The number as a result of the conversion. <code>null</code> if the
		 * value could not be converted or if the type is not a primitive and
		 * the value was an empty string.
		 * 
		 * @return number
		 */
		public Number getNumber() {

		/**
		 * ParsePosition if an error occurred while parsing. <code>null</code>
		 * if no error occurred.
		 * 
		 * @return parse position
		 */
		public ParsePosition getPosition() {


	/**
	 * Formats an appropriate message for a parsing error.
	 * 
	 * @param value
	 * @param position
	 * @return message

				.getErrorIndex() : position.getIndex();

		if (errorIndex < value.length()) {
			return BindingMessages.getFormattedString(BindingMessages.VALIDATE_NUMBER_PARSE_ERROR,
					new Object[] { value, new Integer(errorIndex + 1),
							new Character(value.charAt(errorIndex)) });
		}
		return BindingMessages.getFormattedString(BindingMessages.VALIDATE_NUMBER_PARSE_ERROR_NO_CHARACTER,
				new Object[] { value, new Integer(errorIndex + 1) });
	}

	/**
	 * Formats an appropriate message for an out of range error.
	 * 
	 * @param minValue
	 * @param maxValue
	 * @param numberFormat when accessed method synchronizes on instance

	 */
	public static String createOutOfRangeMessage(Number minValue,
			Number maxValue, NumberFormat numberFormat) {
		return createOutOfRangeMessage(
				BindingMessages.getString("Validate_NumberOutOfRangeError"), minValue, maxValue, numberFormat); //$NON-NLS-1$
	}

	/**
	 * Formats an appropriate message for an out of range error.
	 * 
	 * @param message
	 * @param minValue
	 * @param maxValue
	 * @param numberFormat
	 *            when accessed method synchronizes on instance
	 * @return message
	 */
	public static String createOutOfRangeMessage(String message,
			Number minValue, Number maxValue, NumberFormat numberFormat) {
		String min = null;
		String max = null;


			max = numberFormat.format(maxValue);
		}

		return BindingMessages.formatMessage(message, new Object[] { min,
				max });
	}

	/**
	 * Returns <code>true</code> if the provided <code>number</code> is in
	 * the range of a integer.
	 * 
	 * @param number
	 * @return <code>true</code> if a valid integer
	 * @throws IllegalArgumentException


	/**
	 * Validates the range of the provided <code>number</code>.
	 * 
	 * @param number
	 * @param bitLength number of bits allowed to be in range
	 * @return <code>true</code> if in range

	/**
	 * Returns <code>true</code> if the provided <code>number</code> is in
	 * the range of a long.
	 * 
	 * @param number
	 * @return <code>true</code> if in range
	 * @throws IllegalArgumentException

	/**
	 * Returns <code>true</code> if the provided <code>number</code> is in
	 * the range of a float.
	 * 
	 * @param number
	 * @return <code>true</code> if in range
	 * @throws IllegalArgumentException

	/**
	 * Returns <code>true</code> if the provided <code>number</code> is in
	 * the range of a double.
	 * 
	 * @param number
	 * @return <code>true</code> if in range
	 * @throws IllegalArgumentException

	/**
	 * Returns <code>true</code> if the provided <code>number</code> is in
	 * the range of a short.
	 * 
	 * @param number
	 * @return <code>true</code> if in range
	 */

	/**
	 * Returns <code>true</code> if the provided <code>number</code> is in
	 * the range of a byte.
	 * 
	 * @param number
	 * @return <code>true</code> if in range
	 */





import org.eclipse.core.databinding.conversion.IConverter;

import com.ibm.icu.text.DateFormat;

/**
 * Converts a Java.util.Date to a String using the current locale. Null date
 * values are converted to an empty string.
 * 
 * @since 1.0
 */
public class DateToStringConverter extends DateConversionSupport implements
		IConverter {

	/**
	 * 
	 */
	public DateToStringConverter() {
		super();
	}

	/**
	 * 
	 * @param format
	 */
	public DateToStringConverter(DateFormat format) {
		super(new DateFormat[] { format });
	}

	public Object convert(Object source) {
		if (source != null)
			return format((Date) source);
		return ""; //$NON-NLS-1$
	}



	public Object getToType() {
		return String.class;
	}
}





import org.eclipse.core.internal.databinding.conversion.StringToNumberParser;


/**
 * Validates that a string is of the appropriate format and is in the range of
 * an integer.

		super(converter, MIN, MAX);
	}

	/**
	 * @param converter
	 * @param parseErrorMessage
	 * @param outOfRangeMessage
	 */
	public StringToIntegerValidator(NumberFormatConverter converter,
			String parseErrorMessage, String outOfRangeMessage) {
		super(converter, MIN, MAX, parseErrorMessage, outOfRangeMessage);
	}

	/* (non-Javadoc)
	 * @see org.eclipse.core.internal.databinding.validation.AbstractStringToNumberValidator#inRange(java.lang.Number)
	 */

Lines 28-51 Link Here

(-)src/org/eclipse/core/internal/databinding/validation/StringToDateValidator.java (-7 / +23 lines)
28	public class StringToDateValidator implements IValidator {	28	public class StringToDateValidator implements IValidator {
29	private final StringToDateConverter converter;	29	private final StringToDateConverter converter;
30		30
		31	private final String parseErrorMessage;
		32
31	/**	33	/**
32	* @param converter	34	* @param converter
33	*/	35	*/
34	public StringToDateValidator(StringToDateConverter converter) {	36	public StringToDateValidator(StringToDateConverter converter) {
		37	this(converter, null);
		38	}
		39
		40	/**
		41	* @param converter
		42	* @param parseErrorMessage
		43	*/
		44	public StringToDateValidator(StringToDateConverter converter,
		45	String parseErrorMessage) {
35	this.converter = converter;	46	this.converter = converter;
		47	this.parseErrorMessage = parseErrorMessage;
36	}	48	}
37		49
38	/*	50	/*
39	* (non-Javadoc)	51	* (non-Javadoc)
40	*	52	*
41	* @see org.eclipse.core.databinding.validation.IValidator#validate(java.lang.Object)	53	* @see org.eclipse.core.databinding.validation.IValidator#validate(java.lang.Object)
42	*/	54	*/
43	public IStatus validate(Object value) {	55	public IStatus validate(Object value) {
44	if (value instanceof String && ((String)value).trim().length()==0) {	56	if (value instanceof String && ((String) value).trim().length() == 0) {
45	return Status.OK_STATUS;	57	return Status.OK_STATUS;
46	}	58	}
47	Object convertedValue = converter.convert(value);	59	Object convertedValue = converter.convert(value);
48	//The StringToDateConverter returns null if it can't parse the date.	60	// The StringToDateConverter returns null if it can't parse the date.
49	if (convertedValue == null) {	61	if (convertedValue == null) {
50	return ValidationStatus.error(getErrorMessage());	62	return ValidationStatus.error(getErrorMessage());
51	}	63	}
Lines 55-64 Link Here
55		67
56	/*	68	/*
57	* (non-Javadoc)	69	* (non-Javadoc)
58	*	70	*
59	* @see org.eclipse.core.internal.databinding.validation.WrappedConverterValidator#getErrorMessage()	71	* @see org.eclipse.core.internal.databinding.validation.WrappedConverterValidator#getErrorMessage()
60	*/	72	*/
61	protected String getErrorMessage() {	73	protected String getErrorMessage() {
		74	if (parseErrorMessage != null) {
		75	return parseErrorMessage;
		76	}
		77
62	Date sampleDate = new Date();	78	Date sampleDate = new Date();
63		79
64	// FIXME We need to use the information from the	80	// FIXME We need to use the information from the
Lines 79-85 Link Here
79	private static class FormatUtil extends DateConversionSupport {	95	private static class FormatUtil extends DateConversionSupport {
80	/*	96	/*
81	* (non-Javadoc)	97	* (non-Javadoc)
82	*	98	*
83	* @see org.eclipse.core.internal.databinding.conversion.DateConversionSupport#numFormatters()	99	* @see org.eclipse.core.internal.databinding.conversion.DateConversionSupport#numFormatters()
84	*/	100	*/
85	protected int numFormatters() {	101	protected int numFormatters() {
Lines 88-94 Link Here
88		104
89	/*	105	/*
90	* (non-Javadoc)	106	* (non-Javadoc)
91	*	107	*
92	* @see org.eclipse.core.internal.databinding.conversion.DateConversionSupport#format(java.util.Date)	108	* @see org.eclipse.core.internal.databinding.conversion.DateConversionSupport#format(java.util.Date)
93	*/	109	*/
94	protected String format(Date date) {	110	protected String format(Date date) {
Lines 97-103 Link Here
97		113
98	/*	114	/*
99	* (non-Javadoc)	115	* (non-Javadoc)
100	*	116	*
101	* @see org.eclipse.core.internal.databinding.conversion.DateConversionSupport#format(java.util.Date,	117	* @see org.eclipse.core.internal.databinding.conversion.DateConversionSupport#format(java.util.Date,
102	* int)	118	* int)
103	*/	119	*/

Lines 11-16 Link Here

(-)src/org/eclipse/core/internal/databinding/validation/AbstractStringToNumberValidator.java (-8 / +46 lines)
11		11
12	package org.eclipse.core.internal.databinding.validation;	12	package org.eclipse.core.internal.databinding.validation;
13		13
		14	import java.text.ParsePosition;
		15
14	import org.eclipse.core.databinding.validation.IValidator;	16	import org.eclipse.core.databinding.validation.IValidator;
15	import org.eclipse.core.databinding.validation.ValidationStatus;	17	import org.eclipse.core.databinding.validation.ValidationStatus;
16	import org.eclipse.core.internal.databinding.conversion.StringToNumberParser;	18	import org.eclipse.core.internal.databinding.conversion.StringToNumberParser;
Lines 31-37 Link Here
31	private final Number min;	33	private final Number min;
32	private final Number max;	34	private final Number max;
33		35
34	private String outOfRangeMessage;	36	private final String parseErrorMessage;
		37	private final String outOfRangeMessage;
		38
		39	private String formattedOutOfRangeMessage;
35		40
36	/**	41	/**
37	* Constructs a new instance.	42	* Constructs a new instance.
Lines 42-50 Link Here
42	*/	47	*/
43	protected AbstractStringToNumberValidator(NumberFormatConverter converter,	48	protected AbstractStringToNumberValidator(NumberFormatConverter converter,
44	Number min, Number max) {	49	Number min, Number max) {
		50	this(converter, min, max, null, null);
		51	}
		52
		53	/**
		54	* Constructs a new instance.
		55	*
		56	* @param converter converter and thus formatter to be used in validation
		57	* @param min minimum value, used for reporting a range error to the user
		58	* @param max maximum value, used for reporting a range error to the user
		59	* @param parseErrorMessage
		60	* @param outOfRangeMessage
		61	*/
		62	protected AbstractStringToNumberValidator(NumberFormatConverter converter,
		63	Number min, Number max, String parseErrorMessage,
		64	String outOfRangeMessage) {
45	this.converter = converter;	65	this.converter = converter;
46	this.min = min;	66	this.min = min;
47	this.max = max;	67	this.max = max;
		68	this.parseErrorMessage = parseErrorMessage;
		69	this.outOfRangeMessage = outOfRangeMessage;
48		70
49	if (converter.getToType() instanceof Class) {	71	if (converter.getToType() instanceof Class) {
50	Class clazz = (Class) converter.getToType();	72	Class clazz = (Class) converter.getToType();
Lines 69-85 Link Here
69		91
70	if (result.getNumber() != null) {	92	if (result.getNumber() != null) {
71	if (!isInRange(result.getNumber())) {	93	if (!isInRange(result.getNumber())) {
72	if (outOfRangeMessage == null) {	94	if (formattedOutOfRangeMessage == null) {
73	outOfRangeMessage = StringToNumberParser	95	formattedOutOfRangeMessage = createOutOfRangeMessage();
74	.createOutOfRangeMessage(min, max, converter
75	.getNumberFormat());
76	}	96	}
77		97
78	return ValidationStatus.error(outOfRangeMessage);	98	return ValidationStatus.error(formattedOutOfRangeMessage);
79	}	99	}
80	} else if (result.getPosition() != null) {	100	} else if (result.getPosition() != null) {
81	String parseErrorMessage = StringToNumberParser.createParseErrorMessage(	101	String parseErrorMessage = createParseErrorMessage((String) value,
82	(String) value, result.getPosition());	102	result.getPosition());
83		103
84	return ValidationStatus.error(parseErrorMessage);	104	return ValidationStatus.error(parseErrorMessage);
85	}	105	}
Lines 94-97 Link Here
94	* @return <code>true</code> if in range	114	* @return <code>true</code> if in range
95	*/	115	*/
96	protected abstract boolean isInRange(Number number);	116	protected abstract boolean isInRange(Number number);
		117
		118	private String createParseErrorMessage(String input,
		119	ParsePosition parsePosition) {
		120	if (parseErrorMessage == null) {
		121	return StringToNumberParser.createParseErrorMessage(input,
		122	parsePosition);
		123	}
		124	return parseErrorMessage;
		125	}
		126
		127	private String createOutOfRangeMessage() {
		128	if (outOfRangeMessage == null) {
		129	return StringToNumberParser.createOutOfRangeMessage(min, max,
		130	converter.getNumberFormat());
		131	}
		132	return StringToNumberParser.createOutOfRangeMessage(outOfRangeMessage,
		133	min, max, converter.getNumberFormat());
		134	}
97	}	135	}

Lines 1-4 Link Here

(-).settings/org.eclipse.jdt.ui.prefs (-2 / +2 lines)
1	#Tue Feb 10 16:05:48 MST 2009	1	#Sat Aug 29 00:54:17 CEST 2009
2	cleanup.add_default_serial_version_id=true	2	cleanup.add_default_serial_version_id=true
3	cleanup.add_generated_serial_version_id=false	3	cleanup.add_generated_serial_version_id=false
4	cleanup.add_missing_annotations=true	4	cleanup.add_missing_annotations=true
Lines 78-84 Link Here
78	sp_cleanup.always_use_this_for_non_static_method_access=false	78	sp_cleanup.always_use_this_for_non_static_method_access=false
79	sp_cleanup.convert_to_enhanced_for_loop=false	79	sp_cleanup.convert_to_enhanced_for_loop=false
80	sp_cleanup.correct_indentation=false	80	sp_cleanup.correct_indentation=false
81	sp_cleanup.format_source_code=true	81	sp_cleanup.format_source_code=false
82	sp_cleanup.format_source_code_changes_only=false	82	sp_cleanup.format_source_code_changes_only=false
83	sp_cleanup.make_local_variable_final=false	83	sp_cleanup.make_local_variable_final=false
84	sp_cleanup.make_parameters_final=false	84	sp_cleanup.make_parameters_final=false

Lines 8-14 Link Here

(-)META-INF/MANIFEST.MF (+2 lines)
8	Bundle-Localization: plugin	8	Bundle-Localization: plugin
9	Export-Package: org.eclipse.core.databinding,	9	Export-Package: org.eclipse.core.databinding,
10	org.eclipse.core.databinding.conversion;x-internal:=false,	10	org.eclipse.core.databinding.conversion;x-internal:=false,
		11	org.eclipse.core.databinding.editing,
11	org.eclipse.core.databinding.validation;x-internal:=false,	12	org.eclipse.core.databinding.validation;x-internal:=false,
		13	org.eclipse.core.databinding.validation.constraint,
12	org.eclipse.core.internal.databinding;x-friends:="org.eclipse.core.databinding.beans",	14	org.eclipse.core.internal.databinding;x-friends:="org.eclipse.core.databinding.beans",
13	org.eclipse.core.internal.databinding.conversion;x-friends:="org.eclipse.jface.tests.databinding",	15	org.eclipse.core.internal.databinding.conversion;x-friends:="org.eclipse.jface.tests.databinding",
14	org.eclipse.core.internal.databinding.validation;x-friends:="org.eclipse.jface.tests.databinding"	16	org.eclipse.core.internal.databinding.validation;x-friends:="org.eclipse.jface.tests.databinding"




/*******************************************************************************
 * Copyright (c) 2009 Ovidio Mallo and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Ovidio Mallo - initial API and implementation (bug 183055)
 ******************************************************************************/

package org.eclipse.core.internal.databinding.validation;

import org.eclipse.core.databinding.validation.IValidator;
import org.eclipse.core.databinding.validation.ValidationStatus;
import org.eclipse.core.runtime.IStatus;

/**
 * @since 1.3
 */
public class NonEmptyStringValidator implements IValidator {

	private final String validationMessage;

	/**
	 * 
	 */
	public NonEmptyStringValidator() {
		this(null);
	}

	/**
	 * @param validationMessage
	 */
	public NonEmptyStringValidator(String validationMessage) {
		// TODO: Externalize
		this.validationMessage = validationMessage != null ? validationMessage
				: "The string must not be empty."; //$NON-NLS-1$
	}

	public IStatus validate(Object value) {
		String input = (String) value;
		if ("".equals(input)) { //$NON-NLS-1$
			return ValidationStatus.error(validationMessage);
		}
		return ValidationStatus.ok();
	}
}




/*******************************************************************************
 * Copyright (c) 2009 Ovidio Mallo and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Ovidio Mallo - initial API and implementation (bug 183055)
 ******************************************************************************/

package org.eclipse.core.databinding.editing;

import org.eclipse.core.databinding.conversion.IConverter;
import org.eclipse.core.databinding.validation.constraint.Constraints;
import org.eclipse.core.databinding.validation.constraint.StringConstraints;
import org.eclipse.core.internal.databinding.conversion.StringStripConverter;

/**
 * @since 1.3
 */
public final class StringEditing extends Editing {

	private StringEditing(IConverter targetConverter) {
		setTargetConverter(targetConverter);
	}

	/**
	 * Creates a new editing object for strings which performs no validation or
	 * conversion.
	 * 
	 * @return The new editing object which performs no validation or
	 *         conversion.
	 */
	public static StringEditing withDefaults() {
		return new StringEditing(null);
	}

	/**
	 * Creates a new editing object which strips whitespace from both ends of
	 * the input string.
	 * 
	 * @param stripToNull
	 *            Whether to convert the input string to <code>null</code> in
	 *            case stripping the input string results in an empty string.
	 * @return The new editing object which strips whitespace from both ends of
	 *         the input string.
	 */
	public static StringEditing stripped(boolean stripToNull) {
		return new StringEditing(new StringStripConverter(stripToNull));
	}

	/**
	 * Returns the target constraints to apply.
	 * 
	 * <p>
	 * This method provides a typesafe access to the {@link StringConstraints
	 * string target constraints} of this editing object and is equivalent to
	 * {@code (StringConstraints) targetConstraints()}.
	 * </p>
	 * 
	 * @return The target constraints to apply.
	 * 
	 * @see #targetConstraints()
	 * @see StringConstraints
	 */
	public StringConstraints targetStringConstraints() {
		return (StringConstraints) targetConstraints();
	}

	/**
	 * Returns the model constraints to apply.
	 * 
	 * <p>
	 * This method provides a typesafe access to the {@link StringConstraints
	 * string model constraints} of this editing object and is equivalent to
	 * {@code (StringConstraints) modelConstraints()}.
	 * </p>
	 * 
	 * @return The target constraints to apply.
	 * 
	 * @see #modelConstraints()
	 * @see StringConstraints
	 */
	public StringConstraints modelStringConstraints() {
		return (StringConstraints) modelConstraints();
	}

	/**
	 * Returns the before-set model constraints to apply.
	 * 
	 * <p>
	 * This method provides a typesafe access to the {@link StringConstraints
	 * string before-set model constraints} of this editing object and is
	 * equivalent to {@code (StringConstraints) beforeSetModelConstraints()}.
	 * </p>
	 * 
	 * @return The target constraints to apply.
	 * 
	 * @see #beforeSetModelConstraints()
	 * @see StringConstraints
	 */
	public StringConstraints beforeSetModelStringConstraints() {
		return (StringConstraints) beforeSetModelConstraints();
	}

	protected Constraints createTargetConstraints() {
		return new StringConstraints();
	}

	protected Constraints createModelConstraints() {
		return new StringConstraints();
	}

	protected Constraints createBeforeSetModelConstraints() {
		return new StringConstraints();
	}

	/**
	 * Convenience method which adds a {@link StringConstraints#required()
	 * required constraint} to the set of {@link #modelStringConstraints()}.
	 * 
	 * @return This editing instance for method chaining.
	 * 
	 * @see StringConstraints#required()
	 * @see #modelStringConstraints()
	 */
	public StringEditing required() {
		modelStringConstraints().required();
		return this;
	}

	/**
	 * Convenience method which adds a {@link StringConstraints#nonEmpty()
	 * non-empty constraint} to the set of {@link #modelStringConstraints()}.
	 * 
	 * @return This editing instance for method chaining.
	 * 
	 * @see StringConstraints#nonEmpty()
	 * @see #modelStringConstraints()
	 */
	public StringEditing nonEmpty() {
		modelStringConstraints().nonEmpty();
		return this;
	}

	/**
	 * Convenience method which adds a {@link StringConstraints#minLength(int)
	 * min-length constraint} to the set of {@link #modelStringConstraints()}.
	 * 
	 * @param minLength
	 *            The min length of the min-length constraint.
	 * @return This editing instance for method chaining.
	 * 
	 * @see StringConstraints#minLength(int)
	 * @see #modelStringConstraints()
	 */
	public StringEditing minLength(int minLength) {
		modelStringConstraints().minLength(minLength);
		return this;
	}

	/**
	 * Convenience method which adds a {@link StringConstraints#maxLength(int)
	 * max-length constraint} to the set of {@link #modelStringConstraints()}.
	 * 
	 * @param maxLength
	 *            The max length of the max-length constraint.
	 * @return This editing instance for method chaining.
	 * 
	 * @see StringConstraints#maxLength(int)
	 * @see #modelStringConstraints()
	 */
	public StringEditing maxLength(int maxLength) {
		modelStringConstraints().maxLength(maxLength);
		return this;
	}

	/**
	 * Convenience method which adds a
	 * {@link StringConstraints#lengthRange(int, int) length-range constraint}
	 * to the set of {@link #modelStringConstraints()}.
	 * 
	 * @param minLength
	 *            The min length of the length-range constraint.
	 * @param maxLength
	 *            The max length of the length-range constraint.
	 * @return This editing instance for method chaining.
	 * 
	 * @see StringConstraints#lengthRange(int, int)
	 * @see #modelStringConstraints()
	 */
	public StringEditing lengthRange(int minLength, int maxLength) {
		modelStringConstraints().lengthRange(minLength, maxLength);
		return this;
	}

	/**
	 * Convenience method which adds a {@link StringConstraints#matches(String)
	 * matches constraint} to the set of {@link #modelStringConstraints()}.
	 * 
	 * @param regex
	 *            The regular expression of the matches constraint.
	 * @return This editing instance for method chaining.
	 * 
	 * @see StringConstraints#matches(String)
	 * @see #modelStringConstraints()
	 */
	public StringEditing matches(String regex) {
		modelStringConstraints().matches(regex);
		return this;
	}
}




/*******************************************************************************
 * Copyright (c) 2009 Ovidio Mallo and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Ovidio Mallo - initial API and implementation (bug 183055)
 ******************************************************************************/

package org.eclipse.core.internal.databinding.conversion;

import org.eclipse.core.databinding.conversion.Converter;

/**
 * @since 1.3
 */
public class StringTrimConverter extends Converter {

	private final boolean trimToNull;

	/**
	 * 
	 * @param trimToNull
	 */
	public StringTrimConverter(boolean trimToNull) {
		super(String.class, String.class);
		this.trimToNull = trimToNull;
	}

	public Object convert(Object fromObject) {
		String string = (String) fromObject;

		if (string != null) {
			string = string.trim();

			if (trimToNull && string.length() == 0) {
				string = null;
			}
		}

		return string;
	}
}




/*******************************************************************************
 * Copyright (c) 2009 Ovidio Mallo and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Ovidio Mallo - initial API and implementation (bug 183055)
 ******************************************************************************/

package org.eclipse.core.databinding.validation.constraint;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import org.eclipse.core.databinding.util.Policy;
import org.eclipse.core.databinding.validation.IValidator;
import org.eclipse.core.internal.databinding.BindingMessages;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.MultiStatus;
import org.eclipse.core.runtime.Status;

/**
 * @since 1.3
 */
public class Constraints {

	/**
	 * Constant denoting an aggregation strategy that merges multiple non-OK
	 * status objects in a {@link MultiStatus}. Returns an OK status result if
	 * all statuses from the set of validators to apply are an OK status.
	 * Returns a single status if there is only one non-OK status.
	 * 
	 * @see #aggregationPolicy(int)
	 */
	public static final int AGGREGATION_MERGED = 1;

	/**
	 * Constant denoting an aggregation strategy that always returns the most
	 * severe status from the set of validators to apply. If there is more than
	 * one status at the same severity level, it picks the first one it
	 * encounters.
	 * 
	 * @see #aggregationPolicy(int)
	 */
	public static final int AGGREGATION_MAX_SEVERITY = 2;

	// Will be initialized lazily.
	private List validators = null;

	private IValidator cachedValidator = null;

	private int aggregationPolicy = AGGREGATION_MAX_SEVERITY;

	/**
	 * Adds a custom validator to the set of constraints to apply.
	 * 
	 * @param validator
	 *            The custom validator to add to the set of constraints.
	 * @return This constraints instance for method chaining.
	 */
	public final Constraints addValidator(IValidator validator) {
		if (validators == null) {
			validators = new ArrayList(2);
		}
		validators.add(validator);
		cachedValidator = null;
		return this;
	}

	/**
	 * Sets the aggregation policy to apply to the individual validations which
	 * constitute this set of constraints.
	 * 
	 * @param policy
	 *            The validation aggregation policy to set. Must be one of
	 *            {@link #AGGREGATION_MERGED} or
	 *            {@link #AGGREGATION_MAX_SEVERITY}.
	 * @return This constraints instance for method chaining.
	 * 
	 * @see #AGGREGATION_MERGED
	 * @see #AGGREGATION_MAX_SEVERITY
	 */
	public final Constraints aggregationPolicy(int policy) {
		this.aggregationPolicy = policy;
		cachedValidator = null;
		return this;
	}

	/**
	 * Creates a validator which enforces the current set of constraints.
	 * 
	 * <p>
	 * Note that this method will return <code>null</code> in case the set of
	 * constraints to apply is empty.
	 * </p>
	 * 
	 * @return A validator which enforces the current set of constraints. May be
	 *         <code>null</code>.
	 */
	public final IValidator createValidator() {
		if (validators != null && !validators.isEmpty()) {
			if (cachedValidator == null) {
				if (validators.size() == 1) {
					cachedValidator = (IValidator) validators.get(0);
				} else {
					IValidator[] currentValidators = (IValidator[]) validators
							.toArray(new IValidator[validators.size()]);
					cachedValidator = new ConstraintsValidator(
							currentValidators, aggregationPolicy);
				}
			}
			return cachedValidator;
		}
		return null;
	}

	private static final class ConstraintsValidator implements IValidator {

		private final IValidator[] validators;

		private final int aggregationPolicy;

		public ConstraintsValidator(IValidator[] validators,
				int aggregationPolicy) {
			this.validators = validators;
			this.aggregationPolicy = aggregationPolicy;
		}

		public IStatus validate(Object value) {
			return (aggregationPolicy == AGGREGATION_MERGED) ? validateMerged(value)
					: validateMaxSeverity(value);
		}

		private IStatus validateMerged(Object value) {
			List statuses = new ArrayList();
			for (int i = 0; i < validators.length; i++) {
				IValidator validator = validators[i];
				IStatus status = validator.validate(value);
				if (!status.isOK()) {
					statuses.add(status);
				}
			}

			if (statuses.size() == 1) {
				return (IStatus) statuses.get(0);
			}

			if (!statuses.isEmpty()) {
				MultiStatus result = new MultiStatus(Policy.JFACE_DATABINDING,
						0, BindingMessages
								.getString(BindingMessages.MULTIPLE_PROBLEMS),
						null);
				for (Iterator it = statuses.iterator(); it.hasNext();) {
					IStatus status = (IStatus) it.next();
					result.merge(status);
				}
				return result;
			}

			return Status.OK_STATUS;
		}

		private IStatus validateMaxSeverity(Object value) {
			int maxSeverity = IStatus.OK;
			IStatus maxStatus = Status.OK_STATUS;
			for (int i = 0; i < validators.length; i++) {
				IValidator validator = validators[i];
				IStatus status = validator.validate(value);
				if (status.getSeverity() > maxSeverity) {
					maxSeverity = status.getSeverity();
					maxStatus = status;
				}
			}
			return maxStatus;
		}
	}
}




/*******************************************************************************
 * Copyright (c) 2009 Ovidio Mallo and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Ovidio Mallo - initial API and implementation (bug 183055)
 ******************************************************************************/

package org.eclipse.core.databinding.editing;

import org.eclipse.core.databinding.Binding;
import org.eclipse.core.databinding.DataBindingContext;
import org.eclipse.core.databinding.UpdateListStrategy;
import org.eclipse.core.databinding.UpdateSetStrategy;
import org.eclipse.core.databinding.UpdateValueStrategy;
import org.eclipse.core.databinding.conversion.IConverter;
import org.eclipse.core.databinding.observable.list.IObservableList;
import org.eclipse.core.databinding.observable.set.IObservableSet;
import org.eclipse.core.databinding.observable.value.IObservableValue;
import org.eclipse.core.databinding.validation.IValidator;
import org.eclipse.core.databinding.validation.constraint.Constraints;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.MultiStatus;

/**
 * @since 1.3
 */
public class Editing {

	private Constraints targetConstraints;

	private Constraints modelConstraints;

	private Constraints beforeSetModelConstraints;

	private IConverter targetConverter;

	private IConverter modelConverter;

	/**
	 * Default constructor which creates an unconfigured editing instance.
	 */
	protected Editing() {
		// empty editing instance
	}

	/**
	 * Creates an unconfigured editing instance.
	 * 
	 * @return A new, unconfigured editing instance.
	 */
	public static Editing create() {
		return new Editing();
	}

	/**
	 * Creates an editing instance with the given target-to-model and
	 * model-to-target converters.
	 * 
	 * @param t2mConverter
	 *            The target-to-model converter to set. May be <code>null</code>
	 *            .
	 * @param m2tConverter
	 *            The model-to-target converter to set. May be <code>null</code>
	 *            .
	 * @return A new editing instance with the given target-to-model and
	 *         model-to-target converters.
	 */
	public static Editing withConverters(IConverter t2mConverter,
			IConverter m2tConverter) {
		Editing editing = new Editing();
		editing.setTargetConverter(t2mConverter);
		editing.setModelConverter(m2tConverter);
		return editing;
	}

	/**
	 * Returns the target constraints to apply.
	 * 
	 * @return The target constraints to apply.
	 * 
	 * @see #createTargetConstraints()
	 */
	public final Constraints targetConstraints() {
		if (targetConstraints == null) {
			targetConstraints = createTargetConstraints();
		}
		return targetConstraints;
	}

	/**
	 * Returns the model constraints to apply.
	 * 
	 * @return The model constraints to apply.
	 * 
	 * @see #createModelConstraints()
	 */
	public final Constraints modelConstraints() {
		if (modelConstraints == null) {
			modelConstraints = createModelConstraints();
		}
		return modelConstraints;
	}

	/**
	 * Returns the before-set model constraints to apply.
	 * 
	 * @return The before-set model constraints to apply.
	 * 
	 * @see #createBeforeSetModelConstraints()
	 */
	public final Constraints beforeSetModelConstraints() {
		if (beforeSetModelConstraints == null) {
			beforeSetModelConstraints = createBeforeSetModelConstraints();
		}
		return beforeSetModelConstraints;
	}

	/**
	 * Creates the target constraints to apply.
	 * 
	 * <p>
	 * The constraints object created by this method will be exposed as the
	 * {@link #targetConstraints()} of this editing object. By default, this
	 * method returns a plain {@link Constraints} object.
	 * </p>
	 * 
	 * <p>
	 * This method will be called lazily the first time the target constraints
	 * are accessed. Subclasses may overwrite this method in order to create a
	 * custom constraints object which will then be typically exposed in the
	 * subclass as API in order to allow for a typesafe access.
	 * </p>
	 * 
	 * @return The target constraints to apply.
	 * 
	 * @see #targetConstraints()
	 */
	protected Constraints createTargetConstraints() {
		return new Constraints();
	}

	/**
	 * Creates the model constraints to apply.
	 * 
	 * <p>
	 * The constraints object created by this method will be exposed as the
	 * {@link #modelConstraints()} of this editing object. By default, this
	 * method returns a plain {@link Constraints} object.
	 * </p>
	 * 
	 * <p>
	 * This method will be called lazily the first time the model constraints
	 * are accessed. Subclasses may overwrite this method in order to create a
	 * custom constraints object which will then be typically exposed in the
	 * subclass as API in order to allow for a typesafe access.
	 * </p>
	 * 
	 * @return The model constraints to apply.
	 * 
	 * @see #modelConstraints()
	 */
	protected Constraints createModelConstraints() {
		return new Constraints();
	}

	/**
	 * Creates the before-set model constraints to apply.
	 * 
	 * <p>
	 * The constraints object created by this method will be exposed as the
	 * {@link #beforeSetModelConstraints()} of this editing object. By default,
	 * this method returns a plain {@link Constraints} object.
	 * </p>
	 * 
	 * <p>
	 * This method will be called lazily the first time the before-set model
	 * constraints are accessed. Subclasses may overwrite this method in order
	 * to create a custom constraints object which will then be typically
	 * exposed in the subclass as API in order to allow for a typesafe access.
	 * </p>
	 * 
	 * @return The before-set model constraints to apply.
	 * 
	 * @see #beforeSetModelConstraints()
	 */
	protected Constraints createBeforeSetModelConstraints() {
		return new Constraints();
	}

	/**
	 * Convenience method which {@link Constraints#addValidator(IValidator)
	 * adds} the given validator to the set of {@link #targetConstraints()}.
	 * 
	 * @param validator
	 *            The validator to add to the target constraints.
	 * @return This editing instance for method chaining.
	 * 
	 * @see Constraints#addValidator(IValidator)
	 * @see #targetConstraints()
	 */
	public final Editing addTargetValidator(IValidator validator) {
		targetConstraints().addValidator(validator);
		return this;
	}

	/**
	 * Convenience method which {@link Constraints#addValidator(IValidator)
	 * adds} the given validator to the set of {@link #modelConstraints()}.
	 * 
	 * @param validator
	 *            The validator to add to the model constraints.
	 * @return This editing instance for method chaining.
	 * 
	 * @see Constraints#addValidator(IValidator)
	 * @see #modelConstraints()
	 */
	public final Editing addModelValidator(IValidator validator) {
		modelConstraints().addValidator(validator);
		return this;
	}

	/**
	 * Convenience method which {@link Constraints#addValidator(IValidator)
	 * adds} the given validator to the set of
	 * {@link #beforeSetModelConstraints()}.
	 * 
	 * @param validator
	 *            The validator to add to the before-set model constraints.
	 * @return This editing instance for method chaining.
	 * 
	 * @see Constraints#addValidator(IValidator)
	 * @see #beforeSetModelConstraints
	 */
	public final Editing addBeforeSetModelValidator(IValidator validator) {
		beforeSetModelConstraints().addValidator(validator);
		return this;
	}

	/**
	 * Sets the target-to-model converter for this editing instance.
	 * 
	 * @param converter
	 *            The target-to-model converter to set.
	 */
	protected final void setTargetConverter(IConverter converter) {
		this.targetConverter = converter;
	}

	/**
	 * Sets the model-to-target converter for this editing instance.
	 * 
	 * @param converter
	 *            The model-to-target converter to set.
	 */
	protected final void setModelConverter(IConverter converter) {
		this.modelConverter = converter;
	}

	/**
	 * Creates a new target-to-model {@link UpdateValueStrategy} with a default
	 * update policy configured by the current state of this editing object.
	 * 
	 * @return A new target-to-model {@link UpdateValueStrategy} configured by
	 *         the current state of this editing object.
	 * 
	 * @see UpdateValueStrategy#UpdateValueStrategy()
	 * @see #applyToT2MValueStrategy(UpdateValueStrategy)
	 */
	public final UpdateValueStrategy createT2MValueStrategy() {
		return applyToT2MValueStrategy(new UpdateValueStrategy());
	}

	/**
	 * Creates a new target-to-model {@link UpdateValueStrategy} with the given
	 * update policy configured by the current state of this editing object.
	 * 
	 * @param updatePolicy
	 *            The update policy to use.
	 * @return A new target-to-model {@link UpdateValueStrategy} configured by
	 *         the current state of this editing object.
	 * 
	 * @see UpdateValueStrategy#UpdateValueStrategy(int)
	 * @see #applyToT2MValueStrategy(UpdateValueStrategy)
	 */
	public final UpdateValueStrategy createT2MValueStrategy(int updatePolicy) {
		return applyToT2MValueStrategy(new UpdateValueStrategy(updatePolicy));
	}

	/**
	 * Creates a new model-to-target {@link UpdateValueStrategy} with a default
	 * update policy configured by the current state of this editing object.
	 * 
	 * @return A new model-to-target {@link UpdateValueStrategy} configured by
	 *         the current state of this editing object.
	 * 
	 * @see UpdateValueStrategy#UpdateValueStrategy()
	 * @see #applyToM2TValueStrategy(UpdateValueStrategy)
	 */
	public final UpdateValueStrategy createM2TValueStrategy() {
		return applyToM2TValueStrategy(new UpdateValueStrategy());
	}

	/**
	 * Creates a new model-to-target {@link UpdateValueStrategy} with the given
	 * update policy configured by the current state of this editing object.
	 * 
	 * @param updatePolicy
	 *            The update policy to use.
	 * @return A new model-to-target {@link UpdateValueStrategy} configured by
	 *         the current state of this editing object.
	 * 
	 * @see UpdateValueStrategy#UpdateValueStrategy(int)
	 * @see #applyToM2TValueStrategy(UpdateValueStrategy)
	 */
	public final UpdateValueStrategy createM2TValueStrategy(int updatePolicy) {
		return applyToM2TValueStrategy(new UpdateValueStrategy(updatePolicy));
	}

	/**
	 * Creates a new target-to-model {@link UpdateListStrategy} with a default
	 * update policy configured by the current state of this editing object.
	 * 
	 * @return A new target-to-model {@link UpdateListStrategy} configured by
	 *         the current state of this editing object.
	 * 
	 * @see UpdateListStrategy#UpdateListStrategy()
	 * @see #applyToT2MListStrategy(UpdateListStrategy)
	 */
	public final UpdateListStrategy createT2MListStrategy() {
		return applyToT2MListStrategy(new UpdateListStrategy());
	}

	/**
	 * Creates a new target-to-model {@link UpdateListStrategy} with the given
	 * update policy configured by the current state of this editing object.
	 * 
	 * @param updatePolicy
	 *            The update policy to use.
	 * @return A new target-to-model {@link UpdateListStrategy} configured by
	 *         the current state of this editing object.
	 * 
	 * @see UpdateListStrategy#UpdateListStrategy(int)
	 * @see #applyToT2MListStrategy(UpdateListStrategy)
	 */
	public final UpdateListStrategy createT2MListStrategy(int updatePolicy) {
		return applyToT2MListStrategy(new UpdateListStrategy(updatePolicy));
	}

	/**
	 * Creates a new model-to-target {@link UpdateListStrategy} with a default
	 * update policy configured by the current state of this editing object.
	 * 
	 * @return A new model-to-target {@link UpdateListStrategy} configured by
	 *         the current state of this editing object.
	 * 
	 * @see UpdateListStrategy#UpdateListStrategy()
	 * @see #applyToM2TListStrategy(UpdateListStrategy)
	 */
	public final UpdateListStrategy createM2TListStrategy() {
		return applyToM2TListStrategy(new UpdateListStrategy());
	}

	/**
	 * Creates a new model-to-target {@link UpdateListStrategy} with the given
	 * update policy configured by the current state of this editing object.
	 * 
	 * @param updatePolicy
	 *            The update policy to use.
	 * @return A new model-to-target {@link UpdateListStrategy} configured by
	 *         the current state of this editing object.
	 * 
	 * @see UpdateListStrategy#UpdateListStrategy(int)
	 * @see #applyToM2TListStrategy(UpdateListStrategy)
	 */
	public final UpdateListStrategy createM2TListStrategy(int updatePolicy) {
		return applyToM2TListStrategy(new UpdateListStrategy(updatePolicy));
	}

	/**
	 * Creates a new target-to-model {@link UpdateSetStrategy} with a default
	 * update policy configured by the current state of this editing object.
	 * 
	 * @return A new target-to-model {@link UpdateSetStrategy} configured by the
	 *         current state of this editing object.
	 * 
	 * @see UpdateListStrategy#UpdateListStrategy()
	 * @see #applyToT2MSetStrategy(UpdateSetStrategy)
	 */
	public final UpdateSetStrategy createT2MSetStrategy() {
		return applyToT2MSetStrategy(new UpdateSetStrategy());
	}

	/**
	 * Creates a new target-to-model {@link UpdateListStrategy} with the given
	 * update policy configured by the current state of this editing object.
	 * 
	 * @param updatePolicy
	 *            The update policy to use.
	 * @return A new target-to-model {@link UpdateListStrategy} configured by
	 *         the current state of this editing object.
	 * 
	 * @see UpdateSetStrategy#UpdateSetStrategy(int)
	 * @see #applyToT2MSetStrategy(UpdateSetStrategy)
	 */
	public final UpdateSetStrategy createT2MSetStrategy(int updatePolicy) {
		return applyToT2MSetStrategy(new UpdateSetStrategy(updatePolicy));
	}

	/**
	 * Creates a new model-to-target {@link UpdateSetStrategy} with a default
	 * update policy configured by the current state of this editing object.
	 * 
	 * @return A new model-to-target {@link UpdateSetStrategy} configured by the
	 *         current state of this editing object.
	 * 
	 * @see UpdateSetStrategy#UpdateSetStrategy()
	 * @see #applyToM2TSetStrategy(UpdateSetStrategy)
	 */
	public final UpdateSetStrategy createM2TSetStrategy() {
		return applyToM2TSetStrategy(new UpdateSetStrategy());
	}

	/**
	 * Creates a new model-to-target {@link UpdateSetStrategy} with the given
	 * update policy configured by the current state of this editing object.
	 * 
	 * @param updatePolicy
	 *            The update policy to use.
	 * @return A new model-to-target {@link UpdateSetStrategy} configured by the
	 *         current state of this editing object.
	 * 
	 * @see UpdateSetStrategy#UpdateSetStrategy(int)
	 * @see #applyToM2TSetStrategy(UpdateSetStrategy)
	 */
	public final UpdateSetStrategy createM2TSetStrategy(int updatePolicy) {
		return applyToM2TSetStrategy(new UpdateSetStrategy(updatePolicy));
	}

	/**
	 * Configures an existing target-to-model {@link UpdateValueStrategy} with
	 * the current state of this editing object.
	 * 
	 * <p>
	 * The configuration is done as follows:
	 * <ul>
	 * <li>
	 * The {@link Constraints#createValidator() validator} of the
	 * {@link #targetConstraints() target constraints} is set as the
	 * {@link UpdateValueStrategy#setAfterGetValidator(IValidator) after-get
	 * validator} of the update strategy.</li>
	 * <li>The {@link #setTargetConverter(IConverter) target converter} is set
	 * as the {@link UpdateValueStrategy#setConverter(IConverter) converter} of
	 * the update strategy.</li>
	 * <li>
	 * The {@link Constraints#createValidator() validator} of the
	 * {@link #modelConstraints() model constraints} is set as the
	 * {@link UpdateValueStrategy#setAfterConvertValidator(IValidator)
	 * after-convert validator} of the update strategy.</li>
	 * The {@link Constraints#createValidator() validator} of the
	 * {@link #beforeSetModelConstraints() before-set model constraints} is set
	 * as the {@link UpdateValueStrategy#setBeforeSetValidator(IValidator)
	 * before-set validator} of the update strategy.</li>
	 * </ul>
	 * </p>
	 * 
	 * @param updateStrategy
	 *            The {@link UpdateValueStrategy} to configure.
	 * @return The passed-in, configured target-to-model
	 *         {@link UpdateValueStrategy}.
	 * 
	 * @see UpdateValueStrategy#setAfterGetValidator(IValidator)
	 * @see UpdateValueStrategy#setConverter(IConverter)
	 * @see UpdateValueStrategy#setAfterConvertValidator(IValidator)
	 * @see UpdateValueStrategy#setBeforeSetValidator(IValidator)
	 */
	public final UpdateValueStrategy applyToT2MValueStrategy(
			UpdateValueStrategy updateStrategy) {
		updateStrategy.setAfterGetValidator(createValidator(targetConstraints));
		updateStrategy.setConverter(targetConverter);
		updateStrategy
				.setAfterConvertValidator(createValidator(modelConstraints));
		updateStrategy
				.setBeforeSetValidator(createValidator(beforeSetModelConstraints));
		return updateStrategy;
	}

	/**
	 * Configures an existing model-to-target {@link UpdateValueStrategy} with
	 * the current state of this editing object by setting the
	 * {@link #setModelConverter(IConverter) model converter} as the
	 * {@link UpdateValueStrategy#setConverter(IConverter) converter} of the
	 * update strategy.
	 * 
	 * @param updateStrategy
	 *            The {@link UpdateValueStrategy} to configure.
	 * @return The passed-in, configured model-to-target
	 *         {@link UpdateValueStrategy}.
	 * 
	 * @see UpdateValueStrategy#setConverter(IConverter)
	 */
	public final UpdateValueStrategy applyToM2TValueStrategy(
			UpdateValueStrategy updateStrategy) {
		updateStrategy.setConverter(modelConverter);
		return updateStrategy;
	}

	/**
	 * Configures an existing target-to-model {@link UpdateListStrategy} with
	 * the current state of this editing object by setting the
	 * {@link #setTargetConverter(IConverter) target converter} as the
	 * {@link UpdateListStrategy#setConverter(IConverter) converter} of the
	 * update strategy.
	 * 
	 * @param updateStrategy
	 *            The {@link UpdateListStrategy} to configure.
	 * @return The passed-in, configured target-to-model
	 *         {@link UpdateListStrategy}.
	 * 
	 * @see UpdateListStrategy#setConverter(IConverter)
	 */
	public final UpdateListStrategy applyToT2MListStrategy(
			UpdateListStrategy updateStrategy) {
		updateStrategy.setConverter(targetConverter);
		return updateStrategy;
	}

	/**
	 * Configures an existing model-to-target {@link UpdateListStrategy} with
	 * the current state of this editing object by setting the
	 * {@link #setModelConverter(IConverter) model converter} as the
	 * {@link UpdateListStrategy#setConverter(IConverter) converter} of the
	 * update strategy.
	 * 
	 * @param updateStrategy
	 *            The {@link UpdateListStrategy} to configure.
	 * @return The passed-in, configured model-to-target
	 *         {@link UpdateListStrategy}.
	 * 
	 * @see UpdateListStrategy#setConverter(IConverter)
	 */
	public final UpdateListStrategy applyToM2TListStrategy(
			UpdateListStrategy updateStrategy) {
		updateStrategy.setConverter(modelConverter);
		return updateStrategy;
	}

	/**
	 * Configures an existing target-to-model {@link UpdateListStrategy} with
	 * the current state of this editing object by setting the
	 * {@link #setTargetConverter(IConverter) target converter} as the
	 * {@link UpdateSetStrategy#setConverter(IConverter) converter} of the
	 * update strategy.
	 * 
	 * @param updateStrategy
	 *            The {@link UpdateSetStrategy} to configure.
	 * @return The passed-in, configured target-to-model
	 *         {@link UpdateSetStrategy}.
	 * 
	 * @see UpdateSetStrategy#setConverter(IConverter)
	 */
	public final UpdateSetStrategy applyToT2MSetStrategy(
			UpdateSetStrategy updateStrategy) {
		updateStrategy.setConverter(targetConverter);
		return updateStrategy;
	}

	/**
	 * Configures an existing model-to-target {@link UpdateSetStrategy} with the
	 * current state of this editing object by setting the
	 * {@link #setModelConverter(IConverter) model converter} as the
	 * {@link UpdateSetStrategy#setConverter(IConverter) converter} of the
	 * update strategy.
	 * 
	 * @param updateStrategy
	 *            The {@link UpdateSetStrategy} to configure.
	 * @return The passed-in, configured model-to-target
	 *         {@link UpdateSetStrategy}.
	 * 
	 * @see UpdateSetStrategy#setConverter(IConverter)
	 */
	public final UpdateSetStrategy applyToM2TSetStrategy(
			UpdateSetStrategy updateStrategy) {
		updateStrategy.setConverter(modelConverter);
		return updateStrategy;
	}

	/**
	 * Converts a target value to a model value by performing the following
	 * steps:
	 * <ul>
	 * <li>
	 * Applying all the {@link #targetConstraints() target constraints} to the
	 * given target value.</li>
	 * <li>
	 * {@link #setTargetConverter(IConverter) Converting} the target value to
	 * the model value.</li>
	 * <li>
	 * Applying all the {@link #modelConstraints() model constraints} to the
	 * converted model value.</li>
	 * <li>
	 * Applying all the {@link #beforeSetModelConstraints() before-set model
	 * constraints} to the converted model value.</li>
	 * </ul>
	 * 
	 * <p>
	 * The conversion process will be aborted by returning <code>null</code>
	 * whenever any of the applied validators produces a {@link IStatus
	 * validation status} having {@link IStatus#getSeverity() severity}
	 * <code>IStatus.ERROR</code> or <code>IStatus.CANCEL</code>. During the
	 * conversion process, any validation status whose severity is different
	 * from <code>IStatus.OK</code> will be {@link MultiStatus#merge(IStatus)
	 * aggregated} on the given <code>validationStatus</code>.
	 * </p>
	 * 
	 * @param targetValue
	 *            The target value to be converted to a model value.
	 * @param validationStatus
	 *            Aggregate validation status to which to add the validations
	 *            produced during the conversion process.
	 * @return The converted model value or <code>null</code> in case the
	 *         conversion has been aborted due to a validation error.
	 */
	public final Object convertToModel(Object targetValue,
			MultiStatus validationStatus) {
		IValidator targetValidator = createValidator(targetConstraints);
		if (!applyValidator(targetValidator, targetValue, validationStatus)) {
			return null;
		}

		Object modelValue = (targetConverter != null) ? targetConverter
				.convert(targetValue) : targetValue;

		IValidator modelValidator = createValidator(modelConstraints);
		if (!applyValidator(modelValidator, modelValue, validationStatus)) {
			return null;
		}

		IValidator beforeSetModelValidator = createValidator(beforeSetModelConstraints);
		if (!applyValidator(beforeSetModelValidator, modelValue,
				validationStatus)) {
			return null;
		}

		return modelValue;
	}

	/**
	 * {@link #setModelConverter(IConverter) Converts} a model value to a target
	 * value.
	 * 
	 * @param modelValue
	 *            The model value to be converted to a target value.
	 * @return The converted target value.
	 */
	public final Object convertToTarget(Object modelValue) {
		return (modelConverter != null) ? modelConverter.convert(modelValue)
				: modelValue;
	}

	/**
	 * Creates a binding between a target and model observable value on the
	 * given binding context by creating new update strategies which will be
	 * both configured with the state of this editing object before passing them
	 * to the binding.
	 * 
	 * <p>
	 * The target-to-model and model-to-target update strategies for the binding
	 * will be created by the methods {@link #createT2MValueStrategy()} and
	 * {@link #createM2TValueStrategy()}, respectively.
	 * </p>
	 * 
	 * @param dbc
	 *            The binding context on which to create the value binding.
	 * @param targetObservableValue
	 *            The target observable value of the binding.
	 * @param modelObservableValue
	 *            The model observable value of the binding.
	 * @return The new value binding.
	 * 
	 * @see #createT2MValueStrategy()
	 * @see #createM2TValueStrategy()
	 * @see DataBindingContext#bindValue(IObservableValue, IObservableValue,
	 *      UpdateValueStrategy, UpdateValueStrategy)
	 */
	public final Binding bindValue(DataBindingContext dbc,
			IObservableValue targetObservableValue,
			IObservableValue modelObservableValue) {
		return dbc.bindValue(targetObservableValue, modelObservableValue,
				createT2MValueStrategy(), createM2TValueStrategy());
	}

	/**
	 * Creates a binding between a target and model observable value on the
	 * given binding context by creating new update strategies with the provided
	 * update policies which will be both configured with the state of this
	 * editing object before passing them to the binding.
	 * 
	 * @param dbc
	 *            The binding context on which to create the value binding.
	 * @param targetObservableValue
	 *            The target observable value of the binding.
	 * @param modelObservableValue
	 *            The model observable value of the binding.
	 * @param t2mUpdatePolicy
	 *            The update policy for the target-to-model
	 *            {@link UpdateValueStrategy} which is
	 *            {@link #createT2MValueStrategy(int) created} and passed to the
	 *            new binding.
	 * @param m2tUpdatePolicy
	 *            The update policy for the model-to-target
	 *            {@link UpdateValueStrategy} which is
	 *            {@link #createM2TValueStrategy(int) created} and passed to the
	 *            new binding.
	 * @return The new value binding.
	 * 
	 * @see #createT2MValueStrategy(int)
	 * @see #createM2TValueStrategy(int)
	 * @see DataBindingContext#bindValue(IObservableValue, IObservableValue,
	 *      UpdateValueStrategy, UpdateValueStrategy)
	 */
	public final Binding bindValue(DataBindingContext dbc,
			IObservableValue targetObservableValue,
			IObservableValue modelObservableValue, int t2mUpdatePolicy,
			int m2tUpdatePolicy) {
		return dbc.bindValue(targetObservableValue, modelObservableValue,
				createT2MValueStrategy(t2mUpdatePolicy),
				createM2TValueStrategy(m2tUpdatePolicy));
	}

	/**
	 * Creates a binding between a target and model observable value on the
	 * given binding context by using the provided update strategies which will
	 * be both configured with the state of this editing object before passing
	 * them to the binding.
	 * 
	 * @param dbc
	 *            The binding context on which to create the value binding.
	 * @param targetObservableValue
	 *            The target observable value of the binding.
	 * @param modelObservableValue
	 *            The model observable value of the binding.
	 * @param t2mUpdateStrategy
	 *            The target-to-model {@link UpdateValueStrategy} of the binding
	 *            to be {@link #applyToT2MValueStrategy(UpdateValueStrategy)
	 *            configured} with the state of this editing object before
	 *            passing it to the binding.
	 * @param m2tUpdateStrategy
	 *            The model-to-target {@link UpdateValueStrategy} of the binding
	 *            to be {@link #applyToM2TValueStrategy(UpdateValueStrategy)
	 *            configured} with the state of this editing object before
	 *            passing it to the binding.
	 * @return The new value binding.
	 * 
	 * @see #applyToT2MValueStrategy(UpdateValueStrategy)
	 * @see #applyToM2TValueStrategy(UpdateValueStrategy)
	 * @see DataBindingContext#bindValue(IObservableValue, IObservableValue,
	 *      UpdateValueStrategy, UpdateValueStrategy)
	 */
	public final Binding bindValue(DataBindingContext dbc,
			IObservableValue targetObservableValue,
			IObservableValue modelObservableValue,
			UpdateValueStrategy t2mUpdateStrategy,
			UpdateValueStrategy m2tUpdateStrategy) {
		return dbc.bindValue(targetObservableValue, modelObservableValue,
				applyToT2MValueStrategy(t2mUpdateStrategy),
				applyToM2TValueStrategy(m2tUpdateStrategy));
	}

	/**
	 * Creates a binding between a target and model observable list on the given
	 * binding context by creating new update strategies which will be both
	 * configured with the state of this editing object before passing them to
	 * the binding.
	 * 
	 * <p>
	 * The target-to-model and model-to-target update strategies for the binding
	 * will be created by the methods {@link #createT2MListStrategy()} and
	 * {@link #createM2TListStrategy()}, respectively.
	 * </p>
	 * 
	 * @param dbc
	 *            The binding context on which to create the list binding.
	 * @param targetObservableList
	 *            The target observable list of the binding.
	 * @param modelObservableList
	 *            The model observable list of the binding.
	 * @return The new list binding.
	 * 
	 * @see #createT2MListStrategy()
	 * @see #createM2TListStrategy()
	 * @see DataBindingContext#bindList(IObservableList, IObservableList,
	 *      UpdateListStrategy, UpdateListStrategy)
	 */
	public final Binding bindList(DataBindingContext dbc,
			IObservableList targetObservableList,
			IObservableList modelObservableList) {
		return dbc.bindList(targetObservableList, modelObservableList,
				createT2MListStrategy(), createM2TListStrategy());
	}

	/**
	 * Creates a binding between a target and model observable list on the given
	 * binding context by creating new update strategies with the provided
	 * update policies which will be both configured with the state of this
	 * editing object before passing them to the binding.
	 * 
	 * @param dbc
	 *            The binding context on which to create the list binding.
	 * @param targetObservableList
	 *            The target observable list of the binding.
	 * @param modelObservableList
	 *            The model observable list of the binding.
	 * @param t2mUpdatePolicy
	 *            The update policy for the target-to-model
	 *            {@link UpdateListStrategy} which is
	 *            {@link #createT2MListStrategy(int) created} and passed to the
	 *            new binding.
	 * @param m2tUpdatePolicy
	 *            The update policy for the model-to-target
	 *            {@link UpdateListStrategy} which is
	 *            {@link #createM2TListStrategy(int) created} and passed to the
	 *            new binding.
	 * @return The new list binding.
	 * 
	 * @see #createT2MListStrategy(int)
	 * @see #createM2TListStrategy(int)
	 * @see DataBindingContext#bindList(IObservableList, IObservableList,
	 *      UpdateListStrategy, UpdateListStrategy)
	 */
	public final Binding bindList(DataBindingContext dbc,
			IObservableList targetObservableList,
			IObservableList modelObservableList, int t2mUpdatePolicy,
			int m2tUpdatePolicy) {
		return dbc.bindList(targetObservableList, modelObservableList,
				createT2MListStrategy(t2mUpdatePolicy),
				createM2TListStrategy(m2tUpdatePolicy));
	}

	/**
	 * Creates a binding between a target and model observable list on the given
	 * binding context by using the provided update strategies which will be
	 * both configured with the state of this editing object before passing them
	 * to the binding.
	 * 
	 * @param dbc
	 *            The binding context on which to create the list binding.
	 * @param targetObservableList
	 *            The target observable list of the binding.
	 * @param modelObservableList
	 *            The model observable list of the binding.
	 * @param t2mUpdateStrategy
	 *            The target-to-model {@link UpdateListStrategy} of the binding
	 *            to be {@link #applyToT2MListStrategy(UpdateListStrategy)
	 *            configured} with the state of this editing object before
	 *            passing it to the binding.
	 * @param m2tUpdateStrategy
	 *            The model-to-target {@link UpdateListStrategy} of the binding
	 *            to be {@link #applyToM2TListStrategy(UpdateListStrategy)
	 *            configured} with the state of this editing object before
	 *            passing it to the binding.
	 * @return The new list binding.
	 * 
	 * @see #applyToT2MListStrategy(UpdateListStrategy)
	 * @see #applyToM2TListStrategy(UpdateListStrategy)
	 * @see DataBindingContext#bindList(IObservableList, IObservableList,
	 *      UpdateListStrategy, UpdateListStrategy)
	 */
	public final Binding bindList(DataBindingContext dbc,
			IObservableList targetObservableList,
			IObservableList modelObservableList,
			UpdateListStrategy t2mUpdateStrategy,
			UpdateListStrategy m2tUpdateStrategy) {
		return dbc.bindList(targetObservableList, modelObservableList,
				applyToT2MListStrategy(t2mUpdateStrategy),
				applyToM2TListStrategy(m2tUpdateStrategy));
	}

	/**
	 * Creates a binding between a target and model observable set on the given
	 * binding context by creating new update strategies which will be both
	 * configured with the state of this editing object before passing them to
	 * the binding.
	 * 
	 * <p>
	 * The target-to-model and model-to-target update strategies for the binding
	 * will be created by the methods {@link #createT2MSetStrategy()} and
	 * {@link #createM2TSetStrategy()}, respectively.
	 * </p>
	 * 
	 * @param dbc
	 *            The binding context on which to create the set binding.
	 * @param targetObservableSet
	 *            The target observable set of the binding.
	 * @param modelObservableSet
	 *            The model observable set of the binding.
	 * @return The new set binding.
	 * 
	 * @see #createT2MSetStrategy()
	 * @see #createM2TSetStrategy()
	 * @see DataBindingContext#bindSet(IObservableSet, IObservableSet,
	 *      UpdateSetStrategy, UpdateSetStrategy)
	 */
	public final Binding bindSet(DataBindingContext dbc,
			IObservableSet targetObservableSet,
			IObservableSet modelObservableSet) {
		return dbc.bindSet(targetObservableSet, modelObservableSet,
				createT2MSetStrategy(), createM2TSetStrategy());
	}

	/**
	 * Creates a binding between a target and model observable set on the given
	 * binding context by creating new update strategies with the provided
	 * update policies which will be both configured with the state of this
	 * editing object before passing them to the binding.
	 * 
	 * @param dbc
	 *            The binding context on which to create the set binding.
	 * @param targetObservableSet
	 *            The target observable set of the binding.
	 * @param modelObservableSet
	 *            The model observable set of the binding.
	 * @param t2mUpdatePolicy
	 *            The update policy for the target-to-model
	 *            {@link UpdateSetStrategy} which is
	 *            {@link #createT2MSetStrategy(int) created} and passed to the
	 *            new binding.
	 * @param m2tUpdatePolicy
	 *            The update policy for the model-to-target
	 *            {@link UpdateSetStrategy} which is
	 *            {@link #createM2TSetStrategy(int) created} and passed to the
	 *            new binding.
	 * @return The new set binding.
	 * 
	 * @see #createT2MSetStrategy(int)
	 * @see #createM2TSetStrategy(int)
	 * @see DataBindingContext#bindSet(IObservableSet, IObservableSet,
	 *      UpdateSetStrategy, UpdateSetStrategy)
	 */
	public final Binding bindSet(DataBindingContext dbc,
			IObservableSet targetObservableSet,
			IObservableSet modelObservableSet, int t2mUpdatePolicy,
			int m2tUpdatePolicy) {
		return dbc.bindSet(targetObservableSet, modelObservableSet,
				createT2MSetStrategy(t2mUpdatePolicy),
				createM2TSetStrategy(m2tUpdatePolicy));
	}

	/**
	 * Creates a binding between a target and model observable set on the given
	 * binding context by using the provided update strategies which will be
	 * both configured with the state of this editing object before passing them
	 * to the binding.
	 * 
	 * @param dbc
	 *            The binding context on which to create the set binding.
	 * @param targetObservableSet
	 *            The target observable set of the binding.
	 * @param modelObservableSet
	 *            The model observable set of the binding.
	 * @param t2mUpdateStrategy
	 *            The target-to-model {@link UpdateSetStrategy} of the binding
	 *            to be {@link #applyToT2MSetStrategy(UpdateSetStrategy)
	 *            configured} with the state of this editing object before
	 *            passing it to the binding.
	 * @param m2tUpdateStrategy
	 *            The model-to-target {@link UpdateSetStrategy} of the binding
	 *            to be {@link #applyToM2TSetStrategy(UpdateSetStrategy)
	 *            configured} with the state of this editing object before
	 *            passing it to the binding.
	 * @return The new set binding.
	 * 
	 * @see #applyToT2MSetStrategy(UpdateSetStrategy)
	 * @see #applyToM2TSetStrategy(UpdateSetStrategy)
	 * @see DataBindingContext#bindSet(IObservableSet, IObservableSet,
	 *      UpdateSetStrategy, UpdateSetStrategy)
	 */
	public final Binding bindSet(DataBindingContext dbc,
			IObservableSet targetObservableSet,
			IObservableSet modelObservableSet,
			UpdateSetStrategy t2mUpdateStrategy,
			UpdateSetStrategy m2tUpdateStrategy) {
		return dbc.bindSet(targetObservableSet, modelObservableSet,
				applyToT2MSetStrategy(t2mUpdateStrategy),
				applyToM2TSetStrategy(m2tUpdateStrategy));
	}

	private static IValidator createValidator(Constraints constraints) {
		return constraints != null ? constraints.createValidator() : null;
	}

	private static boolean applyValidator(IValidator validator, Object value,
			MultiStatus aggregateStatus) {
		if (validator != null) {
			IStatus validationStatus = validator.validate(value);
			if (!validationStatus.isOK()) {
				aggregateStatus.merge(validationStatus);
			}
			return isValid(validationStatus);
		}
		return true;
	}

	private static boolean isValid(IStatus status) {
		return status.isOK() || status.matches(IStatus.INFO | IStatus.WARNING);
	}
}




/*******************************************************************************
 * Copyright (c) 2009 Ovidio Mallo and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Ovidio Mallo - initial API and implementation (bug 183055)
 ******************************************************************************/

package org.eclipse.core.databinding.editing;

import java.util.Date;

import org.eclipse.core.databinding.validation.constraint.Constraints;
import org.eclipse.core.databinding.validation.constraint.DateConstraints;
import org.eclipse.core.databinding.validation.constraint.StringConstraints;
import org.eclipse.core.internal.databinding.conversion.DateToStringConverter;
import org.eclipse.core.internal.databinding.conversion.StringToDateConverter;
import org.eclipse.core.internal.databinding.validation.StringToDateValidator;

import com.ibm.icu.text.DateFormat;

/**
 * @since 1.3
 */
public final class DateEditing extends Editing {

	private final DateFormat displayFormat;

	private DateEditing(DateFormat[] inputFormats, String parseErrorMessage,
			DateFormat displayFormat) {
		this.displayFormat = displayFormat;

		StringToDateConverter targetConverter;
		if (inputFormats == null) {
			targetConverter = new StringToDateConverter();
		} else {
			targetConverter = new StringToDateConverter(inputFormats);
		}

		targetConstraints().addValidator(
				new StringToDateValidator(targetConverter, parseErrorMessage));
		setTargetConverter(targetConverter);
		setModelConverter(displayFormat == null ? new DateToStringConverter()
				: new DateToStringConverter(displayFormat));
	}

	/**
	 * Creates a new editing object which defaults the validations and
	 * conversions used for editing. Uses the default validation message.
	 * 
	 * @return The new editing object using the default validations and
	 *         conversions for editing.
	 */
	public static DateEditing withDefaults() {
		return withDefaults(null);
	}

	/**
	 * Creates a new editing object which defaults the validations and
	 * conversions used for editing. Uses the specified custom validation
	 * message.
	 * 
	 * @param parseErrorMessage
	 *            The validation message issued in case the input string cannot
	 *            be parsed to a date.
	 * @return The new editing object using the default validations and
	 *         conversions for editing.
	 */
	public static DateEditing withDefaults(String parseErrorMessage) {
		return new DateEditing(null, parseErrorMessage, null);
	}

	/**
	 * Creates a new editing object which supports all the given date input
	 * formats and which uses the specified format for displaying a date. Uses
	 * the default validation message.
	 * 
	 * @param inputFormats
	 *            The date formats supported for reading in dates.
	 * @param displayFormat
	 *            The date format for displaying dates.
	 * @return The new editing object configured by the given date formats.
	 */
	public static DateEditing forFormats(DateFormat[] inputFormats,
			DateFormat displayFormat) {
		return new DateEditing(inputFormats, null, displayFormat);
	}

	/**
	 * Creates a new editing object which supports all the given date input
	 * formats and which uses the specified format for displaying a date. Uses
	 * the specified custom validation message.
	 * 
	 * @param inputFormats
	 *            The date formats supported for reading in dates.
	 * @param parseErrorMessage
	 *            The validation message issued in case the input string cannot
	 *            be parsed to a date.
	 * @param displayFormat
	 *            The date format for displaying dates.
	 * @return The new editing object configured by the given date formats.
	 */
	public static DateEditing forFormats(DateFormat[] inputFormats,
			String parseErrorMessage, DateFormat displayFormat) {
		return new DateEditing(inputFormats, parseErrorMessage, displayFormat);
	}

	/**
	 * Returns the target constraints to apply.
	 * 
	 * <p>
	 * This method provides a typesafe access to the {@link StringConstraints
	 * string target constraints} of this editing object and is equivalent to
	 * {@code (StringConstraints) targetConstraints()}.
	 * </p>
	 * 
	 * @return The target constraints to apply.
	 * 
	 * @see #targetConstraints()
	 * @see StringConstraints
	 */
	public StringConstraints targetStringConstraints() {
		return (StringConstraints) targetConstraints();
	}

	/**
	 * Returns the model constraints to apply.
	 * 
	 * <p>
	 * This method provides a typesafe access to the {@link DateConstraints date
	 * model constraints} of this editing object and is equivalent to {@code
	 * (DateConstraints) modelConstraints()}.
	 * </p>
	 * 
	 * @return The target constraints to apply.
	 * 
	 * @see #modelConstraints()
	 * @see DateConstraints
	 */
	public DateConstraints modelDateConstraints() {
		return (DateConstraints) modelConstraints();
	}

	/**
	 * Returns the before-set model constraints to apply.
	 * 
	 * <p>
	 * This method provides a typesafe access to the {@link DateConstraints date
	 * before-set model constraints} of this editing object and is equivalent to
	 * {@code (DateConstraints) beforeSetModelConstraints()}.
	 * </p>
	 * 
	 * @return The target constraints to apply.
	 * 
	 * @see #beforeSetModelConstraints()
	 * @see DateConstraints
	 */
	public DateConstraints beforeSetModelDateConstraints() {
		return (DateConstraints) beforeSetModelConstraints();
	}

	protected Constraints createTargetConstraints() {
		return new StringConstraints();
	}

	protected Constraints createModelConstraints() {
		return new DateConstraints(displayFormat);
	}

	protected Constraints createBeforeSetModelConstraints() {
		return new DateConstraints(displayFormat);
	}

	/**
	 * Convenience method which adds a {@link DateConstraints#required()
	 * required constraint} to the set of {@link #modelDateConstraints()}.
	 * 
	 * @return This editing instance for method chaining.
	 * 
	 * @see DateConstraints#required()
	 * @see #modelDateConstraints()
	 */
	public DateEditing required() {
		modelDateConstraints().required();
		return this;
	}

	/**
	 * Convenience method which adds a {@link DateConstraints#after(Date) after
	 * constraint} to the set of {@link #modelDateConstraints()}.
	 * 
	 * @param date
	 *            The date of the after constraint.
	 * @return This editing instance for method chaining.
	 * 
	 * @see DateConstraints#after(Date)
	 * @see #modelDateConstraints()
	 */
	public DateEditing after(Date date) {
		modelDateConstraints().after(date);
		return this;
	}

	/**
	 * Convenience method which adds a {@link DateConstraints#afterEqual(Date)
	 * after-equal constraint} to the set of {@link #modelDateConstraints()}.
	 * 
	 * @param date
	 *            The date of the after-equal constraint.
	 * @return This editing instance for method chaining.
	 * 
	 * @see DateConstraints#afterEqual(Date)
	 * @see #modelDateConstraints()
	 */
	public DateEditing afterEqual(Date date) {
		modelDateConstraints().afterEqual(date);
		return this;
	}

	/**
	 * Convenience method which adds a {@link DateConstraints#before(Date)
	 * before constraint} to the set of {@link #modelDateConstraints()}.
	 * 
	 * @param date
	 *            The date of the before constraint.
	 * @return This editing instance for method chaining.
	 * 
	 * @see DateConstraints#before(Date)
	 * @see #modelDateConstraints()
	 */
	public DateEditing before(Date date) {
		modelDateConstraints().before(date);
		return this;
	}

	/**
	 * Convenience method which adds a {@link DateConstraints#beforeEqual(Date)
	 * after-equal constraint} to the set of {@link #modelDateConstraints()}.
	 * 
	 * @param date
	 *            The date of the after-equal constraint.
	 * @return This editing instance for method chaining.
	 * 
	 * @see DateConstraints#afterEqual(Date)
	 * @see #modelDateConstraints()
	 */
	public DateEditing beforeEqual(Date date) {
		modelDateConstraints().beforeEqual(date);
		return this;
	}
}




/*******************************************************************************
 * Copyright (c) 2009 Ovidio Mallo and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Ovidio Mallo - initial API and implementation (bug 183055)
 ******************************************************************************/

package org.eclipse.core.internal.databinding.conversion;

import org.eclipse.core.databinding.conversion.Converter;

/**
 * @since 1.3
 */
public class StringStripConverter extends Converter {

	private final boolean stripToNull;

	/**
	 * 
	 * @param stripToNull
	 */
	public StringStripConverter(boolean stripToNull) {
		super(String.class, String.class);
		this.stripToNull = stripToNull;
	}

	public Object convert(Object fromObject) {
		String string = (String) fromObject;

		if (string != null && string.length() != 0) {
			int stripStart = 0;
			while (stripStart < string.length()
					&& Character.isWhitespace(string.charAt(stripStart))) {
				stripStart++;
			}

			int stripEnd = string.length() - 1;
			while (stripEnd >= 0
					&& Character.isWhitespace(string.charAt(stripEnd))) {
				stripEnd--;
			}

			if (stripStart <= stripEnd) {
				string = string.substring(stripStart, stripEnd + 1);
			} else {
				string = ""; //$NON-NLS-1$
			}
		}

		if (stripToNull && string != null && string.length() == 0) {
			string = null;
		}

		return string;
	}
}




/*******************************************************************************
 * Copyright (c) 2009 Ovidio Mallo and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Ovidio Mallo - initial API and implementation (bug 183055)
 ******************************************************************************/

package org.eclipse.core.internal.databinding.validation;

import java.text.MessageFormat;
import java.util.Date;

import org.eclipse.core.databinding.validation.IValidator;
import org.eclipse.core.databinding.validation.ValidationStatus;
import org.eclipse.core.runtime.IStatus;

import com.ibm.icu.text.DateFormat;

/**
 * @since 1.3
 */
public class DateRangeValidator implements IValidator {

	private static final int UNDEFINED = -1;
	private static final int AFTER = 0;
	private static final int AFTER_EQUAL = 1;
	private static final int BEFORE = 2;
	private static final int BEFORE_EQUAL = 3;

	// TODO: Externalize
	private static final String AFTER_MESSAGE = "The date must be after {0}."; //$NON-NLS-1$
	private static final String AFTER_EQUAL_MESSAGE = "The date must be after or on {0}."; //$NON-NLS-1$
	private static final String BEFORE_MESSAGE = "The date must be before {0}."; //$NON-NLS-1$
	private static final String BEFORE_EQUAL_MESSAGE = "The date must be before or on {0}."; //$NON-NLS-1$
	private static final String WITHIN_RANGE_MESSAGE = "The date must lie between {0} and {1}."; //$NON-NLS-1$

	private final Date min;
	private final Date max;
	private final int minConstraint;
	private final int maxConstraint;
	private final String validationMessage;
	private String formattedValidationMessage;
	private final DateFormat format;

	/**
	 * 
	 * @param min
	 * @param max
	 * @param minConstraint
	 * @param maxConstraint
	 * @param validationMessage
	 * @param format
	 */
	private DateRangeValidator(Date min, Date max, int minConstraint,
			int maxConstraint, String validationMessage, DateFormat format) {
		this.min = min;
		this.max = max;
		this.minConstraint = minConstraint;
		this.maxConstraint = maxConstraint;
		this.validationMessage = validationMessage;
		this.format = format;
	}

	/**
	 * 
	 * @param min
	 * @param validationMessage
	 * @param format
	 * @return .
	 */
	public static DateRangeValidator after(Date min, String validationMessage,
			DateFormat format) {
		return new DateRangeValidator(min, null, AFTER, UNDEFINED,
				defaultIfNull(validationMessage, AFTER_MESSAGE), format);
	}

	/**
	 * 
	 * @param min
	 * @param validationMessage
	 * @param format
	 * @return .
	 */
	public static DateRangeValidator afterEqual(Date min,
			String validationMessage, DateFormat format) {
		return new DateRangeValidator(min, null, AFTER_EQUAL, UNDEFINED,
				defaultIfNull(validationMessage, AFTER_EQUAL_MESSAGE), format);
	}

	/**
	 * 
	 * @param max
	 * @param validationMessage
	 * @param format
	 * @return .
	 */
	public static DateRangeValidator before(Date max, String validationMessage,
			DateFormat format) {
		return new DateRangeValidator(null, max, UNDEFINED, BEFORE,
				defaultIfNull(validationMessage, BEFORE_MESSAGE), format);
	}

	/**
	 * 
	 * @param max
	 * @param validationMessage
	 * @param format
	 * @return .
	 */
	public static DateRangeValidator beforeEqual(Date max,
			String validationMessage, DateFormat format) {
		return new DateRangeValidator(null, max, UNDEFINED, BEFORE_EQUAL,
				defaultIfNull(validationMessage, BEFORE_EQUAL_MESSAGE), format);
	}

	/**
	 * 
	 * @param min
	 * @param max
	 * @param validationMessage
	 * @param format
	 * @return .
	 */
	public static DateRangeValidator range(Date min, Date max,
			String validationMessage, DateFormat format) {
		return new DateRangeValidator(min, max, AFTER_EQUAL, BEFORE_EQUAL,
				defaultIfNull(validationMessage, WITHIN_RANGE_MESSAGE), format);
	}

	public IStatus validate(Object value) {
		if (value != null) {
			Date date = (Date) value;
			if ((min != null && !fulfillsConstraint(date, min, minConstraint))
					|| (max != null && !fulfillsConstraint(date, max,
							maxConstraint))) {
				return ValidationStatus.error(getFormattedValidationMessage());
			}
		}
		return ValidationStatus.ok();
	}

	private boolean fulfillsConstraint(Date date1, Date date2, int constraint) {
		switch (constraint) {
		case AFTER:
			return date1.after(date2);
		case AFTER_EQUAL:
			return date1.after(date2) || date1.equals(date2);
		case BEFORE:
			return date1.before(date2);
		case BEFORE_EQUAL:
			return date1.before(date2) || date1.equals(date2);
		case UNDEFINED:
		default:
			throw new IllegalArgumentException(
					"Unsupported constraint: " + constraint); //$NON-NLS-1$
		}
	}

	private String getFormattedValidationMessage() {
		if (formattedValidationMessage == null) {
			formattedValidationMessage = MessageFormat.format(
					validationMessage, getValidationMessageArguments());
		}
		return formattedValidationMessage;
	}

	private String[] getValidationMessageArguments() {
		// TODO: Synchronize formatting to make it thread safe?
		if (min == null) {
			return new String[] { format.format(max) };
		} else if (max == null) {
			return new String[] { format.format(min) };
		}
		return new String[] { format.format(min), format.format(max) };
	}

	private static String defaultIfNull(String string, String defaultString) {
		return (string != null) ? string : defaultString;
	}
}




/*******************************************************************************
 * Copyright (c) 2009 Ovidio Mallo and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Ovidio Mallo - initial API and implementation (bug 183055)
 ******************************************************************************/

package org.eclipse.core.databinding.validation.constraint;

import java.util.Date;

import org.eclipse.core.internal.databinding.validation.DateRangeValidator;
import org.eclipse.core.internal.databinding.validation.NonNullValidator;

import com.ibm.icu.text.DateFormat;

/**
 * @since 1.3
 */
public final class DateConstraints extends Constraints {

	private final DateFormat displayFormat;

	private String requiredMessage = null;

	private String afterMessage = null;

	private String afterEqualMessage = null;

	private String beforeMessage = null;

	private String beforeEqualMessage = null;

	/**
	 * 
	 * @param displayFormat
	 */
	public DateConstraints(DateFormat displayFormat) {
		this.displayFormat = displayFormat;
	}

	/**
	 * Adds a validator ensuring that the parsed date is not <code>null</code>.
	 * Uses the current {@link #requiredMessage(String) validation message}.
	 * 
	 * @return This constraints instance for method chaining.
	 */
	public DateConstraints required() {
		addValidator(new NonNullValidator(requiredMessage));
		return this;
	}

	/**
	 * Sets the validation message to be issued in case the parsed date is
	 * <code>null</code>.
	 * 
	 * @param message
	 *            The validation message to be issued in case the parsed date is
	 *            <code>null</code>.
	 * @return This constraints instance for method chaining.
	 * 
	 * @see #required()
	 */
	public DateConstraints requiredMessage(String message) {
		this.requiredMessage = message;
		return this;
	}

	/**
	 * Adds a validator ensuring that the parsed date is after the given date.
	 * Uses the current {@link #afterMessage(String) validation message}.
	 * 
	 * @param date
	 *            The date which must be before or on the parsed date.
	 * @return This constraints instance for method chaining.
	 * 
	 * @see Date#after(Date)
	 */
	public DateConstraints after(Date date) {
		addValidator(DateRangeValidator
				.after(date, afterMessage, displayFormat));
		return this;
	}

	/**
	 * Sets the validation message to be issued in case the parsed date is not
	 * after a given date.
	 * 
	 * @param message
	 *            The validation message to be issued in case the parsed date is
	 *            not after a given date.
	 * @return This constraints instance for method chaining.
	 * 
	 * @see #after(Date)
	 */
	public DateConstraints afterMessage(String message) {
		this.afterMessage = message;
		return this;
	}

	/**
	 * Adds a validator ensuring that the parsed date is after or on the given
	 * date. Uses the current {@link #afterEqualMessage(String) validation
	 * message}.
	 * 
	 * @param date
	 *            The date which must be before the parsed date.
	 * @return This constraints instance for method chaining.
	 * 
	 * @see Date#after(Date)
	 * @see Date#equals(Object)
	 */
	public DateConstraints afterEqual(Date date) {
		addValidator(DateRangeValidator.afterEqual(date, afterEqualMessage,
				displayFormat));
		return this;
	}

	/**
	 * Sets the validation message to be issued in case the parsed date is not
	 * after or on a given date.
	 * 
	 * @param message
	 *            The validation message to be issued in case the parsed date is
	 *            not after or on a given date.
	 * @return This constraints instance for method chaining.
	 * 
	 * @see #afterEqual(Date)
	 */
	public DateConstraints afterEqualMessage(String message) {
		this.afterEqualMessage = message;
		return this;
	}

	/**
	 * Adds a validator ensuring that the parsed date is before the given date.
	 * Uses the current {@link #beforeMessage(String) validation message}.
	 * 
	 * @param date
	 *            The date which must be after or on the parsed date.
	 * @return This constraints instance for method chaining.
	 * 
	 * @see Date#before(Date)
	 */
	public DateConstraints before(Date date) {
		addValidator(DateRangeValidator.before(date, beforeMessage,
				displayFormat));
		return this;
	}

	/**
	 * Sets the validation message to be issued in case the parsed date is not
	 * before a given date.
	 * 
	 * @param message
	 *            The validation message to be issued in case the parsed date is
	 *            not before a given date.
	 * @return This constraints instance for method chaining.
	 * 
	 * @see #before(Date)
	 */
	public DateConstraints beforeMessage(String message) {
		this.beforeMessage = message;
		return this;
	}

	/**
	 * Adds a validator ensuring that the parsed date is before or on the given
	 * date. Uses the current {@link #beforeEqualMessage(String) validation
	 * message}.
	 * 
	 * @param date
	 *            The date which must be after the parsed date.
	 * @return This constraints instance for method chaining.
	 * 
	 * @see Date#before(Date)
	 * @see Date#equals(Object)
	 */
	public DateConstraints beforeEqual(Date date) {
		addValidator(DateRangeValidator.beforeEqual(date, beforeEqualMessage,
				displayFormat));
		return this;
	}

	/**
	 * Sets the validation message to be issued in case the parsed date is not
	 * before or on a given date.
	 * 
	 * @param message
	 *            The validation message to be issued in case the parsed date is
	 *            not before or on a given date.
	 * @return This constraints instance for method chaining.
	 * 
	 * @see #beforeEqual(Date)
	 */
	public DateConstraints beforeEqualMessage(String message) {
		this.beforeEqualMessage = message;
		return this;
	}
}




/*******************************************************************************
 * Copyright (c) 2009 Ovidio Mallo and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Ovidio Mallo - initial API and implementation (bug 183055)
 ******************************************************************************/

package org.eclipse.core.internal.databinding.validation;

import org.eclipse.core.databinding.validation.IValidator;
import org.eclipse.core.databinding.validation.ValidationStatus;
import org.eclipse.core.runtime.IStatus;

/**
 * @since 1.3
 */
public class NonNullValidator implements IValidator {

	private final String validationMessage;

	/**
	 * 
	 */
	public NonNullValidator() {
		this(null);
	}

	/**
	 * @param validationMessage
	 */
	public NonNullValidator(String validationMessage) {
		// TODO: Externalize
		this.validationMessage = validationMessage != null ? validationMessage
				: "The value must not be empty."; //$NON-NLS-1$
	}

	public IStatus validate(Object value) {
		if (value == null) {
			return ValidationStatus.error(validationMessage);
		}
		return ValidationStatus.ok();
	}
}




/*******************************************************************************
 * Copyright (c) 2009 Ovidio Mallo and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Ovidio Mallo - initial API and implementation (bug 183055)
 ******************************************************************************/

package org.eclipse.core.internal.databinding.validation;

import com.ibm.icu.text.NumberFormat;

/**
 * @since 1.3
 */
public class IntegerRangeValidator extends NumberRangeValidator {

	private static final Integer ZERO = new Integer(0);
	private static final Integer ONE = new Integer(1);

	/**
	 * @param min
	 * @param max
	 * @param minConstraint
	 * @param maxConstraint
	 * @param validationMessage
	 * @param format
	 */
	private IntegerRangeValidator(Number min, Number max, int minConstraint,
			int maxConstraint, String validationMessage, NumberFormat format) {
		super(min, max, minConstraint, maxConstraint, validationMessage, format);
	}

	/**
	 * 
	 * @param min
	 * @param validationMessage
	 * @param format
	 * @return .
	 */
	public static IntegerRangeValidator greater(int min,
			String validationMessage, NumberFormat format) {
		return new IntegerRangeValidator(new Integer(min), null, GREATER,
				UNDEFINED, defaultIfNull(validationMessage, GREATER_MESSAGE),
				format);
	}

	/**
	 * 
	 * @param min
	 * @param validationMessage
	 * @param format
	 * @return .
	 */
	public static IntegerRangeValidator greaterEqual(int min,
			String validationMessage, NumberFormat format) {
		return new IntegerRangeValidator(new Integer(min), null, GREATER_EQUAL,
				UNDEFINED, defaultIfNull(validationMessage,
						GREATER_EQUAL_MESSAGE), format);
	}

	/**
	 * 
	 * @param max
	 * @param validationMessage
	 * @param format
	 * @return .
	 */
	public static IntegerRangeValidator less(int max, String validationMessage,
			NumberFormat format) {
		return new IntegerRangeValidator(null, new Integer(max), UNDEFINED,
				LESS, defaultIfNull(validationMessage, LESS_MESSAGE), format);
	}

	/**
	 * 
	 * @param max
	 * @param validationMessage
	 * @param format
	 * @return .
	 */
	public static IntegerRangeValidator lessEqual(int max,
			String validationMessage, NumberFormat format) {
		return new IntegerRangeValidator(null, new Integer(max), UNDEFINED,
				LESS_EQUAL,
				defaultIfNull(validationMessage, LESS_EQUAL_MESSAGE), format);
	}

	/**
	 * 
	 * @param min
	 * @param max
	 * @param validationMessage
	 * @param format
	 * @return .
	 */
	public static IntegerRangeValidator range(int min, int max,
			String validationMessage, NumberFormat format) {
		return new IntegerRangeValidator(new Integer(min), new Integer(max),
				GREATER_EQUAL, LESS_EQUAL, defaultIfNull(validationMessage,
						WITHIN_RANGE_MESSAGE), format);
	}

	/**
	 * 
	 * @param validationMessage
	 * @param format
	 * @return .
	 */
	public static IntegerRangeValidator positive(String validationMessage,
			NumberFormat format) {
		return new IntegerRangeValidator(ONE, null, GREATER_EQUAL, UNDEFINED,
				defaultIfNull(validationMessage, POSITIVE_MESSAGE), format);
	}

	/**
	 * 
	 * @param validationMessage
	 * @param format
	 * @return .
	 */
	public static IntegerRangeValidator nonNegative(String validationMessage,
			NumberFormat format) {
		return new IntegerRangeValidator(ZERO, null, GREATER_EQUAL, UNDEFINED,
				defaultIfNull(validationMessage, NON_NEGATIVE_MESSAGE), format);
	}

	protected int compare(Number number1, Number number2) {
		Integer integer1 = (Integer) number1;
		Integer integer2 = (Integer) number2;
		return integer1.compareTo(integer2);
	}

	private static String defaultIfNull(String string, String defaultString) {
		return (string != null) ? string : defaultString;
	}
}




/*******************************************************************************
 * Copyright (c) 2009 Ovidio Mallo and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Ovidio Mallo - initial API and implementation (bug 183055)
 ******************************************************************************/

package org.eclipse.core.internal.databinding.validation;

import java.text.MessageFormat;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.eclipse.core.databinding.validation.IValidator;
import org.eclipse.core.databinding.validation.ValidationStatus;
import org.eclipse.core.runtime.IStatus;

/**
 * @since 1.3
 */
public class StringRegexValidator implements IValidator {

	// TODO: Externalize
	private static final String REGEX_VALIDATION_MESSAGE = "The string must match the following pattern: {0}."; //$NON-NLS-1$

	private final Pattern pattern;
	private final String validationMessage;
	private String formattedValidationMessage;

	/**
	 * 
	 * @param regex
	 */
	public StringRegexValidator(String regex) {
		this(regex, null);
	}

	/**
	 * 
	 * @param regex
	 * @param validationMessage
	 */
	public StringRegexValidator(String regex, String validationMessage) {
		this.pattern = Pattern.compile(regex);
		this.validationMessage = validationMessage != null ? validationMessage
				: REGEX_VALIDATION_MESSAGE;
	}

	public IStatus validate(Object value) {
		String input = (String) value;
		if (input != null) {
			Matcher matcher = pattern.matcher(input);
			if (!matcher.matches()) {
				return ValidationStatus.error(getFormattedValidationMessage());
			}
		}
		return ValidationStatus.ok();
	}

	private String getFormattedValidationMessage() {
		if (formattedValidationMessage == null) {
			formattedValidationMessage = MessageFormat.format(
					validationMessage, new String[] { pattern.pattern() });
		}
		return formattedValidationMessage;
	}
}




/*******************************************************************************
 * Copyright (c) 2009 Ovidio Mallo and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Ovidio Mallo - initial API and implementation (bug 183055)
 ******************************************************************************/

package org.eclipse.core.databinding.validation.constraint;

import java.util.regex.Pattern;

import org.eclipse.core.internal.databinding.validation.NonEmptyStringValidator;
import org.eclipse.core.internal.databinding.validation.NonNullValidator;
import org.eclipse.core.internal.databinding.validation.StringLengthValidator;
import org.eclipse.core.internal.databinding.validation.StringRegexValidator;

import com.ibm.icu.text.NumberFormat;

/**
 * @since 1.3
 */
public final class StringConstraints extends Constraints {

	// TODO: Support custom NumberFormat.
	private final NumberFormat integerDisplayFormat = NumberFormat
			.getIntegerInstance();

	private String requiredMessage = null;

	private String nonEmptyMessage = null;

	private String minLengthMessage = null;

	private String maxLengthMessage = null;

	private String lengthRangeMessage = null;

	private String matchesMessage = null;

	/**
	 * Adds a validator ensuring that the parsed integer is not
	 * <code>null</code>. Uses the current {@link #requiredMessage(String)
	 * validation message}.
	 * 
	 * @return This constraints instance for method chaining.
	 */
	public StringConstraints required() {
		addValidator(new NonNullValidator(requiredMessage));
		return this;
	}

	/**
	 * Sets the validation message to be issued in case the input string is
	 * <code>null</code>.
	 * 
	 * @param message
	 *            The validation message to be issued in case the input string
	 *            is <code>null</code>.
	 * @return This constraints instance for method chaining.
	 * 
	 * @see #required()
	 */
	public StringConstraints requiredMessage(String message) {
		this.requiredMessage = message;
		return this;
	}

	/**
	 * Adds a validator ensuring that the parsed integer is not empty. Uses the
	 * current {@link #nonEmptyMessage(String) validation message}.
	 * 
	 * @return This constraints instance for method chaining.
	 */
	public StringConstraints nonEmpty() {
		addValidator(new NonEmptyStringValidator(nonEmptyMessage));
		return this;
	}

	/**
	 * Sets the validation message to be issued in case the input string is
	 * empty.
	 * 
	 * @param message
	 *            The validation message to be issued in case the input string
	 *            is empty.
	 * @return This constraints instance for method chaining.
	 * 
	 * @see #nonEmpty()
	 */
	public StringConstraints nonEmptyMessage(String message) {
		this.nonEmptyMessage = message;
		return this;
	}

	/**
	 * Adds a validator ensuring that the input string has at least the
	 * specified amount of characters. Uses the current
	 * {@link #minLengthMessage(String) validation message}.
	 * 
	 * @param minLength
	 *            The minimal length to be enforced on the input string.
	 * @return This constraints instance for method chaining.
	 */
	public StringConstraints minLength(int minLength) {
		addValidator(StringLengthValidator.minLength(minLength,
				minLengthMessage, integerDisplayFormat));
		return this;
	}

	/**
	 * Sets the validation message to be issued in case the input string does
	 * not have at least a given number of characters.
	 * 
	 * @param message
	 *            The validation message to be issued in case the input string
	 *            does not have at least a given number of characters.
	 * @return This constraints instance for method chaining.
	 * 
	 * @see #minLength(int)
	 */
	public StringConstraints minLengthMessage(String message) {
		this.minLengthMessage = message;
		return this;
	}

	/**
	 * Adds a validator ensuring that the input string has not more than the
	 * specified amount of characters. Uses the current
	 * {@link #maxLengthMessage(String) validation message}.
	 * 
	 * @param maxLength
	 *            The maximum length to be enforced on the input string.
	 * @return This constraints instance for method chaining.
	 */
	public StringConstraints maxLength(int maxLength) {
		addValidator(StringLengthValidator.maxLength(maxLength,
				maxLengthMessage, integerDisplayFormat));
		return this;
	}

	/**
	 * Sets the validation message to be issued in case the input string has
	 * more than a given number of characters.
	 * 
	 * @param message
	 *            The validation message to be issued in case the input string
	 *            has more than a given number of characters.
	 * @return This constraints instance for method chaining.
	 * 
	 * @see #maxLength(int)
	 */
	public StringConstraints maxLengthMessage(String message) {
		this.maxLengthMessage = message;
		return this;
	}

	/**
	 * Adds a validator ensuring that the length of the input string is between
	 * the given bounds. Uses the current {@link #lengthRangeMessage(String)
	 * validation message}.
	 * 
	 * @param minLength
	 *            The minimal length to be enforced on the input string.
	 * @param maxLength
	 *            The maximum length to be enforced on the input string.
	 * @return This constraints instance for method chaining.
	 */
	public StringConstraints lengthRange(int minLength, int maxLength) {
		addValidator(StringLengthValidator.lengthRange(minLength, maxLength,
				lengthRangeMessage, integerDisplayFormat));
		return this;
	}

	/**
	 * Sets the validation message to be issued in case the length of the input
	 * is not between the given bounds.
	 * 
	 * @param message
	 *            The validation message to be issued in case the length of the
	 *            input is not between the given bounds.
	 * @return This constraints instance for method chaining.
	 * 
	 * @see #lengthRange(int, int)
	 */
	public StringConstraints lengthRangeMessage(String message) {
		this.lengthRangeMessage = message;
		return this;
	}

	/**
	 * Adds a validator ensuring that the input string
	 * {@link Pattern#matches(String, CharSequence) matches} the given regular
	 * expression. Uses the current {@link #matchesMessage(String) validation
	 * message}.
	 * 
	 * @param regex
	 *            The regular expression which the input string must match.
	 * @return This constraints instance for method chaining.
	 * 
	 * @see Pattern#matches(String, CharSequence)
	 */
	public StringConstraints matches(String regex) {
		addValidator(new StringRegexValidator(regex, matchesMessage));
		return this;
	}

	/**
	 * Sets the validation message to be issued in case the input string does
	 * not match a given regular expression.
	 * 
	 * @param message
	 *            The validation message to be issued in case the input string
	 *            does not match a given regular expression.
	 * @return This constraints instance for method chaining.
	 * 
	 * @see #matches(String)
	 */
	public StringConstraints matchesMessage(String message) {
		this.matchesMessage = message;
		return this;
	}
}




/*******************************************************************************
 * Copyright (c) 2009 Ovidio Mallo and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Ovidio Mallo - initial API and implementation (bug 183055)
 ******************************************************************************/

package org.eclipse.core.internal.databinding.validation;

import java.text.MessageFormat;

import org.eclipse.core.databinding.validation.IValidator;
import org.eclipse.core.databinding.validation.ValidationStatus;
import org.eclipse.core.runtime.IStatus;

import com.ibm.icu.text.NumberFormat;

/**
 * @since 1.3
 */
public class StringLengthValidator implements IValidator {

	// TODO: Externalize
	private static final String MIN_LENGTH_MESSAGE = "The string must have at least {0} characters."; //$NON-NLS-1$
	private static final String MAX_LENGTH_MESSAGE = "The string must not have more than {0} characters."; //$NON-NLS-1$
	private static final String LENGTH_RANGE_MESSAGE = "The string must have between {0} and {1} characters."; //$NON-NLS-1$

	private final Integer minLength;
	private final Integer maxLength;
	private final String validationMessage;
	private String formattedValidationMessage;
	private final NumberFormat format;

	/**
	 * 
	 * @param minLength
	 * @param maxLength
	 * @param validationMessage
	 * @param format
	 */
	private StringLengthValidator(Integer minLength, Integer maxLength,
			String validationMessage, NumberFormat format) {
		this.minLength = minLength;
		this.maxLength = maxLength;
		this.validationMessage = validationMessage;
		this.format = format;
	}

	/**
	 * 
	 * @param minLength
	 * @param validationMessage
	 * @param format
	 * @return .
	 */
	public static StringLengthValidator minLength(int minLength,
			String validationMessage, NumberFormat format) {
		return new StringLengthValidator(new Integer(minLength), null,
				defaultIfNull(validationMessage, MIN_LENGTH_MESSAGE), format);
	}

	/**
	 * 
	 * @param maxLength
	 * @param validationMessage
	 * @param format
	 * @return .
	 */
	public static StringLengthValidator maxLength(int maxLength,
			String validationMessage, NumberFormat format) {
		return new StringLengthValidator(null, new Integer(maxLength),
				defaultIfNull(validationMessage, MAX_LENGTH_MESSAGE), format);
	}

	/**
	 * 
	 * @param minLength
	 * @param maxLength
	 * @param validationMessage
	 * @param format
	 * @return .
	 */
	public static StringLengthValidator lengthRange(int minLength,
			int maxLength, String validationMessage, NumberFormat format) {
		return new StringLengthValidator(new Integer(minLength), new Integer(
				maxLength), defaultIfNull(validationMessage,
				LENGTH_RANGE_MESSAGE), format);
	}

	public IStatus validate(Object value) {
		String input = (String) value;
		if (input != null) {
			int inputLength = input.length();
			if ((minLength != null && inputLength < minLength.intValue())
					|| maxLength != null && inputLength > maxLength.intValue()) {
				return ValidationStatus.error(getFormattedValidationMessage());
			}
		}
		return ValidationStatus.ok();
	}

	private String getFormattedValidationMessage() {
		if (formattedValidationMessage == null) {
			formattedValidationMessage = MessageFormat.format(
					validationMessage, getValidationMessageArguments());
		}
		return formattedValidationMessage;
	}

	private String[] getValidationMessageArguments() {
		// TODO: Synchronize formatting to make it thread safe?
		if (minLength == null) {
			return new String[] { format.format(maxLength) };
		} else if (maxLength == null) {
			return new String[] { format.format(minLength) };
		}
		return new String[] { format.format(minLength),
				format.format(maxLength) };
	}

	private static String defaultIfNull(String string, String defaultString) {
		return (string != null) ? string : defaultString;
	}
}




/*******************************************************************************
 * Copyright (c) 2009 Ovidio Mallo and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Ovidio Mallo - initial API and implementation (bug 183055)
 ******************************************************************************/

package org.eclipse.core.databinding.editing;

import org.eclipse.core.databinding.conversion.NumberToStringConverter;
import org.eclipse.core.databinding.conversion.StringToNumberConverter;
import org.eclipse.core.databinding.validation.constraint.Constraints;
import org.eclipse.core.databinding.validation.constraint.IntegerConstraints;
import org.eclipse.core.databinding.validation.constraint.StringConstraints;
import org.eclipse.core.internal.databinding.validation.StringToIntegerValidator;

import com.ibm.icu.text.NumberFormat;

/**
 * @since 1.3
 */
public final class IntegerEditing extends Editing {

	private final NumberFormat format;

	private IntegerEditing(NumberFormat format, String parseErrorMessage,
			String outOfRangeMessage) {
		this.format = format;

		StringToNumberConverter targetConverter = StringToNumberConverter
				.toInteger(format, false);

		targetConstraints().addValidator(
				new StringToIntegerValidator(targetConverter,
						parseErrorMessage, outOfRangeMessage));
		setTargetConverter(targetConverter);
		setModelConverter(NumberToStringConverter.fromInteger(format, false));
	}

	/**
	 * Creates a new editing object which defaults the validations and
	 * conversions used for editing based on the platform's locale. Uses the
	 * default validation messages.
	 * 
	 * @return The new editing object using the default validations and
	 *         conversions for editing.
	 * 
	 * @see NumberFormat#getIntegerInstance()
	 */
	public static IntegerEditing withDefaults() {
		return withDefaults(null, null);
	}

	/**
	 * Creates a new editing object which defaults the validations and
	 * conversions used for editing based on the platform's locale. Uses the
	 * specified custom validation messages.
	 * 
	 * @param parseErrorMessage
	 *            The validation message issued in case the input string cannot
	 *            be parsed to an integer.
	 * @param outOfRangeMessage
	 *            The validation message issued in case the input string
	 *            represents an integer whose value is out of range. Can be
	 *            parameterized by the <code>Integer.MIN_VALUE</code> and
	 *            <code>Integer.MAX_VALUE</code> values.
	 * @return The new editing object using the default validations and
	 *         conversions for editing.
	 * 
	 * @see NumberFormat#getIntegerInstance()
	 */
	public static IntegerEditing withDefaults(String parseErrorMessage,
			String outOfRangeMessage) {
		return new IntegerEditing(NumberFormat.getIntegerInstance(),
				parseErrorMessage, outOfRangeMessage);
	}

	/**
	 * Creates a new editing object whose validations and conversions used for
	 * editing are based on the given integer format. Uses the default
	 * validation messages.
	 * 
	 * @param format
	 *            The integer format defining the validations and conversions
	 *            used for editing.
	 * @return The new editing object configured by the given integer format.
	 */
	public static IntegerEditing forFormat(NumberFormat format) {
		return forFormat(format, null, null);
	}

	/**
	 * Creates a new editing object whose validations and conversions used for
	 * editing are based on the given integer format. Uses the specified custom
	 * validation messages.
	 * 
	 * @param format
	 *            The integer format defining the validations and conversions
	 *            used for editing.
	 * @param parseErrorMessage
	 *            The validation message issued in case the input string cannot
	 *            be parsed to an integer.
	 * @param outOfRangeMessage
	 *            The validation message issued in case the input string
	 *            represents an integer whose value is out of range. Can be
	 *            parameterized by the <code>Integer.MIN_VALUE</code> and
	 *            <code>Integer.MAX_VALUE</code> values.
	 * @return The new editing object configured by the given integer format.
	 */
	public static IntegerEditing forFormat(NumberFormat format,
			String parseErrorMessage, String outOfRangeMessage) {
		return new IntegerEditing(format, parseErrorMessage, outOfRangeMessage);
	}

	/**
	 * Returns the target constraints to apply.
	 * 
	 * <p>
	 * This method provides a typesafe access to the {@link StringConstraints
	 * string target constraints} of this editing object and is equivalent to
	 * {@code (StringConstraints) targetConstraints()}.
	 * </p>
	 * 
	 * @return The target constraints to apply.
	 * 
	 * @see #targetConstraints()
	 * @see StringConstraints
	 */
	public StringConstraints targetStringConstraints() {
		return (StringConstraints) targetConstraints();
	}

	/**
	 * Returns the model constraints to apply.
	 * 
	 * <p>
	 * This method provides a typesafe access to the {@link IntegerConstraints
	 * integer model constraints} of this editing object and is equivalent to
	 * {@code (IntegerConstraints) modelConstraints()}.
	 * </p>
	 * 
	 * @return The target constraints to apply.
	 * 
	 * @see #modelConstraints()
	 * @see IntegerConstraints
	 */
	public IntegerConstraints modelIntegerConstraints() {
		return (IntegerConstraints) modelConstraints();
	}

	/**
	 * Returns the before-set model constraints to apply.
	 * 
	 * <p>
	 * This method provides a typesafe access to the {@link IntegerConstraints
	 * integer before-set model constraints} of this editing object and is
	 * equivalent to {@code (IntegerConstraints) beforeSetModelConstraints()}.
	 * </p>
	 * 
	 * @return The target constraints to apply.
	 * 
	 * @see #beforeSetModelConstraints()
	 * @see IntegerConstraints
	 */
	public IntegerConstraints beforeSetModelIntegerConstraints() {
		return (IntegerConstraints) beforeSetModelConstraints();
	}

	protected Constraints createTargetConstraints() {
		return new StringConstraints();
	}

	protected Constraints createModelConstraints() {
		return new IntegerConstraints(format);
	}

	protected Constraints createBeforeSetModelConstraints() {
		return new IntegerConstraints(format);
	}

	/**
	 * Convenience method which adds a {@link IntegerConstraints#required()
	 * required constraint} to the set of {@link #modelIntegerConstraints()}.
	 * 
	 * @return This editing instance for method chaining.
	 * 
	 * @see IntegerConstraints#required()
	 * @see #modelIntegerConstraints()
	 */
	public IntegerEditing required() {
		modelIntegerConstraints().required();
		return this;
	}

	/**
	 * Convenience method which adds a {@link IntegerConstraints#greater(int)
	 * greater constraint} to the set of {@link #modelIntegerConstraints()}.
	 * 
	 * @param number
	 *            The number of the greater constraint.
	 * @return This editing instance for method chaining.
	 * 
	 * @see IntegerConstraints#greater(int)
	 * @see #modelIntegerConstraints()
	 */
	public IntegerEditing greater(int number) {
		modelIntegerConstraints().greater(number);
		return this;
	}

	/**
	 * Convenience method which adds a
	 * {@link IntegerConstraints#greaterEqual(int) greater-equal constraint} to
	 * the set of {@link #modelIntegerConstraints()}.
	 * 
	 * @param number
	 *            The number of the greater-equal constraint.
	 * @return This editing instance for method chaining.
	 * 
	 * @see IntegerConstraints#greaterEqual(int)
	 * @see #modelIntegerConstraints()
	 */
	public IntegerEditing greaterEqual(int number) {
		modelIntegerConstraints().greaterEqual(number);
		return this;
	}

	/**
	 * Convenience method which adds a {@link IntegerConstraints#less(int) less
	 * constraint} to the set of {@link #modelIntegerConstraints()}.
	 * 
	 * @param number
	 *            The number of the less constraint.
	 * @return This editing instance for method chaining.
	 * 
	 * @see IntegerConstraints#less(int)
	 * @see #modelIntegerConstraints()
	 */
	public IntegerEditing less(int number) {
		modelIntegerConstraints().less(number);
		return this;
	}

	/**
	 * Convenience method which adds a {@link IntegerConstraints#lessEqual(int)
	 * less-equal constraint} to the set of {@link #modelIntegerConstraints()}.
	 * 
	 * @param number
	 *            The number of the less-equal constraint.
	 * @return This editing instance for method chaining.
	 * 
	 * @see IntegerConstraints#lessEqual(int)
	 * @see #modelIntegerConstraints()
	 */
	public IntegerEditing lessEqual(int number) {
		modelIntegerConstraints().lessEqual(number);
		return this;
	}

	/**
	 * Convenience method which adds a
	 * {@link IntegerConstraints#range(int, int) range constraint} to the set of
	 * {@link #modelIntegerConstraints()}.
	 * 
	 * @param min
	 *            The min number of the range constraint.
	 * @param max
	 *            The max number of the range constraint.
	 * @return This editing instance for method chaining.
	 * 
	 * @see IntegerConstraints#range(int, int)
	 * @see #modelIntegerConstraints()
	 */
	public IntegerEditing range(int min, int max) {
		modelIntegerConstraints().range(min, max);
		return this;
	}

	/**
	 * Convenience method which adds a {@link IntegerConstraints#positive()
	 * positive constraint} to the set of {@link #modelIntegerConstraints()}.
	 * 
	 * @return This editing instance for method chaining.
	 * 
	 * @see IntegerConstraints#positive()
	 * @see #modelIntegerConstraints()
	 */
	public IntegerEditing positive() {
		modelIntegerConstraints().positive();
		return this;
	}

	/**
	 * Convenience method which adds a {@link IntegerConstraints#nonNegative()
	 * non-negative constraint} to the set of {@link #modelIntegerConstraints()}
	 * .
	 * 
	 * @return This editing instance for method chaining.
	 * 
	 * @see IntegerConstraints#nonNegative()
	 * @see #modelIntegerConstraints()
	 */
	public IntegerEditing nonNegative() {
		modelIntegerConstraints().nonNegative();
		return this;
	}
}




/*******************************************************************************
 * Copyright (c) 2009 Ovidio Mallo and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Ovidio Mallo - initial API and implementation (bug 183055)
 ******************************************************************************/

package org.eclipse.core.databinding.validation.constraint;

import org.eclipse.core.internal.databinding.validation.IntegerRangeValidator;
import org.eclipse.core.internal.databinding.validation.NonNullValidator;

import com.ibm.icu.text.NumberFormat;

/**
 * @since 1.3
 */
public final class IntegerConstraints extends Constraints {

	private final NumberFormat format;

	private String requiredMessage = null;

	private String greaterMessage = null;

	private String greaterEqualMessage = null;

	private String lessMessage = null;

	private String lessEqualMessage = null;

	private String rangeMessage = null;

	private String positiveMessage = null;

	private String nonNegativeMessage = null;

	/**
	 * 
	 * @param format
	 */
	public IntegerConstraints(NumberFormat format) {
		this.format = format;
	}

	/**
	 * Adds a validator ensuring that the parsed integer is not
	 * <code>null</code>. Uses the current {@link #requiredMessage(String)
	 * validation message}.
	 * 
	 * @return This constraints instance for method chaining.
	 */
	public IntegerConstraints required() {
		addValidator(new NonNullValidator(requiredMessage));
		return this;
	}

	/**
	 * Sets the validation message to be issued in case the parsed integer is
	 * <code>null</code>.
	 * 
	 * @param message
	 *            The validation message to be issued in case the parsed integer
	 *            is <code>null</code>.
	 * @return This constraints instance for method chaining.
	 * 
	 * @see #required()
	 */
	public IntegerConstraints requiredMessage(String message) {
		this.requiredMessage = message;
		return this;
	}

	/**
	 * Adds a validator ensuring that the parsed integer is greater than the
	 * given number. Uses the current {@link #greaterMessage(String) validation
	 * message}.
	 * 
	 * @param number
	 *            The number which the parsed integer must be greater than.
	 * @return This constraints instance for method chaining.
	 */
	public IntegerConstraints greater(int number) {
		addValidator(IntegerRangeValidator.greater(number, greaterMessage,
				format));
		return this;
	}

	/**
	 * Sets the validation message to be issued in case the parsed integer is
	 * not greater than a given number.
	 * 
	 * @param message
	 *            The validation message to be issued in case the parsed integer
	 *            is not greater than a given number.
	 * @return This constraints instance for method chaining.
	 * 
	 * @see #greater(int)
	 */
	public IntegerConstraints greaterMessage(String message) {
		this.greaterMessage = message;
		return this;
	}

	/**
	 * Adds a validator ensuring that the parsed integer is greater than or
	 * equal to the given number. Uses the current
	 * {@link #greaterEqualMessage(String) validation message}.
	 * 
	 * @param number
	 *            The number which the parsed integer must be greater than or
	 *            equal to.
	 * @return This constraints instance for method chaining.
	 */
	public IntegerConstraints greaterEqual(int number) {
		addValidator(IntegerRangeValidator.greaterEqual(number,
				greaterEqualMessage, format));
		return this;
	}

	/**
	 * Sets the validation message to be issued in case the parsed integer is
	 * not greater than or equal to a given number.
	 * 
	 * @param message
	 *            The validation message to be issued in case the parsed integer
	 *            is not greater than or equal to a given number.
	 * @return This constraints instance for method chaining.
	 * 
	 * @see #greaterEqual(int)
	 */
	public IntegerConstraints greaterEqualMessage(String message) {
		this.greaterEqualMessage = message;
		return this;
	}

	/**
	 * Adds a validator ensuring that the parsed integer is less than the given
	 * number. Uses the current {@link #lessMessage(String) validation message}.
	 * 
	 * @param number
	 *            The number which the parsed integer must be less than.
	 * @return This constraints instance for method chaining.
	 */
	public IntegerConstraints less(int number) {
		addValidator(IntegerRangeValidator.less(number, lessMessage, format));
		return this;
	}

	/**
	 * Sets the validation message to be issued in case the parsed integer is
	 * not less than a given number.
	 * 
	 * @param message
	 *            The validation message to be issued in case the parsed integer
	 *            is not less than a given number.
	 * @return This constraints instance for method chaining.
	 * 
	 * @see #less(int)
	 */
	public IntegerConstraints lessMessage(String message) {
		this.lessMessage = message;
		return this;
	}

	/**
	 * Adds a validator ensuring that the parsed integer is less than or equal
	 * to the given number. Uses the current {@link #lessEqualMessage(String)
	 * validation message}.
	 * 
	 * @param number
	 *            The number which the parsed integer must be less than or equal
	 *            to.
	 * @return This constraints instance for method chaining.
	 */
	public IntegerConstraints lessEqual(int number) {
		addValidator(IntegerRangeValidator.greaterEqual(number,
				lessEqualMessage, format));
		return this;
	}

	/**
	 * Sets the validation message to be issued in case the parsed integer is
	 * not less than or equal to a given number.
	 * 
	 * @param message
	 *            The validation message to be issued in case the parsed integer
	 *            is not less than or equal to a given number.
	 * @return This constraints instance for method chaining.
	 * 
	 * @see #lessEqual(int)
	 */
	public IntegerConstraints lessEqualMessage(String message) {
		this.lessEqualMessage = message;
		return this;
	}

	/**
	 * Adds a validator ensuring that the parsed integer is within the given
	 * range. Uses the current {@link #rangeMessage(String) validation message}.
	 * 
	 * @param min
	 *            The lower bound of the range (inclusive).
	 * @param max
	 *            The upper bound of the range (inclusive).
	 * @return This constraints instance for method chaining.
	 */
	public IntegerConstraints range(int min, int max) {
		addValidator(IntegerRangeValidator
				.range(min, max, rangeMessage, format));
		return this;
	}

	/**
	 * Sets the validation message to be issued in case the parsed integer is
	 * not within a given range.
	 * 
	 * @param message
	 *            The validation message to be issued in case the parsed integer
	 *            is not within a given range.
	 * @return This constraints instance for method chaining.
	 * 
	 * @see #range(int, int)
	 */
	public IntegerConstraints rangeMessage(String message) {
		this.rangeMessage = message;
		return this;
	}

	/**
	 * Adds a validator ensuring that the parsed integer is positive. Uses the
	 * current {@link #positiveMessage(String) validation message}.
	 * 
	 * @return This constraints instance for method chaining.
	 */
	public IntegerConstraints positive() {
		addValidator(IntegerRangeValidator.positive(positiveMessage, format));
		return this;
	}

	/**
	 * Sets the validation message to be issued in case the parsed integer is
	 * not positive.
	 * 
	 * @param message
	 *            The validation message to be issued in case the parsed integer
	 *            is not positive.
	 * @return This constraints instance for method chaining.
	 * 
	 * @see #positive()
	 */
	public IntegerConstraints positiveMessage(String message) {
		this.positiveMessage = message;
		return this;
	}

	/**
	 * Adds a validator ensuring that the parsed integer is non-negative. Uses
	 * the current {@link #nonNegativeMessage(String) validation message}.
	 * 
	 * @return This constraints instance for method chaining.
	 */
	public IntegerConstraints nonNegative() {
		addValidator(IntegerRangeValidator.nonNegative(nonNegativeMessage,
				format));
		return this;
	}

	/**
	 * Sets the validation message to be issued in case the parsed integer is
	 * negative.
	 * 
	 * @param message
	 *            The validation message to be issued in case the parsed integer
	 *            is negative.
	 * @return This constraints instance for method chaining.
	 * 
	 * @see #nonNegative()
	 */
	public IntegerConstraints nonNegativeMessage(String message) {
		this.nonNegativeMessage = message;
		return this;
	}
}




/*******************************************************************************
 * Copyright (c) 2009 Ovidio Mallo and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Ovidio Mallo - initial API and implementation (bug 183055)
 ******************************************************************************/

package org.eclipse.core.internal.databinding.validation;

import java.text.MessageFormat;

import org.eclipse.core.databinding.validation.IValidator;
import org.eclipse.core.databinding.validation.ValidationStatus;
import org.eclipse.core.runtime.IStatus;

import com.ibm.icu.text.NumberFormat;

/**
 * @since 1.3
 */
public abstract class NumberRangeValidator implements IValidator {

	protected static final int UNDEFINED = -1;
	protected static final int GREATER = 0;
	protected static final int GREATER_EQUAL = 1;
	protected static final int LESS = 2;
	protected static final int LESS_EQUAL = 3;

	// TODO: Externalize
	protected static final String GREATER_MESSAGE = "The value must be greater than {0}."; //$NON-NLS-1$
	protected static final String GREATER_EQUAL_MESSAGE = "The value must be greater than or equal to {0}."; //$NON-NLS-1$
	protected static final String LESS_MESSAGE = "The value must be less than {0}."; //$NON-NLS-1$
	protected static final String LESS_EQUAL_MESSAGE = "The value must be less than or equal to {0}."; //$NON-NLS-1$
	protected static final String WITHIN_RANGE_MESSAGE = "The value must lie between {0} and {1}."; //$NON-NLS-1$
	protected static final String POSITIVE_MESSAGE = "The value must be positive."; //$NON-NLS-1$
	protected static final String NON_NEGATIVE_MESSAGE = "The value must not be negative."; //$NON-NLS-1$

	private final Number min;
	private final Number max;
	private final int minConstraint;
	private final int maxConstraint;
	private final String validationMessage;
	private String formattedValidationMessage;
	private final NumberFormat format;

	/**
	 * 
	 * @param min
	 * @param max
	 * @param minConstraint
	 * @param maxConstraint
	 * @param validationMessage
	 * @param format
	 */
	protected NumberRangeValidator(Number min, Number max, int minConstraint,
			int maxConstraint, String validationMessage, NumberFormat format) {
		this.min = min;
		this.max = max;
		this.minConstraint = minConstraint;
		this.maxConstraint = maxConstraint;
		this.validationMessage = validationMessage;
		this.format = format;
	}

	public IStatus validate(Object value) {
		if (value != null) {
			Number number = (Number) value;
			if ((min != null && !fulfillsConstraint(number, min, minConstraint))
					|| (max != null && !fulfillsConstraint(number, max,
							maxConstraint))) {
				return ValidationStatus.error(getFormattedValidationMessage());
			}
		}
		return ValidationStatus.ok();
	}

	private boolean fulfillsConstraint(Number number1, Number number2,
			int constraint) {
		int compareResult = compare(number1, number2);
		switch (constraint) {
		case GREATER:
			return compareResult > 0;
		case GREATER_EQUAL:
			return compareResult >= 0;
		case LESS:
			return compareResult < 0;
		case LESS_EQUAL:
			return compareResult <= 0;
		case UNDEFINED:
		default:
			throw new IllegalArgumentException(
					"Unsupported constraint: " + constraint); //$NON-NLS-1$
		}
	}

	protected abstract int compare(Number number1, Number number2);

	private String getFormattedValidationMessage() {
		if (formattedValidationMessage == null) {
			formattedValidationMessage = MessageFormat.format(
					validationMessage, getValidationMessageArguments());
		}
		return formattedValidationMessage;
	}

	private String[] getValidationMessageArguments() {
		// TODO: Synchronize formatting to make it thread safe?
		if (min == null) {
			return new String[] { format.format(max) };
		} else if (max == null) {
			return new String[] { format.format(min) };
		}
		return new String[] { format.format(min), format.format(max) };
	}
}

Lines 1-4 Link Here

(-).settings/org.eclipse.jdt.ui.prefs (-2 / +2 lines)
1	#Tue Feb 10 16:06:02 MST 2009	1	#Fri Jun 12 23:17:33 CEST 2009
2	cleanup.add_default_serial_version_id=true	2	cleanup.add_default_serial_version_id=true
3	cleanup.add_generated_serial_version_id=false	3	cleanup.add_generated_serial_version_id=false
4	cleanup.add_missing_annotations=true	4	cleanup.add_missing_annotations=true
Lines 78-84 Link Here
78	sp_cleanup.always_use_this_for_non_static_method_access=false	78	sp_cleanup.always_use_this_for_non_static_method_access=false
79	sp_cleanup.convert_to_enhanced_for_loop=false	79	sp_cleanup.convert_to_enhanced_for_loop=false
80	sp_cleanup.correct_indentation=false	80	sp_cleanup.correct_indentation=false
81	sp_cleanup.format_source_code=true	81	sp_cleanup.format_source_code=false
82	sp_cleanup.format_source_code_changes_only=false	82	sp_cleanup.format_source_code_changes_only=false
83	sp_cleanup.make_local_variable_final=false	83	sp_cleanup.make_local_variable_final=false
84	sp_cleanup.make_parameters_final=false	84	sp_cleanup.make_parameters_final=false

Lines 17-21 Link Here

(-)META-INF/MANIFEST.MF (-1 / +2 lines)
17	org.eclipse.jface.examples.databinding.mask.internal;x-internal:=true,	17	org.eclipse.jface.examples.databinding.mask.internal;x-internal:=true,
18	org.eclipse.jface.examples.databinding.model;x-internal:=false,	18	org.eclipse.jface.examples.databinding.model;x-internal:=false,
19	org.eclipse.jface.examples.databinding.radioGroup;x-internal:=false	19	org.eclipse.jface.examples.databinding.radioGroup;x-internal:=false
20	Import-Package: com.ibm.icu.text	20	Import-Package: com.ibm.icu.math,
		21	com.ibm.icu.text
21	Bundle-RequiredExecutionEnvironment: J2SE-1.5	22	Bundle-RequiredExecutionEnvironment: J2SE-1.5




/*******************************************************************************
 * Copyright (c) 2006, 2009 Ovidio Mallo and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Ovidio Mallo - initial API and implementation (bug 183055)
 ******************************************************************************/

package org.eclipse.jface.examples.databinding.snippets;

import java.util.Calendar;
import java.util.Date;

import org.eclipse.core.databinding.Binding;
import org.eclipse.core.databinding.DataBindingContext;
import org.eclipse.core.databinding.editing.DateEditing;
import org.eclipse.core.databinding.editing.Editing;
import org.eclipse.core.databinding.editing.IntegerEditing;
import org.eclipse.core.databinding.observable.Realm;
import org.eclipse.core.databinding.observable.list.WritableList;
import org.eclipse.core.databinding.observable.value.IObservableValue;
import org.eclipse.core.databinding.observable.value.WritableValue;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.jface.databinding.swt.ISWTObservableValue;
import org.eclipse.jface.databinding.swt.SWTObservables;
import org.eclipse.jface.databinding.viewers.ObservableListContentProvider;
import org.eclipse.jface.examples.databinding.util.EditingFactory;
import org.eclipse.jface.internal.databinding.provisional.fieldassist.ControlDecorationSupport;
import org.eclipse.jface.layout.GridDataFactory;
import org.eclipse.jface.layout.GridLayoutFactory;
import org.eclipse.jface.viewers.LabelProvider;
import org.eclipse.jface.viewers.ListViewer;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.FocusAdapter;
import org.eclipse.swt.events.FocusEvent;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Group;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Text;

public class Snippet035Editing {

	private DataBindingContext dbc;

	public static void main(String[] args) {
		Display display = new Display();

		Realm.runWithDefault(SWTObservables.getRealm(display), new Runnable() {
			public void run() {
				Shell shell = new Snippet035Editing().createShell();
				Display display = Display.getCurrent();
				while (!shell.isDisposed()) {
					if (!display.readAndDispatch()) {
						display.sleep();
					}
				}
			}
		});
	}

	private Shell createShell() {
		Display display = Display.getCurrent();
		Shell shell = new Shell(display);
		shell.setText("Editing");
		shell.setLayout(new GridLayout(1, false));

		dbc = new DataBindingContext();

		createValueSection(shell);
		createListSection(shell);

		shell.pack();
		shell.open();

		return shell;
	}

	private void createValueSection(Composite parent) {
		Group section = createSectionGroup(parent, "Value bindings", false);

		// Edit an e-mail address.
		Text emailText = createTextField(section, "E-Mail*");
		Editing emailEditing = EditingFactory.forEmailString().required();
		bindTextField(emailText, new WritableValue(), emailEditing);

		// Edit a required, positive integer and use the default validation message.
		Text positiveText = createTextField(section, "Positive value*");
		IntegerEditing positiveEditing = EditingFactory.forInteger().required().positive();
		bindTextField(positiveText, new WritableValue(), positiveEditing);

		// Edit an integer within the range [1, 100] and use the default
		// validation message.
		Text rangeText = createTextField(section, "Value in [1, 100]");
		IntegerEditing rangeEditing = EditingFactory.forInteger().range(1, 100);
		bindTextField(rangeText, new WritableValue(new Integer(0), null), rangeEditing);

		// Edit a percentage value which must lie within [0, 100] and use a custom
		// validation message which indicates that the value actually represents
		// a percentage value.
		Text percentText = createTextField(section, "Value [%]");
		IntegerEditing percentEditing = EditingFactory.forInteger();
		percentEditing.modelIntegerConstraints().rangeMessage("Please specify a valid percentage value within [{0}, {1}].").range(0, 100);
		bindTextField(percentText, new WritableValue(new Integer(-1), null), percentEditing);

		// Edit a hex integer within the range [0x00, 0xff]. The range validation
		// message will display the range boundaries in hex format as well.
		Text hexText = createTextField(section, "Hex value in [0x00, 0xff]");
		IntegerEditing hexEditing = EditingFactory.forHexInteger(2).range(0x00, 0xff);
		bindTextField(hexText, new WritableValue(new Integer(0), null), hexEditing);
	}

	private void createListSection(Composite parent) {
		Group section = createSectionGroup(parent, "List bindings", true);

		// Our date should be >= 01.01.1990.
		Calendar year1990Calendar = Calendar.getInstance();
		year1990Calendar.clear();
		year1990Calendar.set(1990, 0, 1);
		Date year1990 = year1990Calendar.getTime();

		// Edit a date supporting the default input/display patterns.
		Text dateText = createTextField(section, "Date");
		DateEditing dateEditing = EditingFactory.forDate().afterEqual(year1990);
		final WritableValue dateObservable = new WritableValue();
		final Binding dateBinding = bindTextField(dateText, dateObservable, dateEditing);

		// Create a list to which the dates are added when the user hits ENTER.
		new Label(section, SWT.LEFT);
		ListViewer dateListViewer = new ListViewer(section);
		GridDataFactory.fillDefaults().grab(true, true).hint(150, 200).applyTo(dateListViewer.getList());

		dateListViewer.setContentProvider(new ObservableListContentProvider());
		dateListViewer.setLabelProvider(new LabelProvider());

		// We use the same DateEditing object as for the text field above to
		// create a list binding which maps the entered dates to their string
		// representation which is then set as input on the ListViewer.
		final WritableList targetDateList = new WritableList();
		final WritableList modelDateList = new WritableList();
		dbc.bindList(
				targetDateList,
				modelDateList,
				dateEditing.createT2MListStrategy(),
				dateEditing.createM2TListStrategy());

		// Set the list containing the string representation of the dates as input.
		dateListViewer.setInput(targetDateList);

		// Add the current date in the text field when the user hits ENTER.
		dateText.addSelectionListener(new SelectionAdapter() {
			public void widgetDefaultSelected(SelectionEvent e) {
				IStatus dateValidationStatus = (IStatus) dateBinding.getValidationStatus().getValue();
				Date date = (Date) dateObservable.getValue();
				if (dateValidationStatus.isOK() && date != null) {
					modelDateList.add(date);
				}
			}
		});
	}

	private Binding bindTextField(Text text, IObservableValue modelValue, Editing editing) {
		// Create the binding using the editing object.
		ISWTObservableValue textObservable = SWTObservables.observeText(text, SWT.Modify);
		Binding binding = editing.bindValue(dbc, textObservable, modelValue);

		// Decorate the control with the validation status.
		ControlDecorationSupport.create(binding, SWT.TOP);

		// Re-format when the text field looses the focus in order to always
		// display the model in the default format in case multiple input formats
		// are supported.
		formatOnFocusOut(text, binding);

		return binding;
	}

	private static void formatOnFocusOut(final Control control, final Binding binding) {
		control.addFocusListener(new FocusAdapter() {
			public void focusLost(FocusEvent e) {
				IStatus dateValidationStatus = (IStatus) binding.getValidationStatus().getValue();
				if (dateValidationStatus.isOK()) {
					binding.updateModelToTarget();
				}
			}
		});
	}

	private static Group createSectionGroup(Composite parent, String groupText, boolean grabVertical) {
		Group section = new Group(parent, SWT.SHADOW_ETCHED_IN);
		section.setText(groupText);
		GridLayoutFactory.fillDefaults().numColumns(2).equalWidth(false).margins(5, 5).spacing(15, 5).applyTo(section);
		GridDataFactory.fillDefaults().grab(true, grabVertical).applyTo(section);
		return section;
	}

	private static Text createTextField(Composite parent, String labelText) {
		Label label = new Label(parent, SWT.LEFT);
		label.setText(labelText);
		GridDataFactory.fillDefaults().align(SWT.LEFT, SWT.CENTER).applyTo(label);

		Text text = new Text(parent, SWT.BORDER);
		GridDataFactory.fillDefaults().grab(true, false).hint(150, SWT.DEFAULT).applyTo(text);

		return text;
	}
}




/*******************************************************************************
 * Copyright (c) 2009 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 ******************************************************************************/

package org.eclipse.jface.examples.databinding.util;

import org.eclipse.core.databinding.editing.DateEditing;
import org.eclipse.core.databinding.editing.IntegerEditing;
import org.eclipse.core.databinding.editing.StringEditing;

import com.ibm.icu.text.DateFormat;
import com.ibm.icu.text.SimpleDateFormat;

/**
 * @since 3.2
 */
public final class EditingFactory {

	private static final String REQUIRED_MESSAGE = "Please specify a value.";

	private static final String INTEGER_PARSE_ERROR_MESSAGE = "The input is invalid.";

	private static final String INTEGER_OUT_OF_RANGE_MESSAGE = "The value lies outside the supported range.";

	private static final String INTEGER_RANGE_MESSAGE = "The value must lie between {0} and {1}.";

	private static final String[] DATE_INPUT_PATTERNS = new String[] {
		"dd.MM.yy",
		"dd/MM/yy",
		"dd.MM.yyyy",
		"dd/MM/yyyy"
	};

	private static final String DATE_DISPLAY_PATTERN = "dd.MM.yyyy";

	private static final String DATE_PARSE_ERROR_MESSAGE = createDateParseErrorMessage(DATE_INPUT_PATTERNS);

	private static final String EMAIL_REGEX = "\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,4}\\b";

	private static final String EMAIL_ERROR_MESSAGE = "Please specify a valid e-mail address.";

	private EditingFactory() {
		// prevent instantiation
	}

	public static StringEditing forString() {
		return StringEditing.stripped(true);
	}

	public static StringEditing forEmailString() {
		StringEditing editing = StringEditing.stripped(true);
		editing.modelStringConstraints()
				.matchesMessage(EMAIL_ERROR_MESSAGE)
				.matches(EMAIL_REGEX);
		return editing;
	}

	public static IntegerEditing forInteger() {
		IntegerEditing editing = IntegerEditing.withDefaults(
				INTEGER_PARSE_ERROR_MESSAGE,
				INTEGER_OUT_OF_RANGE_MESSAGE);
		configure(editing);
		return editing;
	}

	public static IntegerEditing forHexInteger(int digits) {
		IntegerEditing editing = IntegerEditing.forFormat(
				RadixNumberFormat.getHexInstance("0x", digits),
				INTEGER_PARSE_ERROR_MESSAGE,
				INTEGER_OUT_OF_RANGE_MESSAGE);
		configure(editing);
		return editing;
	}

	private static void configure(IntegerEditing editing) {
		editing.modelIntegerConstraints()
				.requiredMessage(REQUIRED_MESSAGE)
				.rangeMessage(INTEGER_RANGE_MESSAGE);
	}

	public static DateEditing forDate() {
		DateEditing editing = DateEditing
				.forFormats(
						createDateFormats(DATE_INPUT_PATTERNS),
						DATE_PARSE_ERROR_MESSAGE,
						new SimpleDateFormat(DATE_DISPLAY_PATTERN));
		editing.modelDateConstraints().requiredMessage(REQUIRED_MESSAGE);
		return editing;
	}

	private static DateFormat[] createDateFormats(String[] datePatterns) {
		DateFormat[] dateFormats = new DateFormat[datePatterns.length];
		for (int i = 0; i < dateFormats.length; i++) {
			dateFormats[i] = new SimpleDateFormat(datePatterns[i]);
		}
		return dateFormats;
	}

	private static String createDateParseErrorMessage(String[] datePatterns) {
		StringBuffer messageSb = new StringBuffer();
		messageSb.append("Supported formats: ");
		for (int i = 0; i < datePatterns.length; i++) {
			if (i > 0) {
				messageSb.append(", ");
			}
			messageSb.append(datePatterns[i]);
		}
		return messageSb.toString();
	}
}




/*******************************************************************************
 * Copyright (c) 2009 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 ******************************************************************************/

package org.eclipse.jface.examples.databinding.util;

import org.eclipse.core.databinding.editing.Editing;
import org.eclipse.core.databinding.observable.map.IObservableMap;
import org.eclipse.core.databinding.util.Policy;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.MultiStatus;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.viewers.CellEditor;
import org.eclipse.jface.viewers.ColumnViewer;
import org.eclipse.jface.viewers.EditingSupport;
import org.eclipse.jface.viewers.TextCellEditor;
import org.eclipse.swt.widgets.Composite;

/**
 * @since 3.2
 */
public class ObservableMapEditingSupport extends EditingSupport {

	private final IObservableMap attributeMap;

	private final Editing editing;

	private final CellEditor cellEditor;

	public ObservableMapEditingSupport(ColumnViewer viewer, IObservableMap attributeMap, Editing editing) {
		super(viewer);
		this.attributeMap = attributeMap;
		this.editing = editing;
		this.cellEditor = new TextCellEditor((Composite) getViewer().getControl());
	}

	protected boolean canEdit(Object element) {
		return true;
	}

	protected CellEditor getCellEditor(Object element) {
		return cellEditor;
	}

	protected Object getValue(Object element) {
		return editing.convertToTarget(attributeMap.get(element));
	}

	protected void setValue(Object element, Object value) {
		MultiStatus validationStatus = new MultiStatus(Policy.JFACE_DATABINDING, 0, null, null);
		Object modelValue = editing.convertToModel(value, validationStatus);
		if (handleValidation(validationStatus)) {
			attributeMap.put(element, modelValue);
		}
	}

	private boolean handleValidation(IStatus validationStatus) {
		if (validationStatus.matches(IStatus.ERROR | IStatus.CANCEL)) {
			MessageDialog.openError(getViewer().getControl().getShell(), "Validation Error", getValidationMessage(validationStatus));
			return false;
		}
		return true;
	}

	private static String getValidationMessage(IStatus validationStatus) {
		if (!validationStatus.isMultiStatus()) {
			return validationStatus.getMessage();
		}

		MultiStatus multiStatus = (MultiStatus) validationStatus;
		StringBuffer sb = new StringBuffer();
		IStatus[] childStatus = multiStatus.getChildren();
		for (int i = 0; i < childStatus.length; i++) {
			if (i > 0) {
				sb.append('\n');
			}
			sb.append(getValidationMessage(childStatus[i]));
		}
		return sb.toString();
	}
}




/*******************************************************************************
 * Copyright (c) 2006, 2009 Ovidio Mallo and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Ovidio Mallo - initial API and implementation (bug 183055)
 ******************************************************************************/

package org.eclipse.jface.examples.databinding.snippets;

import java.util.Date;

import org.eclipse.core.databinding.Binding;
import org.eclipse.core.databinding.DataBindingContext;
import org.eclipse.core.databinding.beans.BeansObservables;
import org.eclipse.core.databinding.editing.DateEditing;
import org.eclipse.core.databinding.editing.Editing;
import org.eclipse.core.databinding.editing.IntegerEditing;
import org.eclipse.core.databinding.editing.StringEditing;
import org.eclipse.core.databinding.observable.Realm;
import org.eclipse.core.databinding.observable.list.WritableList;
import org.eclipse.core.databinding.observable.map.IObservableMap;
import org.eclipse.core.databinding.observable.set.IObservableSet;
import org.eclipse.core.databinding.observable.value.IObservableValue;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.jface.databinding.swt.ISWTObservableValue;
import org.eclipse.jface.databinding.swt.SWTObservables;
import org.eclipse.jface.databinding.viewers.ObservableListContentProvider;
import org.eclipse.jface.databinding.viewers.ViewersObservables;
import org.eclipse.jface.examples.databinding.ModelObject;
import org.eclipse.jface.examples.databinding.util.EditingFactory;
import org.eclipse.jface.examples.databinding.util.ObservableMapEditingCellLabelProvider;
import org.eclipse.jface.examples.databinding.util.ObservableMapEditingSupport;
import org.eclipse.jface.internal.databinding.provisional.fieldassist.ControlDecorationSupport;
import org.eclipse.jface.layout.GridDataFactory;
import org.eclipse.jface.layout.GridLayoutFactory;
import org.eclipse.jface.viewers.StructuredSelection;
import org.eclipse.jface.viewers.TableViewer;
import org.eclipse.jface.viewers.TableViewerColumn;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.FocusAdapter;
import org.eclipse.swt.events.FocusEvent;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Group;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Text;

public class Snippet036EditingTable {

	private final StringEditing nameEditing = EditingFactory.forString().required();

	private final IntegerEditing ageEditing = EditingFactory.forInteger().required().nonNegative();

	private final DateEditing bdayEditing = EditingFactory.forDate().before(new Date());

	private DataBindingContext dbc;

	private TableViewer tableViewer;

	public static void main(String[] args) {
		Display display = new Display();

		Realm.runWithDefault(SWTObservables.getRealm(display), new Runnable() {
			public void run() {
				Shell shell = new Snippet036EditingTable().createShell();
				Display display = Display.getCurrent();
				while (!shell.isDisposed()) {
					if (!display.readAndDispatch()) {
						display.sleep();
					}
				}
			}
		});
	}

	private Shell createShell() {
		Display display = Display.getCurrent();
		Shell shell = new Shell(display);
		shell.setText("Editing");
		shell.setLayout(new GridLayout(2, false));

		dbc = new DataBindingContext();

		createTableSection(shell);
		createFieldSection(shell);

		shell.pack();
		shell.open();

		return shell;
	}

	private void createTableSection(Composite parent) {
		Group section = createSectionGroup(parent, 1);

		tableViewer = new TableViewer(section, SWT.SINGLE | SWT.H_SCROLL | SWT.V_SCROLL | SWT.BORDER | SWT.FULL_SELECTION);
		GridDataFactory.fillDefaults().grab(true, true).hint(350, 250).applyTo(tableViewer.getTable());
		tableViewer.getTable().setHeaderVisible(true);
		tableViewer.getTable().setLinesVisible(true);

		ObservableListContentProvider contentProvider = new ObservableListContentProvider();
		tableViewer.setContentProvider(contentProvider);
		IObservableSet contentElements = contentProvider.getKnownElements();

		IObservableMap nameMap = BeansObservables.observeMap(contentElements, "name");
		createColumn("Name*", 150, nameMap, nameEditing);

		IObservableMap ageMap = BeansObservables.observeMap(contentElements, "age");
		createColumn("Age*", 50, ageMap, ageEditing);

		IObservableMap bdayMap = BeansObservables.observeMap(contentElements, "birthday");
		createColumn("Birthday", 80, bdayMap, bdayEditing);

		WritableList people = new WritableList();
		people.add(new Person("John Doe", 27));
		people.add(new Person("Steve Northover", 33));
		people.add(new Person("Grant Gayed", 54));
		people.add(new Person("Veronika Irvine", 25));
		people.add(new Person("Mike Wilson", 44));
		people.add(new Person("Christophe Cornu", 37));
		people.add(new Person("Lynne Kues", 65));
		people.add(new Person("Silenio Quarti", 15));

		tableViewer.setInput(people);

		tableViewer.setSelection(new StructuredSelection(people.get(0)));
	}

	private TableViewerColumn createColumn(String text, int width, IObservableMap attributeMap, Editing modelEditing) {
		TableViewerColumn column = new TableViewerColumn(tableViewer, SWT.NONE);
		column.getColumn().setText(text);
		column.getColumn().setWidth(width);
		column.setLabelProvider(new ObservableMapEditingCellLabelProvider(attributeMap, modelEditing));
		column.setEditingSupport(new ObservableMapEditingSupport(tableViewer, attributeMap, modelEditing));
		return column;
	}

	private void createFieldSection(Composite parent) {
		final Group section = createSectionGroup(parent, 2);

		final IObservableValue personObservable = ViewersObservables.observeSingleSelection(tableViewer);

		Text nameText = createTextField(section, "Name*");
		IObservableValue nameObservable = BeansObservables.observeDetailValue(personObservable, "name", null);
		bindTextField(nameText, nameObservable, nameEditing);

		Text ageText = createTextField(section, "Age*");
		IObservableValue ageObservable = BeansObservables.observeDetailValue(personObservable, "age", null);
		bindTextField(ageText, ageObservable, ageEditing);

		Text bdayText = createTextField(section, "Birthday");
		IObservableValue bdayObservable = BeansObservables.observeDetailValue(personObservable, "birthday", null);
		bindTextField(bdayText, bdayObservable, bdayEditing);
	}

	private Binding bindTextField(
			Text text,
			IObservableValue modelValue,
			Editing editing) {
		// Create the binding using the editing object.
		ISWTObservableValue textObservable = SWTObservables.observeText(text, SWT.Modify);
		Binding binding = editing.bindValue(dbc, textObservable, modelValue);

		// Decorate the control with the validation status.
		ControlDecorationSupport.create(binding, SWT.TOP);

		formatOnFocusOut(text, binding);

		return binding;
	}

	private static void formatOnFocusOut(final Control control, final Binding binding) {
		control.addFocusListener(new FocusAdapter() {
			public void focusLost(FocusEvent e) {
				IStatus dateValidationStatus = (IStatus) binding.getValidationStatus().getValue();
				if (dateValidationStatus.isOK()) {
					binding.updateModelToTarget();
				}
			}
		});
	}

	private Group createSectionGroup(Composite parent, int numColumns) {
		Group section = new Group(parent, SWT.SHADOW_ETCHED_IN);
		GridLayoutFactory.fillDefaults().numColumns(numColumns).equalWidth(false).margins(5, 5).spacing(15, 5).applyTo(section);
		GridDataFactory.fillDefaults().grab(true, true).applyTo(section);
		return section;
	}

	private static Text createTextField(Composite parent, String labelText) {
		Label label = new Label(parent, SWT.LEFT);
		label.setText(labelText);
		GridDataFactory.fillDefaults().align(SWT.LEFT, SWT.CENTER).applyTo(label);

		Text text = new Text(parent, SWT.BORDER);
		GridDataFactory.fillDefaults().grab(true, false).hint(200, SWT.DEFAULT).applyTo(text);

		return text;
	}

	public static final class Person extends ModelObject {

		private String name;

		private int age;

		private Date birthday;

		public Person(String name, int age) {
			this.name = name;
			this.age = age;
		}

		public String getName() {
			return name;
		}

		public void setName(String name) {
			firePropertyChange("name", this.name, this.name = name);
		}

		public int getAge() {
			return age;
		}

		public void setAge(int age) {
			firePropertyChange("age", this.age, this.age = age);
		}

		public Date getBirthday() {
			return birthday;
		}

		public void setBirthday(Date birthday) {
			firePropertyChange("birthday", this.birthday, this.birthday = birthday);
		}
	}
}




/*******************************************************************************
 * Copyright (c) 2009 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 ******************************************************************************/

package org.eclipse.jface.examples.databinding.util;

import java.math.BigInteger;
import java.text.FieldPosition;
import java.text.ParsePosition;

import com.ibm.icu.math.BigDecimal;
import com.ibm.icu.text.NumberFormat;

/**
 * @since 3.2
 *
 */
public class RadixNumberFormat extends NumberFormat {

	private static final long serialVersionUID = 411884077848863891L;

	private final int radix;

	private final String prefix;

	private final int digits;

	private RadixNumberFormat(int radix, String prefix, int digits) {
		this.radix = radix;
		this.prefix = prefix != null ? prefix : "";
		this.digits = digits;
	}

	public static RadixNumberFormat getHexInstance() {
		return getHexInstance(null, 0);
	}

	public static RadixNumberFormat getHexInstance(String prefix, int digits) {
		return new RadixNumberFormat(16, prefix, digits);
	}

	public StringBuffer format(double number, StringBuffer toAppendTo,
			FieldPosition pos) {
		// TODO omallo: Is this necessary due to a bug in NumberFormat.format(Object, ...)?
		return format((long) number, toAppendTo, pos);
	}

	public StringBuffer format(long number, StringBuffer toAppendTo,
			FieldPosition pos) {
		return toAppendTo.append(prefix).append(addPadding(Long.toString(number, radix)));
	}

	public StringBuffer format(BigInteger number, StringBuffer toAppendTo,
			FieldPosition pos) {
		return toAppendTo.append(prefix).append(addPadding(number.toString(radix)));
	}

	public StringBuffer format(BigDecimal number, StringBuffer toAppendTo,
			FieldPosition pos) {
		throw new UnsupportedOperationException();
	}

	public Number parse(String text, ParsePosition parsePosition) {
		if (text.length() == 0) {
			return null;
		}

		parsePosition.setIndex(parsePosition.getIndex() + text.length());

		try {
			if (text.startsWith(prefix)) {
				return Integer.parseInt(text.substring(prefix.length()), radix);
			}
			return Integer.parseInt(text, radix);
		} catch (NumberFormatException e) {
			parsePosition.setErrorIndex(0);
			return null;
		}
	}

	private String addPadding(String numberText) {
		if (numberText.length() >= digits) {
			return numberText;
		}

		StringBuffer sb = new StringBuffer();
		for (int i = numberText.length(); i < digits; i++) {
			sb.append('0');
		}
		sb.append(numberText);
		return sb.toString();
	}
}




/*******************************************************************************
 * Copyright (c) 2009 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 ******************************************************************************/

package org.eclipse.jface.examples.databinding.util;

import org.eclipse.core.databinding.editing.Editing;
import org.eclipse.core.databinding.observable.map.IObservableMap;
import org.eclipse.jface.databinding.viewers.ObservableMapCellLabelProvider;
import org.eclipse.jface.viewers.ViewerCell;

/**
 * @since 3.2
 */
public class ObservableMapEditingCellLabelProvider extends
		ObservableMapCellLabelProvider {

	private final IObservableMap attributeMap;

	private final Editing editing;

	public ObservableMapEditingCellLabelProvider(IObservableMap attributeMap, Editing editing) {
		super(attributeMap);
		this.attributeMap = attributeMap;
		this.editing = editing;
	}

	public void update(ViewerCell cell) {
		Object element = cell.getElement();
		Object attribute = attributeMap.get(element);
		cell.setText((String) editing.convertToTarget(attribute));
	}
}




public class BindingMessagesTest extends TestCase {
	public void testFormatString() throws Exception {
		String key = "Validate_NumberOutOfRangeError";
		String result = BindingMessages.getFormattedString(key, new Object[] {"1", "2"});
		assertFalse("key should not be returned", key.equals(result));
	}
	
	public void testFormatStringForKeyNotFound() throws Exception {
		String key = "key_that_does_not_exist";
		String result = BindingMessages.getFormattedString(key, null);
		assertTrue(key.equals(result));
	}
}

Return to bug 183055

Lines 18-24 Link Here

(-)src/org/eclipse/core/internal/databinding/BindingMessages.java (-5 / +16 lines)
18		18
19	/**	19	/**
20	* @since 1.0	20	* @since 1.0
21	*	21	*
22	*/	22	*/
23	public class BindingMessages {	23	public class BindingMessages {
24		24
Lines 112-118 Link Here
112	* Returns the resource object with the given key in the resource bundle for	112	* Returns the resource object with the given key in the resource bundle for
113	* JFace Data Binding. If there isn't any value under the given key, the key	113	* JFace Data Binding. If there isn't any value under the given key, the key
114	* is returned.	114	* is returned.
115	*	115	*
116	* @param key	116	* @param key
117	* the resource name	117	* the resource name
118	* @return the string	118	* @return the string
Lines 128-143 Link Here
128	/**	128	/**
129	* Returns a formatted string with the given key in the resource bundle for	129	* Returns a formatted string with the given key in the resource bundle for
130	* JFace Data Binding.	130	* JFace Data Binding.
131	*	131	*
132	* @param key	132	* @param key
133	* @param arguments	133	* @param arguments
134	* @return formatted string, the key if the key is invalid	134	* @return formatted string, the key if the key is invalid
135	*/	135	*/
136	public static String formatString(String key, Object[] arguments) {	136	public static String getFormattedString(String key, Object[] arguments) {
137	try {	137	try {
138	return MessageFormat.format(bundle.getString(key), arguments);	138	return formatMessage(getString(key), arguments);
139	} catch (MissingResourceException e) {	139	} catch (MissingResourceException e) {
140	return key;	140	return key;
141	}	141	}
142	}	142	}
		143
		144	/**
		145	* Formats the given message pattern with the provided arguments.
		146	*
		147	* @param pattern
		148	* @param arguments
		149	* @return formatted string
		150	*/
		151	public static String formatMessage(String pattern, Object[] arguments) {
		152	return MessageFormat.format(pattern, arguments);
		153	}
143	}	154	}

Lines 15-27 Link Here

(-)src/org/eclipse/core/internal/databinding/conversion/StringToDateConverter.java (-2 / +20 lines)
15		15
16	import org.eclipse.core.databinding.conversion.IConverter;	16	import org.eclipse.core.databinding.conversion.IConverter;
17		17
		18	import com.ibm.icu.text.DateFormat;
18		19
19	/**	20	/**
20	* Convert a String to a java.util.Date, respecting the current locale	21	* Convert a String to a java.util.Date, respecting the current locale
21	*	22	*
22	* @since 1.0	23	* @since 1.0
23	*/	24	*/
24	public class StringToDateConverter extends DateConversionSupport implements IConverter {	25	public class StringToDateConverter extends DateConversionSupport implements
		26	IConverter {
		27
		28	/**
		29	*
		30	*/
		31	public StringToDateConverter() {
		32	super();
		33	}
		34
		35	/**
		36	*
		37	* @param formats
		38	*/
		39	public StringToDateConverter(DateFormat[] formats) {
		40	super(formats);
		41	}
		42
25	public Object convert(Object source) {	43	public Object convert(Object source) {
26	return parse(source.toString());	44	return parse(source.toString());
27	}	45	}
Lines 32-36 Link Here
32		50
33	public Object getToType() {	51	public Object getToType() {
34	return Date.class;	52	return Date.class;
35	}	53	}
36	}	54	}

Lines 31-88 Link Here

(-)src/org/eclipse/core/internal/databinding/conversion/DateConversionSupport.java (-35 / +51 lines)
31	* </p>	31	* </p>
32	*/	32	*/
33	public abstract class DateConversionSupport {	33	public abstract class DateConversionSupport {
34	private final static int DATE_FORMAT=DateFormat.SHORT;	34	private final static int DATE_FORMAT = DateFormat.SHORT;
35	private final static int DEFAULT_FORMATTER_INDEX=0;	35	private final static int DEFAULT_FORMATTER_INDEX = 0;
36		36
37	private final static int NUM_VIRTUAL_FORMATTERS=1;	37	private final static int NUM_VIRTUAL_FORMATTERS = 1;
38		38
39	/**	39	/**
40	* Alternative formatters for date, time and date/time.	40	* Alternative formatters for date, time and date/time. Raw milliseconds are
41	* Raw milliseconds are covered as a special case.	41	* covered as a special case.
42	*/	42	*/
43	// TODO: These could be shared, but would have to be synchronized.	43	private final DateFormat[] formatters;
44	private DateFormat[] formatters = {	44
45	new SimpleDateFormat(BindingMessages.getString(BindingMessages.DATE_FORMAT_DATE_TIME)),	45	/**
46	new SimpleDateFormat(BindingMessages.getString(BindingMessages.DATEFORMAT_TIME)),	46	*
47	DateFormat.getDateTimeInstance(DATE_FORMAT, DateFormat.SHORT),	47	*/
48	DateFormat.getDateInstance(DATE_FORMAT),	48	public DateConversionSupport() {
49	DateFormat.getTimeInstance(DateFormat.SHORT),	49	// TODO: These could be shared, but would have to be synchronized.
50	DateFormat.getDateTimeInstance(DATE_FORMAT,DateFormat.MEDIUM),	50	this(new DateFormat[] {
51	DateFormat.getTimeInstance(DateFormat.MEDIUM)	51	new SimpleDateFormat(BindingMessages
52	};	52	.getString(BindingMessages.DATE_FORMAT_DATE_TIME)),
		53	new SimpleDateFormat(BindingMessages
		54	.getString(BindingMessages.DATEFORMAT_TIME)),
		55	DateFormat.getDateTimeInstance(DATE_FORMAT, DateFormat.SHORT),
		56	DateFormat.getDateInstance(DATE_FORMAT),
		57	DateFormat.getTimeInstance(DateFormat.SHORT),
		58	DateFormat.getDateTimeInstance(DATE_FORMAT, DateFormat.MEDIUM),
		59	DateFormat.getTimeInstance(DateFormat.MEDIUM) });
		60	}
		61
		62	/**
		63	*
		64	* @param formats
		65	*/
		66	public DateConversionSupport(DateFormat[] formats) {
		67	this.formatters = formats;
		68	}
53		69
54	/**	70	/**
55	* Tries all available formatters to parse the given string according to the	71	* Tries all available formatters to parse the given string according to the
56	* default locale or as a raw millisecond value and returns the result of the	72	* default locale or as a raw millisecond value and returns the result of the
57	* first successful run.	73	* first successful run.
58	*	74	*
59	* @param str A string specifying a date according to the default locale or in raw milliseconds	75	* @param str A string specifying a date according to the default locale or in raw milliseconds
60	* @return The parsed date, or null, if no available formatter could interpret the input string	76	* @return The parsed date, or null, if no available formatter could interpret the input string
61	*/	77	*/
62	protected Date parse(String str) {	78	protected Date parse(String str) {
63	for (int formatterIdx = 0; formatterIdx < formatters.length; formatterIdx++) {	79	for (int formatterIdx = 0; formatterIdx < formatters.length; formatterIdx++) {
64	Date parsed=parse(str,formatterIdx);	80	Date parsed = parse(str, formatterIdx);
65	if(parsed!=null) {	81	if (parsed != null) {
66	return parsed;	82	return parsed;
67	}	83	}
68	}	84	}
69	return null;	85	return null;
70	}	86	}
71		87
72	protected Date parse(String str,int formatterIdx) {	88	protected Date parse(String str, int formatterIdx) {
73	if(formatterIdx>=0) {	89	if (formatterIdx >= 0) {
74	ParsePosition pos=new ParsePosition(0);	90	ParsePosition pos = new ParsePosition(0);
75	if (str == null) {	91	if (str == null) {
76	return null;	92	return null;
77	}	93	}
78	Date date=formatters[formatterIdx].parse(str,pos);	94	Date date = formatters[formatterIdx].parse(str, pos);
79	if(pos.getErrorIndex()!=-1\|\|pos.getIndex()!=str.length()) {	95	if (pos.getErrorIndex() != -1 \|\| pos.getIndex() != str.length()) {
80	return null;	96	return null;
81	}	97	}
82	return date;	98	return date;
83	}	99	}
84	try {	100	try {
85	long millisecs=Long.parseLong(str);	101	long millisecs = Long.parseLong(str);
86	return new Date(millisecs);	102	return new Date(millisecs);
87	}	103	}
88	catch(NumberFormatException exc) {	104	catch(NumberFormatException exc) {
Lines 96-115 Link Here
96	* @return a string representation of the given date according to the default locale	112	* @return a string representation of the given date according to the default locale
97	*/	113	*/
98	protected String format(Date date) {	114	protected String format(Date date) {
99	return format(date,DEFAULT_FORMATTER_INDEX);	115	return format(date, DEFAULT_FORMATTER_INDEX);
100	}	116	}
101		117
102	protected String format(Date date,int formatterIdx) {	118	protected String format(Date date, int formatterIdx) {
103	if (date == null)	119	if (date == null)
104	return null;	120	return null;
105	if(formatterIdx>=0) {	121	if (formatterIdx >= 0) {
106	return formatters[formatterIdx].format(date);	122	return formatters[formatterIdx].format(date);
107	}	123	}
108	return String.valueOf(date.getTime());	124	return String.valueOf(date.getTime());
109	}	125	}
110		126
111	protected int numFormatters() {	127	protected int numFormatters() {
112	return formatters.length+NUM_VIRTUAL_FORMATTERS;	128	return formatters.length + NUM_VIRTUAL_FORMATTERS;
113	}	129	}
114		130
115	/**	131	/**
Lines 118-124 Link Here
118	* This is for testing purposes only and should not be a part of the API if	134	* This is for testing purposes only and should not be a part of the API if
119	* this class was to be exposed.	135	* this class was to be exposed.
120	* </p>	136	* </p>
121	*	137	*
122	* @param index	138	* @param index
123	* @return date format	139	* @return date format
124	*/	140	*/

Lines 21-27 Link Here

(-)src/org/eclipse/core/internal/databinding/conversion/StringToNumberParser.java (-17 / +33 lines)
21		21
22	/**	22	/**
23	* Utility class for the parsing of strings to numbers.	23	* Utility class for the parsing of strings to numbers.
24	*	24	*
25	* @since 1.0	25	* @since 1.0
26	*/	26	*/
27	public class StringToNumberParser {	27	public class StringToNumberParser {
Lines 73-79 Link Here
73		73
74	/**	74	/**
75	* The result of a parse operation.	75	* The result of a parse operation.
76	*	76	*
77	* @since 1.0	77	* @since 1.0
78	*/	78	*/
79	public static class ParseResult {	79	public static class ParseResult {
Lines 84-90 Link Here
84	* The number as a result of the conversion. <code>null</code> if the	84	* The number as a result of the conversion. <code>null</code> if the
85	* value could not be converted or if the type is not a primitive and	85	* value could not be converted or if the type is not a primitive and
86	* the value was an empty string.	86	* the value was an empty string.
87	*	87	*
88	* @return number	88	* @return number
89	*/	89	*/
90	public Number getNumber() {	90	public Number getNumber() {
Lines 94-100 Link Here
94	/**	94	/**
95	* ParsePosition if an error occurred while parsing. <code>null</code>	95	* ParsePosition if an error occurred while parsing. <code>null</code>
96	* if no error occurred.	96	* if no error occurred.
97	*	97	*
98	* @return parse position	98	* @return parse position
99	*/	99	*/
100	public ParsePosition getPosition() {	100	public ParsePosition getPosition() {
Lines 104-110 Link Here
104		104
105	/**	105	/**
106	* Formats an appropriate message for a parsing error.	106	* Formats an appropriate message for a parsing error.
107	*	107	*
108	* @param value	108	* @param value
109	* @param position	109	* @param position
110	* @return message	110	* @return message
Lines 115-131 Link Here
115	.getErrorIndex() : position.getIndex();	115	.getErrorIndex() : position.getIndex();
116		116
117	if (errorIndex < value.length()) {	117	if (errorIndex < value.length()) {
118	return BindingMessages.formatString(BindingMessages.VALIDATE_NUMBER_PARSE_ERROR,	118	return BindingMessages.getFormattedString(BindingMessages.VALIDATE_NUMBER_PARSE_ERROR,
119	new Object[] { value, new Integer(errorIndex + 1),	119	new Object[] { value, new Integer(errorIndex + 1),
120	new Character(value.charAt(errorIndex)) });	120	new Character(value.charAt(errorIndex)) });
121	}	121	}
122	return BindingMessages.formatString(BindingMessages.VALIDATE_NUMBER_PARSE_ERROR_NO_CHARACTER,	122	return BindingMessages.getFormattedString(BindingMessages.VALIDATE_NUMBER_PARSE_ERROR_NO_CHARACTER,
123	new Object[] { value, new Integer(errorIndex + 1) });	123	new Object[] { value, new Integer(errorIndex + 1) });
124	}	124	}
125		125
126	/**	126	/**
127	* Formats an appropriate message for an out of range error.	127	* Formats an appropriate message for an out of range error.
128	*	128	*
129	* @param minValue	129	* @param minValue
130	* @param maxValue	130	* @param maxValue
131	* @param numberFormat when accessed method synchronizes on instance	131	* @param numberFormat when accessed method synchronizes on instance
Lines 133-138 Link Here
133	*/	133	*/
134	public static String createOutOfRangeMessage(Number minValue,	134	public static String createOutOfRangeMessage(Number minValue,
135	Number maxValue, NumberFormat numberFormat) {	135	Number maxValue, NumberFormat numberFormat) {
		136	return createOutOfRangeMessage(
		137	BindingMessages.getString("Validate_NumberOutOfRangeError"), minValue, maxValue, numberFormat); //$NON-NLS-1$
		138	}
		139
		140	/**
		141	* Formats an appropriate message for an out of range error.
		142	*
		143	* @param message
		144	* @param minValue
		145	* @param maxValue
		146	* @param numberFormat
		147	* when accessed method synchronizes on instance
		148	* @return message
		149	*/
		150	public static String createOutOfRangeMessage(String message,
		151	Number minValue, Number maxValue, NumberFormat numberFormat) {
136	String min = null;	152	String min = null;
137	String max = null;	153	String max = null;
138		154
Lines 141-154 Link Here
141	max = numberFormat.format(maxValue);	157	max = numberFormat.format(maxValue);
142	}	158	}
143		159
144	return BindingMessages.formatString(	160	return BindingMessages.formatMessage(message, new Object[] { min,
145	"Validate_NumberOutOfRangeError", new Object[] { min, max }); //$NON-NLS-1$	161	max });
146	}	162	}
147		163
148	/**	164	/**
149	* Returns <code>true</code> if the provided <code>number</code> is in	165	* Returns <code>true</code> if the provided <code>number</code> is in
150	* the range of a integer.	166	* the range of a integer.
151	*	167	*
152	* @param number	168	* @param number
153	* @return <code>true</code> if a valid integer	169	* @return <code>true</code> if a valid integer
154	* @throws IllegalArgumentException	170	* @throws IllegalArgumentException
Lines 160-166 Link Here
160		176
161	/**	177	/**
162	* Validates the range of the provided <code>number</code>.	178	* Validates the range of the provided <code>number</code>.
163	*	179	*
164	* @param number	180	* @param number
165	* @param bitLength number of bits allowed to be in range	181	* @param bitLength number of bits allowed to be in range
166	* @return <code>true</code> if in range	182	* @return <code>true</code> if in range
Lines 204-210 Link Here
204	/**	220	/**
205	* Returns <code>true</code> if the provided <code>number</code> is in	221	* Returns <code>true</code> if the provided <code>number</code> is in
206	* the range of a long.	222	* the range of a long.
207	*	223	*
208	* @param number	224	* @param number
209	* @return <code>true</code> if in range	225	* @return <code>true</code> if in range
210	* @throws IllegalArgumentException	226	* @throws IllegalArgumentException
Lines 217-223 Link Here
217	/**	233	/**
218	* Returns <code>true</code> if the provided <code>number</code> is in	234	* Returns <code>true</code> if the provided <code>number</code> is in
219	* the range of a float.	235	* the range of a float.
220	*	236	*
221	* @param number	237	* @param number
222	* @return <code>true</code> if in range	238	* @return <code>true</code> if in range
223	* @throws IllegalArgumentException	239	* @throws IllegalArgumentException
Lines 267-273 Link Here
267	/**	283	/**
268	* Returns <code>true</code> if the provided <code>number</code> is in	284	* Returns <code>true</code> if the provided <code>number</code> is in
269	* the range of a double.	285	* the range of a double.
270	*	286	*
271	* @param number	287	* @param number
272	* @return <code>true</code> if in range	288	* @return <code>true</code> if in range
273	* @throws IllegalArgumentException	289	* @throws IllegalArgumentException
Lines 280-286 Link Here
280	/**	296	/**
281	* Returns <code>true</code> if the provided <code>number</code> is in	297	* Returns <code>true</code> if the provided <code>number</code> is in
282	* the range of a short.	298	* the range of a short.
283	*	299	*
284	* @param number	300	* @param number
285	* @return <code>true</code> if in range	301	* @return <code>true</code> if in range
286	*/	302	*/
Lines 291-297 Link Here
291	/**	307	/**
292	* Returns <code>true</code> if the provided <code>number</code> is in	308	* Returns <code>true</code> if the provided <code>number</code> is in
293	* the range of a byte.	309	* the range of a byte.
294	*	310	*
295	* @param number	311	* @param number
296	* @return <code>true</code> if in range	312	* @return <code>true</code> if in range
297	*/	313	*/

Added Link Here

(-)src/org/eclipse/core/internal/databinding/validation/NonEmptyStringValidator.java (+48 lines)
1	/*******************************************************************************
2	* Copyright (c) 2009 Ovidio Mallo and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* Ovidio Mallo - initial API and implementation (bug 183055)
10	******************************************************************************/
11
12	package org.eclipse.core.internal.databinding.validation;
13
14	import org.eclipse.core.databinding.validation.IValidator;
15	import org.eclipse.core.databinding.validation.ValidationStatus;
16	import org.eclipse.core.runtime.IStatus;
17
18	/**
19	* @since 1.3
20	*/
21	public class NonEmptyStringValidator implements IValidator {
22
23	private final String validationMessage;
24
25	/**
26	*
27	*/
28	public NonEmptyStringValidator() {
29	this(null);
30	}
31
32	/**
33	* @param validationMessage
34	*/
35	public NonEmptyStringValidator(String validationMessage) {
36	// TODO: Externalize
37	this.validationMessage = validationMessage != null ? validationMessage
38	: "The string must not be empty."; //$NON-NLS-1$
39	}
40
41	public IStatus validate(Object value) {
42	String input = (String) value;
43	if ("".equals(input)) { //$NON-NLS-1$
44	return ValidationStatus.error(validationMessage);
45	}
46	return ValidationStatus.ok();
47	}
48	}

Added Link Here

(-)src/org/eclipse/core/databinding/editing/StringEditing.java (+213 lines)
1	/*******************************************************************************
2	* Copyright (c) 2009 Ovidio Mallo and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* Ovidio Mallo - initial API and implementation (bug 183055)
10	******************************************************************************/
11
12	package org.eclipse.core.databinding.editing;
13
14	import org.eclipse.core.databinding.conversion.IConverter;
15	import org.eclipse.core.databinding.validation.constraint.Constraints;
16	import org.eclipse.core.databinding.validation.constraint.StringConstraints;
17	import org.eclipse.core.internal.databinding.conversion.StringStripConverter;
18
19	/**
20	* @since 1.3
21	*/
22	public final class StringEditing extends Editing {
23
24	private StringEditing(IConverter targetConverter) {
25	setTargetConverter(targetConverter);
26	}
27
28	/**
29	* Creates a new editing object for strings which performs no validation or
30	* conversion.
31	*
32	* @return The new editing object which performs no validation or
33	* conversion.
34	*/
35	public static StringEditing withDefaults() {
36	return new StringEditing(null);
37	}
38
39	/**
40	* Creates a new editing object which strips whitespace from both ends of
41	* the input string.
42	*
43	* @param stripToNull
44	* Whether to convert the input string to <code>null</code> in
45	* case stripping the input string results in an empty string.
46	* @return The new editing object which strips whitespace from both ends of
47	* the input string.
48	*/
49	public static StringEditing stripped(boolean stripToNull) {
50	return new StringEditing(new StringStripConverter(stripToNull));
51	}
52
53	/**
54	* Returns the target constraints to apply.
55	*
56	* <p>
57	* This method provides a typesafe access to the {@link StringConstraints
58	* string target constraints} of this editing object and is equivalent to
59	* {@code (StringConstraints) targetConstraints()}.
60	* </p>
61	*
62	* @return The target constraints to apply.
63	*
64	* @see #targetConstraints()
65	* @see StringConstraints
66	*/
67	public StringConstraints targetStringConstraints() {
68	return (StringConstraints) targetConstraints();
69	}
70
71	/**
72	* Returns the model constraints to apply.
73	*
74	* <p>
75	* This method provides a typesafe access to the {@link StringConstraints
76	* string model constraints} of this editing object and is equivalent to
77	* {@code (StringConstraints) modelConstraints()}.
78	* </p>
79	*
80	* @return The target constraints to apply.
81	*
82	* @see #modelConstraints()
83	* @see StringConstraints
84	*/
85	public StringConstraints modelStringConstraints() {
86	return (StringConstraints) modelConstraints();
87	}
88
89	/**
90	* Returns the before-set model constraints to apply.
91	*
92	* <p>
93	* This method provides a typesafe access to the {@link StringConstraints
94	* string before-set model constraints} of this editing object and is
95	* equivalent to {@code (StringConstraints) beforeSetModelConstraints()}.
96	* </p>
97	*
98	* @return The target constraints to apply.
99	*
100	* @see #beforeSetModelConstraints()
101	* @see StringConstraints
102	*/
103	public StringConstraints beforeSetModelStringConstraints() {
104	return (StringConstraints) beforeSetModelConstraints();
105	}
106
107	protected Constraints createTargetConstraints() {
108	return new StringConstraints();
109	}
110
111	protected Constraints createModelConstraints() {
112	return new StringConstraints();
113	}
114
115	protected Constraints createBeforeSetModelConstraints() {
116	return new StringConstraints();
117	}
118
119	/**
120	* Convenience method which adds a {@link StringConstraints#required()
121	* required constraint} to the set of {@link #modelStringConstraints()}.
122	*
123	* @return This editing instance for method chaining.
124	*
125	* @see StringConstraints#required()
126	* @see #modelStringConstraints()
127	*/
128	public StringEditing required() {
129	modelStringConstraints().required();
130	return this;
131	}
132
133	/**
134	* Convenience method which adds a {@link StringConstraints#nonEmpty()
135	* non-empty constraint} to the set of {@link #modelStringConstraints()}.
136	*
137	* @return This editing instance for method chaining.
138	*
139	* @see StringConstraints#nonEmpty()
140	* @see #modelStringConstraints()
141	*/
142	public StringEditing nonEmpty() {
143	modelStringConstraints().nonEmpty();
144	return this;
145	}
146
147	/**
148	* Convenience method which adds a {@link StringConstraints#minLength(int)
149	* min-length constraint} to the set of {@link #modelStringConstraints()}.
150	*
151	* @param minLength
152	* The min length of the min-length constraint.
153	* @return This editing instance for method chaining.
154	*
155	* @see StringConstraints#minLength(int)
156	* @see #modelStringConstraints()
157	*/
158	public StringEditing minLength(int minLength) {
159	modelStringConstraints().minLength(minLength);
160	return this;
161	}
162
163	/**
164	* Convenience method which adds a {@link StringConstraints#maxLength(int)
165	* max-length constraint} to the set of {@link #modelStringConstraints()}.
166	*
167	* @param maxLength
168	* The max length of the max-length constraint.
169	* @return This editing instance for method chaining.
170	*
171	* @see StringConstraints#maxLength(int)
172	* @see #modelStringConstraints()
173	*/
174	public StringEditing maxLength(int maxLength) {
175	modelStringConstraints().maxLength(maxLength);
176	return this;
177	}
178
179	/**
180	* Convenience method which adds a
181	* {@link StringConstraints#lengthRange(int, int) length-range constraint}
182	* to the set of {@link #modelStringConstraints()}.
183	*
184	* @param minLength
185	* The min length of the length-range constraint.
186	* @param maxLength
187	* The max length of the length-range constraint.
188	* @return This editing instance for method chaining.
189	*
190	* @see StringConstraints#lengthRange(int, int)
191	* @see #modelStringConstraints()
192	*/
193	public StringEditing lengthRange(int minLength, int maxLength) {
194	modelStringConstraints().lengthRange(minLength, maxLength);
195	return this;
196	}
197
198	/**
199	* Convenience method which adds a {@link StringConstraints#matches(String)
200	* matches constraint} to the set of {@link #modelStringConstraints()}.
201	*
202	* @param regex
203	* The regular expression of the matches constraint.
204	* @return This editing instance for method chaining.
205	*
206	* @see StringConstraints#matches(String)
207	* @see #modelStringConstraints()
208	*/
209	public StringEditing matches(String regex) {
210	modelStringConstraints().matches(regex);
211	return this;
212	}
213	}

Added Link Here

(-)src/org/eclipse/core/databinding/validation/constraint/Constraints.java (+180 lines)
1	/*******************************************************************************
2	* Copyright (c) 2009 Ovidio Mallo and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* Ovidio Mallo - initial API and implementation (bug 183055)
10	******************************************************************************/
11
12	package org.eclipse.core.databinding.validation.constraint;
13
14	import java.util.ArrayList;
15	import java.util.Iterator;
16	import java.util.List;
17
18	import org.eclipse.core.databinding.util.Policy;
19	import org.eclipse.core.databinding.validation.IValidator;
20	import org.eclipse.core.internal.databinding.BindingMessages;
21	import org.eclipse.core.runtime.IStatus;
22	import org.eclipse.core.runtime.MultiStatus;
23	import org.eclipse.core.runtime.Status;
24
25	/**
26	* @since 1.3
27	*/
28	public class Constraints {
29
30	/**
31	* Constant denoting an aggregation strategy that merges multiple non-OK
32	* status objects in a {@link MultiStatus}. Returns an OK status result if
33	* all statuses from the set of validators to apply are an OK status.
34	* Returns a single status if there is only one non-OK status.
35	*
36	* @see #aggregationPolicy(int)
37	*/
38	public static final int AGGREGATION_MERGED = 1;
39
40	/**
41	* Constant denoting an aggregation strategy that always returns the most
42	* severe status from the set of validators to apply. If there is more than
43	* one status at the same severity level, it picks the first one it
44	* encounters.
45	*
46	* @see #aggregationPolicy(int)
47	*/
48	public static final int AGGREGATION_MAX_SEVERITY = 2;
49
50	// Will be initialized lazily.
51	private List validators = null;
52
53	private IValidator cachedValidator = null;
54
55	private int aggregationPolicy = AGGREGATION_MAX_SEVERITY;
56
57	/**
58	* Adds a custom validator to the set of constraints to apply.
59	*
60	* @param validator
61	* The custom validator to add to the set of constraints.
62	* @return This constraints instance for method chaining.
63	*/
64	public final Constraints addValidator(IValidator validator) {
65	if (validators == null) {
66	validators = new ArrayList(2);
67	}
68	validators.add(validator);
69	cachedValidator = null;
70	return this;
71	}
72
73	/**
74	* Sets the aggregation policy to apply to the individual validations which
75	* constitute this set of constraints.
76	*
77	* @param policy
78	* The validation aggregation policy to set. Must be one of
79	* {@link #AGGREGATION_MERGED} or
80	* {@link #AGGREGATION_MAX_SEVERITY}.
81	* @return This constraints instance for method chaining.
82	*
83	* @see #AGGREGATION_MERGED
84	* @see #AGGREGATION_MAX_SEVERITY
85	*/
86	public final Constraints aggregationPolicy(int policy) {
87	this.aggregationPolicy = policy;
88	cachedValidator = null;
89	return this;
90	}
91
92	/**
93	* Creates a validator which enforces the current set of constraints.
94	*
95	* <p>
96	* Note that this method will return <code>null</code> in case the set of
97	* constraints to apply is empty.
98	* </p>
99	*
100	* @return A validator which enforces the current set of constraints. May be
101	* <code>null</code>.
102	*/
103	public final IValidator createValidator() {
104	if (validators != null && !validators.isEmpty()) {
105	if (cachedValidator == null) {
106	if (validators.size() == 1) {
107	cachedValidator = (IValidator) validators.get(0);
108	} else {
109	IValidator[] currentValidators = (IValidator[]) validators
110	.toArray(new IValidator[validators.size()]);
111	cachedValidator = new ConstraintsValidator(
112	currentValidators, aggregationPolicy);
113	}
114	}
115	return cachedValidator;
116	}
117	return null;
118	}
119
120	private static final class ConstraintsValidator implements IValidator {
121
122	private final IValidator[] validators;
123
124	private final int aggregationPolicy;
125
126	public ConstraintsValidator(IValidator[] validators,
127	int aggregationPolicy) {
128	this.validators = validators;
129	this.aggregationPolicy = aggregationPolicy;
130	}
131
132	public IStatus validate(Object value) {
133	return (aggregationPolicy == AGGREGATION_MERGED) ? validateMerged(value)
134	: validateMaxSeverity(value);
135	}
136
137	private IStatus validateMerged(Object value) {
138	List statuses = new ArrayList();
139	for (int i = 0; i < validators.length; i++) {
140	IValidator validator = validators[i];
141	IStatus status = validator.validate(value);
142	if (!status.isOK()) {
143	statuses.add(status);
144	}
145	}
146
147	if (statuses.size() == 1) {
148	return (IStatus) statuses.get(0);
149	}
150
151	if (!statuses.isEmpty()) {
152	MultiStatus result = new MultiStatus(Policy.JFACE_DATABINDING,
153	0, BindingMessages
154	.getString(BindingMessages.MULTIPLE_PROBLEMS),
155	null);
156	for (Iterator it = statuses.iterator(); it.hasNext();) {
157	IStatus status = (IStatus) it.next();
158	result.merge(status);
159	}
160	return result;
161	}
162
163	return Status.OK_STATUS;
164	}
165
166	private IStatus validateMaxSeverity(Object value) {
167	int maxSeverity = IStatus.OK;
168	IStatus maxStatus = Status.OK_STATUS;
169	for (int i = 0; i < validators.length; i++) {
170	IValidator validator = validators[i];
171	IStatus status = validator.validate(value);
172	if (status.getSeverity() > maxSeverity) {
173	maxSeverity = status.getSeverity();
174	maxStatus = status;
175	}
176	}
177	return maxStatus;
178	}
179	}
180	}

Added Link Here

(-)src/org/eclipse/jface/examples/databinding/snippets/Snippet035Editing.java (+215 lines)
1	/*******************************************************************************
2	* Copyright (c) 2006, 2009 Ovidio Mallo and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* Ovidio Mallo - initial API and implementation (bug 183055)
10	******************************************************************************/
11
12	package org.eclipse.jface.examples.databinding.snippets;
13
14	import java.util.Calendar;
15	import java.util.Date;
16
17	import org.eclipse.core.databinding.Binding;
18	import org.eclipse.core.databinding.DataBindingContext;
19	import org.eclipse.core.databinding.editing.DateEditing;
20	import org.eclipse.core.databinding.editing.Editing;
21	import org.eclipse.core.databinding.editing.IntegerEditing;
22	import org.eclipse.core.databinding.observable.Realm;
23	import org.eclipse.core.databinding.observable.list.WritableList;
24	import org.eclipse.core.databinding.observable.value.IObservableValue;
25	import org.eclipse.core.databinding.observable.value.WritableValue;
26	import org.eclipse.core.runtime.IStatus;
27	import org.eclipse.jface.databinding.swt.ISWTObservableValue;
28	import org.eclipse.jface.databinding.swt.SWTObservables;
29	import org.eclipse.jface.databinding.viewers.ObservableListContentProvider;
30	import org.eclipse.jface.examples.databinding.util.EditingFactory;
31	import org.eclipse.jface.internal.databinding.provisional.fieldassist.ControlDecorationSupport;
32	import org.eclipse.jface.layout.GridDataFactory;
33	import org.eclipse.jface.layout.GridLayoutFactory;
34	import org.eclipse.jface.viewers.LabelProvider;
35	import org.eclipse.jface.viewers.ListViewer;
36	import org.eclipse.swt.SWT;
37	import org.eclipse.swt.events.FocusAdapter;
38	import org.eclipse.swt.events.FocusEvent;
39	import org.eclipse.swt.events.SelectionAdapter;
40	import org.eclipse.swt.events.SelectionEvent;
41	import org.eclipse.swt.layout.GridLayout;
42	import org.eclipse.swt.widgets.Composite;
43	import org.eclipse.swt.widgets.Control;
44	import org.eclipse.swt.widgets.Display;
45	import org.eclipse.swt.widgets.Group;
46	import org.eclipse.swt.widgets.Label;
47	import org.eclipse.swt.widgets.Shell;
48	import org.eclipse.swt.widgets.Text;
49
50	public class Snippet035Editing {
51
52	private DataBindingContext dbc;
53
54	public static void main(String[] args) {
55	Display display = new Display();
56
57	Realm.runWithDefault(SWTObservables.getRealm(display), new Runnable() {
58	public void run() {
59	Shell shell = new Snippet035Editing().createShell();
60	Display display = Display.getCurrent();
61	while (!shell.isDisposed()) {
62	if (!display.readAndDispatch()) {
63	display.sleep();
64	}
65	}
66	}
67	});
68	}
69
70	private Shell createShell() {
71	Display display = Display.getCurrent();
72	Shell shell = new Shell(display);
73	shell.setText("Editing");
74	shell.setLayout(new GridLayout(1, false));
75
76	dbc = new DataBindingContext();
77
78	createValueSection(shell);
79	createListSection(shell);
80
81	shell.pack();
82	shell.open();
83
84	return shell;
85	}
86
87	private void createValueSection(Composite parent) {
88	Group section = createSectionGroup(parent, "Value bindings", false);
89
90	// Edit an e-mail address.
91	Text emailText = createTextField(section, "E-Mail*");
92	Editing emailEditing = EditingFactory.forEmailString().required();
93	bindTextField(emailText, new WritableValue(), emailEditing);
94
95	// Edit a required, positive integer and use the default validation message.
96	Text positiveText = createTextField(section, "Positive value*");
97	IntegerEditing positiveEditing = EditingFactory.forInteger().required().positive();
98	bindTextField(positiveText, new WritableValue(), positiveEditing);
99
100	// Edit an integer within the range [1, 100] and use the default
101	// validation message.
102	Text rangeText = createTextField(section, "Value in [1, 100]");
103	IntegerEditing rangeEditing = EditingFactory.forInteger().range(1, 100);
104	bindTextField(rangeText, new WritableValue(new Integer(0), null), rangeEditing);
105
106	// Edit a percentage value which must lie within [0, 100] and use a custom
107	// validation message which indicates that the value actually represents
108	// a percentage value.
109	Text percentText = createTextField(section, "Value [%]");
110	IntegerEditing percentEditing = EditingFactory.forInteger();
111	percentEditing.modelIntegerConstraints().rangeMessage("Please specify a valid percentage value within [{0}, {1}].").range(0, 100);
112	bindTextField(percentText, new WritableValue(new Integer(-1), null), percentEditing);
113
114	// Edit a hex integer within the range [0x00, 0xff]. The range validation
115	// message will display the range boundaries in hex format as well.
116	Text hexText = createTextField(section, "Hex value in [0x00, 0xff]");
117	IntegerEditing hexEditing = EditingFactory.forHexInteger(2).range(0x00, 0xff);
118	bindTextField(hexText, new WritableValue(new Integer(0), null), hexEditing);
119	}
120
121	private void createListSection(Composite parent) {
122	Group section = createSectionGroup(parent, "List bindings", true);
123
124	// Our date should be >= 01.01.1990.
125	Calendar year1990Calendar = Calendar.getInstance();
126	year1990Calendar.clear();
127	year1990Calendar.set(1990, 0, 1);
128	Date year1990 = year1990Calendar.getTime();
129
130	// Edit a date supporting the default input/display patterns.
131	Text dateText = createTextField(section, "Date");
132	DateEditing dateEditing = EditingFactory.forDate().afterEqual(year1990);
133	final WritableValue dateObservable = new WritableValue();
134	final Binding dateBinding = bindTextField(dateText, dateObservable, dateEditing);
135
136	// Create a list to which the dates are added when the user hits ENTER.
137	new Label(section, SWT.LEFT);
138	ListViewer dateListViewer = new ListViewer(section);
139	GridDataFactory.fillDefaults().grab(true, true).hint(150, 200).applyTo(dateListViewer.getList());
140
141	dateListViewer.setContentProvider(new ObservableListContentProvider());
142	dateListViewer.setLabelProvider(new LabelProvider());
143
144	// We use the same DateEditing object as for the text field above to
145	// create a list binding which maps the entered dates to their string
146	// representation which is then set as input on the ListViewer.
147	final WritableList targetDateList = new WritableList();
148	final WritableList modelDateList = new WritableList();
149	dbc.bindList(
150	targetDateList,
151	modelDateList,
152	dateEditing.createT2MListStrategy(),
153	dateEditing.createM2TListStrategy());
154
155	// Set the list containing the string representation of the dates as input.
156	dateListViewer.setInput(targetDateList);
157
158	// Add the current date in the text field when the user hits ENTER.
159	dateText.addSelectionListener(new SelectionAdapter() {
160	public void widgetDefaultSelected(SelectionEvent e) {
161	IStatus dateValidationStatus = (IStatus) dateBinding.getValidationStatus().getValue();
162	Date date = (Date) dateObservable.getValue();
163	if (dateValidationStatus.isOK() && date != null) {
164	modelDateList.add(date);
165	}
166	}
167	});
168	}
169
170	private Binding bindTextField(Text text, IObservableValue modelValue, Editing editing) {
171	// Create the binding using the editing object.
172	ISWTObservableValue textObservable = SWTObservables.observeText(text, SWT.Modify);
173	Binding binding = editing.bindValue(dbc, textObservable, modelValue);
174
175	// Decorate the control with the validation status.
176	ControlDecorationSupport.create(binding, SWT.TOP);
177
178	// Re-format when the text field looses the focus in order to always
179	// display the model in the default format in case multiple input formats
180	// are supported.
181	formatOnFocusOut(text, binding);
182
183	return binding;
184	}
185
186	private static void formatOnFocusOut(final Control control, final Binding binding) {
187	control.addFocusListener(new FocusAdapter() {
188	public void focusLost(FocusEvent e) {
189	IStatus dateValidationStatus = (IStatus) binding.getValidationStatus().getValue();
190	if (dateValidationStatus.isOK()) {
191	binding.updateModelToTarget();
192	}
193	}
194	});
195	}
196
197	private static Group createSectionGroup(Composite parent, String groupText, boolean grabVertical) {
198	Group section = new Group(parent, SWT.SHADOW_ETCHED_IN);
199	section.setText(groupText);
200	GridLayoutFactory.fillDefaults().numColumns(2).equalWidth(false).margins(5, 5).spacing(15, 5).applyTo(section);
201	GridDataFactory.fillDefaults().grab(true, grabVertical).applyTo(section);
202	return section;
203	}
204
205	private static Text createTextField(Composite parent, String labelText) {
206	Label label = new Label(parent, SWT.LEFT);
207	label.setText(labelText);
208	GridDataFactory.fillDefaults().align(SWT.LEFT, SWT.CENTER).applyTo(label);
209
210	Text text = new Text(parent, SWT.BORDER);
211	GridDataFactory.fillDefaults().grab(true, false).hint(150, SWT.DEFAULT).applyTo(text);
212
213	return text;
214	}
215	}

Added Link Here

(-)src/org/eclipse/jface/examples/databinding/util/EditingFactory.java (+117 lines)
1	/*******************************************************************************
2	* Copyright (c) 2009 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM Corporation - initial API and implementation
10	******************************************************************************/
11
12	package org.eclipse.jface.examples.databinding.util;
13
14	import org.eclipse.core.databinding.editing.DateEditing;
15	import org.eclipse.core.databinding.editing.IntegerEditing;
16	import org.eclipse.core.databinding.editing.StringEditing;
17
18	import com.ibm.icu.text.DateFormat;
19	import com.ibm.icu.text.SimpleDateFormat;
20
21	/**
22	* @since 3.2
23	*/
24	public final class EditingFactory {
25
26	private static final String REQUIRED_MESSAGE = "Please specify a value.";
27
28	private static final String INTEGER_PARSE_ERROR_MESSAGE = "The input is invalid.";
29
30	private static final String INTEGER_OUT_OF_RANGE_MESSAGE = "The value lies outside the supported range.";
31
32	private static final String INTEGER_RANGE_MESSAGE = "The value must lie between {0} and {1}.";
33
34	private static final String[] DATE_INPUT_PATTERNS = new String[] {
35	"dd.MM.yy",
36	"dd/MM/yy",
37	"dd.MM.yyyy",
38	"dd/MM/yyyy"
39	};
40
41	private static final String DATE_DISPLAY_PATTERN = "dd.MM.yyyy";
42
43	private static final String DATE_PARSE_ERROR_MESSAGE = createDateParseErrorMessage(DATE_INPUT_PATTERNS);
44
45	private static final String EMAIL_REGEX = "\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,4}\\b";
46
47	private static final String EMAIL_ERROR_MESSAGE = "Please specify a valid e-mail address.";
48
49	private EditingFactory() {
50	// prevent instantiation
51	}
52
53	public static StringEditing forString() {
54	return StringEditing.stripped(true);
55	}
56
57	public static StringEditing forEmailString() {
58	StringEditing editing = StringEditing.stripped(true);
59	editing.modelStringConstraints()
60	.matchesMessage(EMAIL_ERROR_MESSAGE)
61	.matches(EMAIL_REGEX);
62	return editing;
63	}
64
65	public static IntegerEditing forInteger() {
66	IntegerEditing editing = IntegerEditing.withDefaults(
67	INTEGER_PARSE_ERROR_MESSAGE,
68	INTEGER_OUT_OF_RANGE_MESSAGE);
69	configure(editing);
70	return editing;
71	}
72
73	public static IntegerEditing forHexInteger(int digits) {
74	IntegerEditing editing = IntegerEditing.forFormat(
75	RadixNumberFormat.getHexInstance("0x", digits),
76	INTEGER_PARSE_ERROR_MESSAGE,
77	INTEGER_OUT_OF_RANGE_MESSAGE);
78	configure(editing);
79	return editing;
80	}
81
82	private static void configure(IntegerEditing editing) {
83	editing.modelIntegerConstraints()
84	.requiredMessage(REQUIRED_MESSAGE)
85	.rangeMessage(INTEGER_RANGE_MESSAGE);
86	}
87
88	public static DateEditing forDate() {
89	DateEditing editing = DateEditing
90	.forFormats(
91	createDateFormats(DATE_INPUT_PATTERNS),
92	DATE_PARSE_ERROR_MESSAGE,
93	new SimpleDateFormat(DATE_DISPLAY_PATTERN));
94	editing.modelDateConstraints().requiredMessage(REQUIRED_MESSAGE);
95	return editing;
96	}
97
98	private static DateFormat[] createDateFormats(String[] datePatterns) {
99	DateFormat[] dateFormats = new DateFormat[datePatterns.length];
100	for (int i = 0; i < dateFormats.length; i++) {
101	dateFormats[i] = new SimpleDateFormat(datePatterns[i]);
102	}
103	return dateFormats;
104	}
105
106	private static String createDateParseErrorMessage(String[] datePatterns) {
107	StringBuffer messageSb = new StringBuffer();
108	messageSb.append("Supported formats: ");
109	for (int i = 0; i < datePatterns.length; i++) {
110	if (i > 0) {
111	messageSb.append(", ");
112	}
113	messageSb.append(datePatterns[i]);
114	}
115	return messageSb.toString();
116	}
117	}

Lines 21-33 Link Here

(-)src/org/eclipse/core/tests/internal/databinding/BindingMessagesTest.java (-2 / +2 lines)
21	public class BindingMessagesTest extends TestCase {	21	public class BindingMessagesTest extends TestCase {
22	public void testFormatString() throws Exception {	22	public void testFormatString() throws Exception {
23	String key = "Validate_NumberOutOfRangeError";	23	String key = "Validate_NumberOutOfRangeError";
24	String result = BindingMessages.formatString(key, new Object[] {"1", "2"});	24	String result = BindingMessages.getFormattedString(key, new Object[] {"1", "2"});
25	assertFalse("key should not be returned", key.equals(result));	25	assertFalse("key should not be returned", key.equals(result));
26	}	26	}
27		27
28	public void testFormatStringForKeyNotFound() throws Exception {	28	public void testFormatStringForKeyNotFound() throws Exception {
29	String key = "key_that_does_not_exist";	29	String key = "key_that_does_not_exist";
30	String result = BindingMessages.formatString(key, null);	30	String result = BindingMessages.getFormattedString(key, null);
31	assertTrue(key.equals(result));	31	assertTrue(key.equals(result));
32	}	32	}
33	}	33	}