Package com.luciad.util

Class TLcdValidationResult

java.lang.Object

com.luciad.util.TLcdValidationResult

public final class TLcdValidationResult
extends Object

A TLcdValidationResult is used to contain the result of a validation operation. It contain the severity of the validation result (see TLcdValidationResult.Severity) and the corresponding warning and error messages. The benefit of using this class is that is collects all warnings and errors, instead of relying on a single message as a result.

Usage:

  public TLcdValidationResult validateModelMetaDataForWcsService(TLcdModelMetadata aModelMetadata) {
    TLcdValidationResult validationResult = TLcdValidationResult.ok();

    if (!aModelMetadata.getDataSource().isPresent()) {
      validationResult.addError("The model metadata is empty");
    }

    if (!aModelMetadata.getDataCategories().contains(TLcdModelMetadata.DataCategory.RASTER)) {
      validationResult.addError("The model metadata does not contain raster data.");
    }
    if (aModelMetadata.getDataCategories().size() > 1) {
      validationResult.addError("The model metadata contains mixed data. Only metadata containing nothing but raster data is supported.");
    }

    List<? extends ILcdDimension<?>> dimensions = aModelMetadata.getDimensions();
    if (dimensions.size() > 1
        || (dimensions.size() == 1 && dimensions.get(0).getValues().size() > 1)) {
      validationResult.addWarning("The model metadata contains data with multiple dimensions and values. "
                                  + "This is not supported and only the first dimension value will be used.");
    }

    return validationResult;
  }

Since:

2021.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TLcdValidationResult.Severity	Describes the different severity levels of a validation result.

Method Summary

Modifier and Type	Method	Description
void	addAll(TLcdValidationResult aValidationResult)	Adds all warnings and errors from aValidationResult to this validation result.
void	addError(String aMessage)	Adds an error message to this validation result.
void	addWarning(String aMessage)	Adds a warning message to this validation result.
static TLcdValidationResult	error(String aErrorMessage)	Creates a new validation result object with an error associated to it.
List<String>	getErrorMessages()	Returns the list of error messages associated with this validation result.
TLcdValidationResult.Severity	getSeverity()	Returns the severity of this validation result.
List<String>	getWarningMessages()	Returns the list of warning messages associated with this validation result.
TLcdValidationResult	merge(TLcdValidationResult aValidationResult)	Merges this validation result with another validation result.
static TLcdValidationResult	ok()	Creates a new validation result object without any warnings or errors associated to it.
String	toString()
static TLcdValidationResult	warning(String aWarningMessage)	Creates a new validation result object with a warning associated to it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

ok

public static TLcdValidationResult ok()

Creates a new validation result object without any warnings or errors associated to it. The severity of the created validation result is TLcdValidationResult.Severity.OK.

Returns:

a new validation result with severity ok.

warning

public static TLcdValidationResult warning(String aWarningMessage)

Creates a new validation result object with a warning associated to it. The severity of the created validation result is TLcdValidationResult.Severity.WARNING.

Parameters:

aWarningMessage - the warning message to associate with the new validation result

Returns:

a new validation result with a warning associated with it.

error

public static TLcdValidationResult error(String aErrorMessage)

Creates a new validation result object with an error associated to it. The severity of the created validation result is TLcdValidationResult.Severity.ERROR.

Parameters:

aErrorMessage - the error message to associate with the new validation result

Returns:

a new validation result with an error associated with it.

getSeverity

public TLcdValidationResult.Severity getSeverity()

Returns the severity of this validation result. This can be used to determine if any warning or errors were discovered during validation.

Returns:

severity of the validation result

See Also:

• TLcdValidationResult.Severity

addWarning

public void addWarning(String aMessage)

Adds a warning message to this validation result. The warning message cannot be null. If the current severity is TLcdValidationResult.Severity.OK, it will be updated to TLcdValidationResult.Severity.WARNING.

Parameters:

aMessage - the warning message to add

getWarningMessages

public List<String> getWarningMessages()

Returns the list of warning messages associated with this validation result. This list is not modifiable, use addWarning(String) instead. If the current severity is TLcdValidationResult.Severity.OK, the list will be empty.

Returns:

the list of warning messages associated with this validation result

addError

public void addError(String aMessage)

Adds an error message to this validation result. The error message cannot be null. If the current severity is TLcdValidationResult.Severity.OK or TLcdValidationResult.Severity.WARNING, it will be updated to TLcdValidationResult.Severity.ERROR.

Parameters:

aMessage - the error message to add

getErrorMessages

public List<String> getErrorMessages()

Returns the list of error messages associated with this validation result. This list is not modifiable, use addError(String) instead. If the current severity is TLcdValidationResult.Severity.OK or TLcdValidationResult.Severity.WARNING, the list will be empty.

Returns:

the list of error messages associated with this validation result

addAll

public void addAll(TLcdValidationResult aValidationResult)

Adds all warnings and errors from aValidationResult to this validation result.

The severity of this validation result is updated if the severity of aValidationResult is more severe than this validation result. For example, adding all messages from a validation result with severity TLcdValidationResult.Severity.ERROR to a validation result with severity TLcdValidationResult.Severity.WARNING will result in the severity of the validation result being updated from TLcdValidationResult.Severity.WARNING to TLcdValidationResult.Severity.ERROR.

Parameters:

aValidationResult - the validation result to add warnings and errors from

merge

public TLcdValidationResult merge(TLcdValidationResult aValidationResult)

Merges this validation result with another validation result. A new validation result is returned that contains the warnings and errors from both this validation result and aValidationResult.

The severity of the resulting merged validation result will be the most severe value of both validation results. For example, merging a validation result with severity TLcdValidationResult.Severity.WARNING with a validation result with severity TLcdValidationResult.Severity.ERROR will result in a validation result with severity TLcdValidationResult.Severity.ERROR.

Parameters:

aValidationResult - the validation result to merge with

Returns:

the merged validation result

toString

public String toString()

Overrides:

toString in class Object