ch.unibe.iam.scg.archie.model
Class AbstractDataProvider

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.model.AbstractDataProvider

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractTimeSeries, ListeNachFaelligkeit, OffenePostenListe

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

An abstract class for data providers used by this plugin. An AbstractDataProvider is being constructed with a name, which is also the name of the background job being run when the provider is collecting its data. The provider holds a DataSet object which provides convenience methods for presenting and retrieving statistical data. Each provider also has to set the size of its elements accordingly so the Job so progress information is being displayed accurately.

Providers have to initialize additional default values of their properties either in the constructor or as part of the class definition. There is no abstract method that binds the implementors to initialize their default values. An error will be thrown in the GUI when no default value has been initialized for a provider property.

$Id: AbstractDataProvider.java 258 2008-10-06 17:51:15Z psiska

Field Summary

protected DataSet

dataSet DataSet which stores results of this query in matrix form.

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

AbstractDataProvider(java.lang.String jobName)
Public constructor.

Method Summary

protected abstract org.eclipse.core.runtime.IStatus	createContent(org.eclipse.core.runtime.IProgressMonitor monitor) This method should do all the work necessary to populate the dataset's content.
protected abstract java.util.List<java.lang.String>	createHeadings() Creates headings for each column in the dataset object of this provider.
org.eclipse.core.runtime.IStatus	execute(org.eclipse.core.runtime.IProgressMonitor monitor) Executes this job.
org.eclipse.jface.viewers.IStructuredContentProvider	getContentProvider() Returns the content provider for this data provider.
DataSet	getDataSet() Returns the DataSet being held by this data provider.
abstract java.lang.String	getDescription() Returns the description for this data provider.
org.eclipse.jface.viewers.ILabelProvider	getLabelProvider() Returns the label provider for this data provider.
protected void	initializeProviders() Initializes content and label providers and sets them accordingly.
protected org.eclipse.core.runtime.IStatus	run(org.eclipse.core.runtime.IProgressMonitor monitor)
protected void	setContentProvider(org.eclipse.jface.viewers.IStructuredContentProvider contentProvider) Sets the content provider for this data provider.
protected void	setLabelProvider(org.eclipse.jface.viewers.ILabelProvider labelProvider) Sets the label provider for this data provider.

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 DataSet dataSet

DataSet which stores results of this query in matrix form.

Constructor Detail

AbstractDataProvider

public AbstractDataProvider(java.lang.String jobName)

Public constructor.

Parameters:

jobName -

Method Detail

getDescription

public abstract java.lang.String getDescription()

Returns the description for this data provider.

Returns:

Returns the description for this data provider.

createHeadings

protected abstract java.util.List<java.lang.String> createHeadings()

Creates headings for each column in the dataset object of this provider.

Returns:

A list of strings (List) containing the headings.

createContent

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

This method should do all the work necessary to populate the dataset's content. It's called in the job's execute method after some initializations have been done.

Returns:

The status of the current job.

See Also:

IStatus

run

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

Specified by:

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

execute

public org.eclipse.core.runtime.IStatus execute(org.eclipse.core.runtime.IProgressMonitor monitor)

Executes this job.

Parameters:

monitor -

Returns:

The status of the current job.

getContentProvider

public org.eclipse.jface.viewers.IStructuredContentProvider getContentProvider()

Returns the content provider for this data provider.

Returns:

IStructuredContentProvider

See Also:

IStructuredContentProvider

getLabelProvider

public org.eclipse.jface.viewers.ILabelProvider getLabelProvider()

Returns the label provider for this data provider.

Returns:

LabelProvider A label provider for this object.

See Also:

LabelProvider

getDataSet

public DataSet getDataSet()

Returns the DataSet being held by this data provider.

Returns:

The DataSet object for this provider.

See Also:

DataSet

initializeProviders

protected void initializeProviders()

Initializes content and label providers and sets them accordingly. This is a generic method using two default providers for labels and content. Every class that has custom providers needs to override this method.

setLabelProvider

protected void setLabelProvider(org.eclipse.jface.viewers.ILabelProvider labelProvider)

Sets the label provider for this data provider.

Parameters:

labelProvider - A label provider.

See Also:

LabelProvider

setContentProvider

protected void setContentProvider(org.eclipse.jface.viewers.IStructuredContentProvider contentProvider)

Sets the content provider for this data provider.

Parameters:

contentProvider - A content provider for this object.

See Also:

IStructuredContentProvider