ecommons.waltable/org.eclipse.statet.ecommons.waltable.core/src/org/eclipse/statet/ecommons/waltable/data/validate/IDataValidator.java

/*=============================================================================#
 # Copyright (c) 2012, 2021 Original NatTable authors and others.
 # 
 # This program and the accompanying materials are made available under the
 # terms of the Eclipse Public License 2.0 which is available at
 # https://www.eclipse.org/legal/epl-2.0.
 # 
 # SPDX-License-Identifier: EPL-2.0
 # 
 # Contributors:
 #     Original NatTable authors and others - initial API and implementation
 #=============================================================================*/

package org.eclipse.statet.ecommons.waltable.data.validate;

import org.eclipse.statet.ecommons.waltable.config.IConfigRegistry;
import org.eclipse.statet.ecommons.waltable.data.IDataProvider;
import org.eclipse.statet.ecommons.waltable.data.convert.IDisplayConverter;
import org.eclipse.statet.ecommons.waltable.edit.editor.TextCellEditor;
import org.eclipse.statet.ecommons.waltable.layer.cell.ILayerCell;


public interface IDataValidator {

	/**
	 *
	 * @param columnIndex Index of the column being validated
	 * @param rowIndex Index of the row being validated
	 * @param newValue Value entered through the edit control text box, combo box etc.
	 * 	Note: In case of the {@link TextCellEditor} the text typed in by the user
	 * 	will be converted to the canonical value using the {@link IDisplayConverter}
	 * 	before it hits this method
	 *
	 * @see IDataProvider#getDataValue(int, int)
	 *
	 * @return true is newValue is valid. False otherwise.
	 */
	public boolean validate(long columnIndex, long rowIndex, Object newValue);

	/**
	 * 
	 * @param cell ForwardLayerCell which should be validated
	 * @param configRegistry 
	 * @param newValue Value entered through the edit control text box, combo box etc.
	 * 	Note: In case of the {@link TextCellEditor} the text typed in by the user
	 * 	will be converted to the canonical value using the {@link IDisplayConverter}
	 * 	before it hits this method
	 *
	 * @see IDataProvider#getDataValue(int, int)
	 *
	 * @return true is newValue is valid. False otherwise.
	 */
	public boolean validate(ILayerCell cell, IConfigRegistry configRegistry, Object newValue);

	public static final IDataValidator ALWAYS_VALID= new IDataValidator() {

		@Override
		public boolean validate(final ILayerCell cell, final IConfigRegistry configRegistry, final Object newValue) {
			return true;
		}

		@Override
		public boolean validate(final long columnIndex, final long rowIndex, final Object newValue) {
			return true;
		}

	};

	public static final IDataValidator NEVER_VALID= new IDataValidator() {

		@Override
		public boolean validate(final ILayerCell cell, final IConfigRegistry configRegistry, final Object newValue) {
			return false;
		}

		@Override
		public boolean validate(final long columnIndex, final long rowIndex, final Object newValue) {
			return false;
		}

	};
}