Package net.sf.basedb.util.overview.validator

Class AnnotationValidator

java.lang.Object

net.sf.basedb.util.overview.validator.BasicNodeValidator<Annotation>

net.sf.basedb.util.overview.validator.AnnotationValidator

All Implemented Interfaces:

NodeValidator<Annotation>

public class AnnotationValidator
extends BasicNodeValidator<Annotation>

Validator implementation for annotations. The node containing the annotations is expected to live in a folder-type node that has an Annotatable item as it's parent. Validation rules:

• Annotation is a protocol parameter: Validator.ANNOTATION_IS_PARAMETER
• Annotation is not valid for item type: Validator.ANNOTATION_INVALID_ITEM
• Annotation has invalid value: Validator.ANNOTATION_INVALID_VALUE
• Annotation has too many values: Validator.ANNOTATION_TOO_MANY_VALUES
• Access denied to annotation type: Validator.DENIED_ANNOTATIONTYPE
• Annotation is inherited from non-parent item: Validator.ANNOTATION_INHERIT_FROM_NONPARENT
• Multiple annotations of same annotation type: Validator.ANNOTATION_INHERIT_MULTIPLE
• Missing a 'Required by MIAME' annotation: Validator.MISSING_MIAME_ANNOTATION
• Missing experimental factor value: Validator.MISSING_FACTORVALUE

Version:

2.10

Author:

Nicklas

Last modified

$Date: 2020-10-20 15:30:21 +0200 (Tue, 20 Oct 2020) $

Constructor Summary

Constructors

Constructor	Description
AnnotationValidator()

Method Summary

Modifier and Type	Method	Description
protected Fix	getMissingItemFix(DbControl dc, Node parentNode)	Subclasses should override this method if they have a suggessted fix for a missing item problem.
void	postValidate(DbControl dc, OverviewContext context, Node node, Node parentNode)	Do nothing.
void	postValidateFolder(DbControl dc, OverviewContext context, Node folderNode, Node parentNode)	Do nothing.

Methods inherited from class net.sf.basedb.util.overview.validator.BasicNodeValidator

getDeniedItemFix, postDeniedItem, postMissingItem, preDeniedItem, preMissingItem, preValidate

Methods inherited from class java.lang.Object

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

Constructor Details

AnnotationValidator

public AnnotationValidator()

Method Details

postValidate

public void postValidate(DbControl dc,
OverviewContext context,
Node node,
Node parentNode)

Description copied from class: BasicNodeValidator

Do nothing. Subclasses should override this method if they need more validation for an existing and accessible item.

Specified by:

postValidate in interface NodeValidator<Annotation>

Overrides:

postValidate in class BasicNodeValidator<Annotation>

Parameters:

dc - A DbControl to use if the validation needs to access the database

context - The current overview context

node - The node object that represents item

parentNode - The parent node that is linked with the item

postValidateFolder

public void postValidateFolder(DbControl dc,
OverviewContext context,
Node folderNode,
Node parentNode)

Description copied from class: BasicNodeValidator

Do nothing. Subclasses should override this method if they need to validate all items inside a folder-type node.

Specified by:

postValidateFolder in interface NodeValidator<Annotation>

Overrides:

postValidateFolder in class BasicNodeValidator<Annotation>

Parameters:

dc - A DbControl to use for database access

context - The current overview context

folderNode - The folder node, or null if no folder has been created

parentNode - The parent node (never null)

getMissingItemFix

protected Fix getMissingItemFix(DbControl dc,
Node parentNode)

Description copied from class: BasicNodeValidator

Subclasses should override this method if they have a suggessted fix for a missing item problem. The default implementation does nothing, but the following template may be usable by most subclasses:

                new Fix("Add item to parent", parentNode.getItem())
                

Specified by:

getMissingItemFix in class BasicNodeValidator<Annotation>

Returns:

Always "null"