org.geotools.validation
Interface ValidationResults

All Known Implementing Classes:

DefaultFeatureResults

public interface ValidationResults

Collates results of validation operations.

Following the lead the excelent design work in the JUnit testing framework validation results are collected by a ValidationResults object. This interface for the ValidationResults object also allows it to collect warning information.

Author:

Jody Garnett, Refractions Research, Inc

Method Summary

void	error(Feature feature, java.lang.String message) Returns a validation error on against the provided feature, An optional error message may be provided.
void	setValidation(Validation validation) Called to configure ValidationResults according to the provided FeatureValidation
void	warning(Feature feature, java.lang.String message) Returns a validation warning against the provided feature.

Method Detail

setValidation

public void setValidation(Validation validation)

Called to configure ValidationResults according to the provided FeatureValidation

Parameters:

validation - Provided FeatureValidation

error

public void error(Feature feature,
                  java.lang.String message)

Returns a validation error on against the provided feature, An optional error message may be provided. The validating web feature server will:

• Collate all errors for transaction result
• Log all errors
• Transaction may be canceled or have partial success depending on transaction request

Please note:
The FeatureResults object has been provided with a Validation object allowing it access to the user's name for the test, and the users decription of the test. Use the message information only to provide specific failure information.

Parameters:

feature - Feature found invalid

message - Optional error message. Use a non null message to provide specific failure information.

warning

public void warning(Feature feature,
                    java.lang.String message)

Returns a validation warning against the provided feature. An optional warning message may be provided The validating web feature server will:

• Collate all warnings for a comment in the transaction result
• Log all warnings

The FeatureResults object has been provided with a Validation object allowing it access to the user's name for the test, and the users decription of the test. Use the message information only to provide specific failure information.

Parameters:

feature - Feature found to be in error

message - Optional warning message. Use a non null message to provide specific warning information.