ddf.catalog.validation.impl.validator

Class RequiredAttributesMetacardValidator

java.lang.Object

ddf.catalog.validation.impl.validator.RequiredAttributesMetacardValidator

All Implemented Interfaces:

MetacardValidator, ReportingMetacardValidator

public class RequiredAttributesMetacardValidator
extends Object
implements MetacardValidator, ReportingMetacardValidator

Validates that a Metacard contains certain Attributes.

Constructor Summary

Constructors

Constructor and Description
RequiredAttributesMetacardValidator(String metacardTypeName, Set<String> requiredAttributes) Creates a RequiredAttributesMetacardValidator with the given metacard type name and set of attribute names representing the required attributes.

Method Summary

Modifier and Type	Method and Description
void	validate(Metacard metacard) Validates a Metacard
Optional<MetacardValidationReport>	validateMetacard(Metacard metacard) Validates a Metacard.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequiredAttributesMetacardValidator

public RequiredAttributesMetacardValidator(String metacardTypeName,
                                           Set<String> requiredAttributes)

Creates a RequiredAttributesMetacardValidator with the given metacard type name and set of attribute names representing the required attributes.

This validator will only validate Metacards that have the type name specified by metacardTypeName (case-sensitive).

Any missing required attributes will be flagged as metacard-level validation errors.

Parameters:

metacardTypeName - the name of the metacard type this validator can validate, cannot be null

requiredAttributes - the names of the attributes this validator will check for, cannot be null or empty

Throws:

IllegalArgumentException - if metacardTypeName is null or if requiredAttributes is null or empty

Method Detail

validate

public void validate(Metacard metacard)
              throws ValidationException

Description copied from interface: MetacardValidator

Validates a Metacard

Specified by:

validate in interface MetacardValidator

Parameters:

metacard - Metacard to validate

Throws:

ValidationException - if any validation error occurs

validateMetacard

public Optional<MetacardValidationReport> validateMetacard(Metacard metacard)

Description copied from interface: ReportingMetacardValidator

Validates a Metacard.

Specified by:

validateMetacard in interface ReportingMetacardValidator

Parameters:

metacard - the Metacard to validate, cannot be null

Returns:

an Optional containing a MetacardValidationReport if there are violations, or an empty Optional if there are no violations