Package org.alfresco.util.schemacomp.validator

Class IgnoreObjectValidator

java.lang.Object

org.alfresco.util.schemacomp.validator.IgnoreObjectValidator

All Implemented Interfaces:

DbValidator

public class IgnoreObjectValidator
extends Object
implements DbValidator

Allows a complete DbObject to be ignored during differencing. In other words if an object that has this validator applied to it is found to be missing from or unexpectedly in the database then that will not be reported as a difference.

Author:

Matt Ward

Constructor Summary

Constructors

Constructor	Description
IgnoreObjectValidator()

Method Summary

Modifier and Type	Method	Description
String	getProperty(String name)	Get the current value of a validator property, as set using DbValidator.setProperty(String, String).
Set<String>	getPropertyNames()	Get the complete set of validator properties in use.
void	setProperty(String name, String value)	Set a property used by this validator.
void	validate(DbObject reference, DbObject target, DiffContext ctx)	Validate the target database object (against the reference object if necessary).
boolean	validates(String fieldName)	Ask whether the database object's validator is responsible for validating the specified field name.
boolean	validatesFullObject()	Asks whether the database object's validator is responsible for validating the entire DbObject.

Methods inherited from class java.lang.Object

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

Constructor Detail

IgnoreObjectValidator

public IgnoreObjectValidator()

Method Detail

validate

public void validate(DbObject reference,
                     DbObject target,
                     DiffContext ctx)

Description copied from interface: DbValidator

Validate the target database object (against the reference object if necessary). Store the validation results on the DiffContext.

Specified by:

validate in interface DbValidator

Parameters:

reference - DbObject

target - DbObject

ctx - DiffContext

setProperty

public void setProperty(String name,
                        String value)

Description copied from interface: DbValidator

Set a property used by this validator. Validator properties provided in the schema reference XML files will be set on the validator using this method.

Specified by:

setProperty in interface DbValidator

Parameters:

name - String

value - String

getProperty

public String getProperty(String name)

Description copied from interface: DbValidator

Get the current value of a validator property, as set using DbValidator.setProperty(String, String).

Specified by:

getProperty in interface DbValidator

Parameters:

name - String

Returns:

String

getPropertyNames

public Set<String> getPropertyNames()

Description copied from interface: DbValidator

Get the complete set of validator properties in use.

Specified by:

getPropertyNames in interface DbValidator

validates

public boolean validates(String fieldName)

Description copied from interface: DbValidator

Ask whether the database object's validator is responsible for validating the specified field name. This only applies to simple properties - not DbObject instances which should provide their own validators.

Specified by:

validates in interface DbValidator

Parameters:

fieldName - String

Returns:

boolean

validatesFullObject

public boolean validatesFullObject()

Description copied from interface: DbValidator

Asks whether the database object's validator is responsible for validating the entire DbObject. If true, then differences are not reported (e.g. table missing from database) as it is the validator's role to worry about presence. If validation and differences are required then report false - even if the validator works at the full object (rather than property) level.

Specified by:

validatesFullObject in interface DbValidator

Returns:

true if missing or unexpected database objects should not be reported by differencing logic.