HiRISE

HiRISE.HiVali
Interface HiValidator

All Known Implementing Classes:
AbstractValidator, EdrValidator

public interface HiValidator

The HiValidator interface will be used by HiVali "plugin" classes and is intended to represent individual validation tasks.

Version:
1.9
Author:
guym

Method Summary
 JPanel getJPanel()
          Get the user interface for the plugin.
 String getTitle()
          Get a short display title for the plugin.
 ValidationNode getValidationNode()
           
 void init()
          Perform any one-time initialization prior to display here, for example getting Configuration values.
 boolean isValid()
          The plugin should make an effort to determine for the user if the source is valid.
 boolean isValidated()
          If the plugin can make an automatic determination that the source is valid or invalid, it must return true here.
 void setHiVali(HiVali hiVali)
          Sets a reference to the instancne of HiVali, where plugins can obtain the Configuration, Database, etc.
 void setValid(boolean valid)
          Set the validation state.
 void setValidationNode(ValidationNode node)
          Re-initializes the data model from a ValidationTreeNode.
 void start()
          This method will be called any time the Observation and ProductID have been changed and indicates that the display should be updated for the new source.
 void stop()
          Interrupt validation, indicates that the task should close any open resources.
 

Method Detail

getTitle

String getTitle()
Get a short display title for the plugin.

Returns:
Title

getJPanel

JPanel getJPanel()
Get the user interface for the plugin.

Returns:
Swing JPanel

setHiVali

void setHiVali(HiVali hiVali)
Sets a reference to the instancne of HiVali, where plugins can obtain the Configuration, Database, etc.

Parameters:
hiVali -

isValid

boolean isValid()
The plugin should make an effort to determine for the user if the source is valid. If it can make the determination, it must be returned here.

Returns:
result of automatic validation state check

setValid

void setValid(boolean valid)
Set the validation state. This would be called, for instance, if the HiVali user over-rode the determination made by the plugin.

Parameters:
valid - True for valid, false for invalid

isValidated

boolean isValidated()
If the plugin can make an automatic determination that the source is valid or invalid, it must return true here.

Returns:
true if source can be checked without user input

init

void init()
          throws Exception
Perform any one-time initialization prior to display here, for example getting Configuration values.

Throws:
Exception

setValidationNode

void setValidationNode(ValidationNode node)
                       throws Throwable
Re-initializes the data model from a ValidationTreeNode.

Parameters:
node - Data for de-serialization
Throws:
Throwable

getValidationNode

ValidationNode getValidationNode()

start

void start()
           throws Exception
This method will be called any time the Observation and ProductID have been changed and indicates that the display should be updated for the new source.

Throws:
Exception

stop

void stop()
Interrupt validation, indicates that the task should close any open resources.


HiRISE

Copyright (C) Arizona Board of Regents on behalf of the Planetary Image Research Laboratory, Lunar and Planetary Laboratory at the University of Arizona