org.codice.ddf.validator.metacard.duplication

Class DuplicationValidator

java.lang.Object

org.codice.ddf.validator.metacard.duplication.DuplicationValidator

All Implemented Interfaces:

MetacardValidator, ReportingMetacardValidator, Describable

public class DuplicationValidator
extends Object
implements MetacardValidator, ReportingMetacardValidator, Describable, Describable

Constructor Summary

Constructors

Constructor and Description
DuplicationValidator(CatalogFramework catalogFramework, FilterBuilder filterBuilder)

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns a description of the describable item.
String	getId() Returns the name, aka ID, of the describable item.
String	getOrganization() Returns the organization associated with the describable item.
String	getTitle() Returns the title of the describable item.
String	getVersion() Retrieve the version.
void	setErrorOnDuplicateAttributes(String[] attributeStrings) Setter for the list of attributes to test for duplication in the local catalog.
void	setWarnOnDuplicateAttributes(String[] attributeStrings) Setter for the list of attributes to test for duplication in the local catalog.
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

DuplicationValidator

public DuplicationValidator(CatalogFramework catalogFramework,
                            FilterBuilder filterBuilder)

Method Detail

setErrorOnDuplicateAttributes

public void setErrorOnDuplicateAttributes(String[] attributeStrings)

Setter for the list of attributes to test for duplication in the local catalog. Resulting attributes will cause the Validation.VALIDATION_ERRORS attribute to be set on the metacard.

Parameters:

attributeStrings -

setWarnOnDuplicateAttributes

public void setWarnOnDuplicateAttributes(String[] attributeStrings)

Setter for the list of attributes to test for duplication in the local catalog. Resulting attributes will cause the Validation.VALIDATION_WARNINGS attribute to be set on the metacard.

Parameters:

attributeStrings -

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

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

getVersion

public String getVersion()

Description copied from interface: Describable

Retrieve the version.

Specified by:

getVersion in interface Describable

Returns:

the version of the item being described (example: 1.0)

getId

public String getId()

Description copied from interface: Describable

Returns the name, aka ID, of the describable item. The name should be unique for each instance.
Example: html for a MetacardTransformer that transforms Metacards to HTML

Specified by:

getId in interface Describable

Returns:

ID of the item

getTitle

public String getTitle()

Description copied from interface: Describable

Returns the title of the describable item. It is generally more verbose than the name (aka ID).

Specified by:

getTitle in interface Describable

Returns:

title of the item (example: Dummy Catalog Provider)

getDescription

public String getDescription()

Description copied from interface: Describable

Returns a description of the describable item.

Specified by:

getDescription in interface Describable

Returns:

description of the item (example: Provider that returns back static results)

getOrganization

public String getOrganization()

Description copied from interface: Describable

Returns the organization associated with the describable item.

Specified by:

getOrganization in interface Describable

Returns:

organizational name or acronym (example: USAF)