ch.unibe.iam.scg.archie.ui.charts
Class AbstractDatasetCreator

java.lang.Object
  org.eclipse.core.runtime.PlatformObject
      org.eclipse.core.internal.jobs.InternalJob
          org.eclipse.core.runtime.jobs.Job
              ch.unibe.iam.scg.archie.ui.charts.AbstractDatasetCreator

All Implemented Interfaces:

java.lang.Comparable, org.eclipse.core.runtime.IAdaptable

Direct Known Subclasses:

AgeHistogrammDatasetCreator, ConsultationMoneyDatasetCreator, ConsultationNumberDatasetCreator, PatientDatasetCreator, PatientsConsHistDatasetCreator

public abstract class AbstractDatasetCreator
extends org.eclipse.core.runtime.jobs.Job

Abstract dataset creator is resposible for creating a dataset out of the data from the database. This class is used in AbstractChartComposite to build the JFreeChart based charts.

An abstract dataset creator extends the Eclipse API class Job for proper monitoring capabilities while creating the dataset's content.

$Id$

Field Summary

protected org.jfree.data.general.AbstractDataset

dataset

Fields inherited from class org.eclipse.core.runtime.jobs.Job

ASYNC_FINISH, BUILD, DECORATE, INTERACTIVE, LONG, NONE, RUNNING, SHORT, SLEEPING, WAITING

Fields inherited from class org.eclipse.core.internal.jobs.InternalJob

manager

Constructor Summary

AbstractDatasetCreator(java.lang.String jobName)
Creates AbstractDatasetCreator

Method Summary

abstract org.eclipse.core.runtime.IStatus	createContent(org.eclipse.core.runtime.IProgressMonitor monitor) Creates the content for this dataset creator.
org.jfree.data.general.AbstractDataset	getDataset() Returns the dataset for this creator.
protected boolean	isDatasetEmpty() Method to work around the incapability of finding out whether the dataset has any data in it or not.
protected org.eclipse.core.runtime.IStatus	run(org.eclipse.core.runtime.IProgressMonitor monitor) This method runs the job.

Methods inherited from class org.eclipse.core.runtime.jobs.Job

addJobChangeListener, belongsTo, cancel, canceling, done, getJobManager, getName, getPriority, getProperty, getResult, getRule, getState, getThread, isBlocking, isSystem, isUser, join, removeJobChangeListener, schedule, schedule, setName, setPriority, setProgressGroup, setProperty, setRule, setSystem, setThread, setUser, shouldRun, shouldSchedule, sleep, toString, wakeUp, wakeUp, yieldRule

Methods inherited from class org.eclipse.core.internal.jobs.InternalJob

compareTo

Methods inherited from class org.eclipse.core.runtime.PlatformObject

getAdapter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Field Detail

dataset

protected org.jfree.data.general.AbstractDataset dataset

Constructor Detail

AbstractDatasetCreator

public AbstractDatasetCreator(java.lang.String jobName)

Creates AbstractDatasetCreator

Parameters:

jobName -

Method Detail

getDataset

public org.jfree.data.general.AbstractDataset getDataset()

Returns the dataset for this creator.

Returns:

Created dataset.

createContent

public abstract org.eclipse.core.runtime.IStatus createContent(org.eclipse.core.runtime.IProgressMonitor monitor)

Creates the content for this dataset creator. Subclasses need to implement this method and do their main work in here - create the dataset.

Returns:

Status that reflect the outcome of the content creation.

run

protected org.eclipse.core.runtime.IStatus run(org.eclipse.core.runtime.IProgressMonitor monitor)

This method runs the job. In this implementation, this means calling the content creation method of a dataset creator.

Specified by:

run in class org.eclipse.core.runtime.jobs.Job

See Also:

org.eclipse.core.runtime.jobs.Job#run(org.eclipse.core.runtime. IProgressMonitor)

isDatasetEmpty

protected boolean isDatasetEmpty()

Method to work around the incapability of finding out whether the dataset has any data in it or not. The method returns false by default so that even empty dataset get rendered. If a subclass overrides this method, other objects can check for it and e.g. display a warning or information message instead of an empty graph.

Returns:

True if the dataset is empty, false else. Returns false by default.