| org.geotools.validation.Validation
| Validation | | public interface Validation (Code) | | Used to define a type of validation test that is performed on Features.
Each ValidationPlugIn is very specific in nature: it performs one test
extermly well. This simplifies design decisions, documenation
configuration and use.
The PlugIn is also required to supply some metadata to aid in its
deployment, scripting, logging and execution and error recovery:
-
name: user's name of validation test
-
description: user's description of validation test
-
priority: used to schedule validation test
-
typeNames: used to connect validaiton test to transaction opperation
author:
bowens, Refractions Research, Inc.
author:
$Author: dmzwiers $ (last modification)
version:
$Id: Validation.java 20884 2006-08-07 14:10:46Z jgarnett $ |
| Field Summary | |
| final public static String[] | ALL
Empty String array for use with getTypeNames().
Used to denote that all FeatureTypes should be tested. | | final public static int | PRIORITY_COMPLEX
A constant for getPriority() used for complex validation checks. | | final public static int | PRIORITY_INVOLVED
A constant for getPriority() used for involved validation checks. | | final public static int | PRIORITY_SIMPLE
A constant for getPriority() used for simple validation checks. | | final public static int | PRIORITY_TRIVIAL
A constant for getPriority() used for Trivial validation checks. |
| Method Summary | |
| String | getDescription()
User's Description of this Validation. | | String | getName()
User's name for the validation. | | int | getPriority()
Priority used in scheduling this Validation test. | | String[] | getTypeRefs()
Identify the FeatureTypes that this validation test is run against.
If this list is empty the ValidationProcess will run the test against
all FeatureTypes. | | void | setDescription(String description)
Sets the description of the validation. | | void | setName(String name)
Sets the name of the validation. |
| ALL | | final public static String[] ALL(Code) | | Empty String array for use with getTypeNames().
Used to denote that all FeatureTypes should be tested. (If this does not
Pan out we may have to define the wild-card character "" or support
Regex based typeName matching.
|
| PRIORITY_COMPLEX | | final public static int PRIORITY_COMPLEX(Code) | | A constant for getPriority() used for complex validation checks.
This is a Priority Hint to Validation Processor based on computational
expense.
Used for complex validations, basically anything that is has a Chance of
being worse then O(N).
Any integrity tests between two FeatureTypes should be an example of a
PRIORITY_COMPLEX.
|
| PRIORITY_INVOLVED | | final public static int PRIORITY_INVOLVED(Code) | | A constant for getPriority() used for involved validation checks.
This is a Priority Hint to Validation Processor based on computational
expense.
Used for involved validations, basically anything that is has a Chance
of being worse then O(N^2).
Any integrity tests involving network code, were we have to build the
network and then walk it, is an example of PRIORITY_INVOLVED.
|
| PRIORITY_SIMPLE | | final public static int PRIORITY_SIMPLE(Code) | | A constant for getPriority() used for simple validation checks.
This is a Priority Hint to Validation Processor based on computational
expense.
Used for simple attribute or geometry validations, basically anything
that is Order(N) like a Bounds check.
|
| PRIORITY_TRIVIAL | | final public static int PRIORITY_TRIVIAL(Code) | | A constant for getPriority() used for Trivial validation checks.
This is a Priority Hint to Validation Processor based on computational
expense.
Trivial is used for thing that don't require any real work - like
checking for any O(1) opperations such as checking null values.
|
| getDescription | | String getDescription()(Code) | | User's Description of this Validation.
the description of the validation. |
| getName | | String getName()(Code) | | User's name for the validation.
the name of the validation. |
| getPriority | | int getPriority()(Code) | | Priority used in scheduling this Validation test.
The priority (time cost) of the validation test |
| getTypeRefs | | String[] getTypeRefs()(Code) | | Identify the FeatureTypes that this validation test is run against.
If this list is empty the ValidationProcess will run the test against
all FeatureTypes. The ValidationProcess expects these names to be in
the format dataStoreId:typeName.
FeatureType names that this validation test is run against,empty for all, null to disable |
| setDescription | | void setDescription(String description)(Code) | | Sets the description of the validation.
Parameters:
description - of the validation |
| setName | | void setName(String name)(Code) | | Sets the name of the validation.
Parameters:
name - the name of the validation. |
|
|