Page History

...

Note
Note that IColumnConverter is considered to be deprecated, therefore in getColumnConverters() method do return an ITypedColumnConverter array.

A column converter class implementing the ITypedColumnConverter interface has to implement the following three methods that will be displayed in the Conversion tab:

convertFromObject()
Converts from dataprovider value to db value
convertToObject()
Converts from db value to dataprovider value
getToObjectType(one of TEXT, INTEGER, NUMBER, DATETIME or MEDIA)
The dataprovider data type (so the resulting type of the convertToObject()).
This type can be provided by using the IColumnTypes constants, being one of the IColumnTypes constants: TEXT, INTEGER, NUMBER, DATETIME or MEDIA

A column converter class can define properties in the getDefaultProperties() method, which will be displayed in the Conversion tab as well.

The column types that the column converter supports are to be specified in the getSupportedColumnTypes() method.

For an example of a column converter, see the NrToJodaConverter class in the example given on Providing UI Converters from Plugins page.

...

An IColumnValidator can also define properties in the getDefaultProperties() method, whose values will be set by the developer in UI, in the Validation tab.

The column types that the validator supports are specified in the getSupportedColumnTypes() method.

All the implemented custom column validators must be returned by the getColumnValidators() method of the plugin class implementing the IColumnValidatorProvider interface, so that they become available within Servoy Developer.

With 2020.06 there is a IColumnValidator2 which extends IColumnValidator which adds public void validate(Map<String, String> props, Object value, String dataprovider, IValidationObject validationObject, Object state); method that works with the new validation framework: Data/Record/Column validation

As an example how the new IColumnValidator2 interface works look here (see also below the example)

Example

This is an example of validating the size of a column of type TEXT or MEDIA. The validation rule is that the size must be lower or equal to the value given by the developer by setting the length property in the Validation tab.

Code Block

language	java

import java.util.Map;

import com.servoy.j2db.dataprocessing.IColumnValidator2;
import com.servoy.j2db.dataprocessing.IValidationObject;
import com.servoy.j2db.persistence.IColumnTypes;
import com.servoy.j2db.util.ILogLevel;
import com.servoy.j2db.util.Utils;

@SuppressWarnings("nls")
public class SizeValidatorNumberRangeValidator implements IColumnValidatorIColumnValidator2
{
	private static final String FROM_PROPERTY 	LENGTH= "from";
	private static final String TO_PROPERTY = "lengthto";

	public Map<String, MapString> getDefaultProperties()
	{
		MapMap<String, String> props = new HashMap( java.util.LinkedHashMap<>();
		props.put(FROM_PROPERTY, "");
		props.put(LENGTHTO_PROPERTY, "");
		return props;
	}

	public String getName()
	{
		return "servoy.NumberRangeValidator";
		{}

	public int[] getSupportedColumnTypes()
	{
		return new int[] 	return{ "servoy.SizeValidator";
  IColumnTypes.INTEGER, IColumnTypes.NUMBER };
	}

	}/**
     	public int[] getSupportedColumnTypes()
    	{
        	return new int[] { IColumnTypes.TEXT, IColumnTypes.MEDIA };
    	}
* IColumnValidator2 interface with the new IValidationObject, if given then the error is reported on that instead of throwing an exception.
     */ 
	@Override
	public void validate(MapMap<String, String> props, Object arg) throws IllegalArgumentException value, String dataprovider, IValidationObject validationObject, Object state)
	{
		Stringif propLength(value == (String)null || value.toString().trim().length() == 0) return;

		double from = Utils.getAsDouble(props.get(LENGTHFROM_PROPERTY));
		intdouble lengthto = new Double(propLength.replace(',', '.')).intValue(Utils.getAsDouble(props.get(TO_PROPERTY));
		double val = Utils.getAsDouble(value);
		if (arg instanceof byte[] && ((byte[])arg).length > length)
		{
			val < from || val > to)
		{
			if (validationObject != null)
				validationObject.report("i18n:servoy.validator.range", dataprovider, ILogLevel.ERROR, state,
					new Object[] { value, dataprovider, Double.valueOf(from), Double.valueOf(to) });
			else throw new IllegalArgumentException();
		}
		else if (arg instanceof String && ((String)arg).length() > length)
		{
			throw new IllegalArgumentException();
		}}

    // the old validate method of IColumnValidator interface, just call the IColumnValidator2 valdiate method with null.
	public void validate(Map<String, String> props, Object arg) throws IllegalArgumentException
	{
		validate(props, arg, null, null, null);
	}
}

Child pages

Versions Compared

Old Version 17

New Version Current

Key

Example