nl.astron.lofar.java.gui.plotter
Interface IPlotDataAccess

All Known Implementing Classes:
PlotDataAccessTestImpl

public interface IPlotDataAccess

This interface forms the communications contract between the plotter classes and any possible data access layer using a class that implements this interface.

Version:
$Id$
Author:
pompert

Method Summary
 java.util.HashMap retrieveData(java.lang.Object constraints)
          This method will retrieve data from the data access layer using an object with any possible information and it must return a HashMap dataset understandable by the plotter.
 java.util.HashMap updateData(java.util.HashMap currentDataSet, java.lang.Object constraints)
          This method will update the dataset provided using an object with any possible information and it must return a HashMap dataset understandable by the plotter.
 

Method Detail

retrieveData

java.util.HashMap retrieveData(java.lang.Object constraints)
                               throws PlotterDataAccessException
This method will retrieve data from the data access layer using an object with any possible information and it must return a HashMap dataset understandable by the plotter.

Parameters:
constraints - An object with constraints to be passed to the implementing class
Returns:
The dataset that has been generated
Throws:
PlotterDataAccessException - will be thrown if the dataset could not be generated for any reason, like database exceptions, file errors, etc.

updateData

java.util.HashMap updateData(java.util.HashMap currentDataSet,
                             java.lang.Object constraints)
                             throws PlotterDataAccessException
This method will update the dataset provided using an object with any possible information and it must return a HashMap dataset understandable by the plotter.

Parameters:
currentDataSet - The dataset to be updated
constraints - An object with constraints to be passed to the implementing class
Returns:
The dataset that has been generated
Throws:
PlotterDataAccessException - will be thrown if the dataset could not be generated for any reason, like database exceptions, file errors, etc.