Class ProtocolValidator
java.lang.Object
net.sf.basedb.util.overview.validator.BasicNodeValidator<I>
net.sf.basedb.util.overview.validator.NameableNodeValidator<Protocol>
net.sf.basedb.util.overview.validator.ProtocolValidator
- All Implemented Interfaces:
NodeValidator<Protocol>
Validator implementation for protocols. Validation rules:
- Missing item:
Validator.MISSING_PROTOCOL
- Access denied:
Validator.DENIED_PROTOCOL
- Incorrect protocol type:
Validator.INCORRECT_PROTOCOLTYPE
- Non-default protocol:
Validator.NONDEFAULT_PROTOCOL
- Version:
- 2.10
- Author:
- Nicklas
- Last modified
- $Date: 2020-09-18 11:51:26 +0200 (Fri, 18 Sep 2020) $
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected ItemSubtype
getExpectedProtocolSubtype
(DbControl dc, BasicItem parentItem) Get the subtype of the associated protocol that we expect for the given parent item.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) Checks if the protocol is of the correct protocol type and, if a project is active, the protocol is the same as the default for the project.boolean
preMissingItem
(DbControl dc, OverviewContext context, Node parentNode) If the parent item has a subtype that is related to a PROTOCOL subtype, report the missing item as aValidator.MISSING_PROTOCOL
failure.Methods inherited from class net.sf.basedb.util.overview.validator.BasicNodeValidator
getDeniedItemFix, postDeniedItem, postMissingItem, postValidateFolder, preDeniedItem, preValidate
-
Constructor Details
-
ProtocolValidator
public ProtocolValidator()
-
-
Method Details
-
preMissingItem
If the parent item has a subtype that is related to a PROTOCOL subtype, report the missing item as aValidator.MISSING_PROTOCOL
failure. Otherwise, ignore the missing protocol.- Specified by:
preMissingItem
in interfaceNodeValidator<Protocol>
- Overrides:
preMissingItem
in classBasicNodeValidator<Protocol>
- Parameters:
dc
- A DbControl to use if the validation needs to access the databasecontext
- The current overview contextparentNode
- The parent node that is missing the item- Returns:
- Always false
-
postValidate
Checks if the protocol is of the correct protocol type and, if a project is active, the protocol is the same as the default for the project.- Specified by:
postValidate
in interfaceNodeValidator<Protocol>
- Overrides:
postValidate
in classNameableNodeValidator<Protocol>
- Parameters:
dc
- A DbControl to use if the validation needs to access the databasecontext
- The current overview contextnode
- The node object that represents itemparentNode
- The parent node that is linked with the item
-
getMissingItemFix
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 classBasicNodeValidator<Protocol>
- Returns:
- Suggested fix is to add a protocol to the parent item
-
getExpectedProtocolSubtype
Get the subtype of the associated protocol that we expect for the given parent item.
-