org.dawb.workbench.ui.editors
Class PlotDataComponent

java.lang.Object
  extended by org.dawb.workbench.ui.editors.PlotDataComponent
All Implemented Interfaces:
IDatasetProvider, org.eclipse.jface.viewers.ICheckStateListener

public class PlotDataComponent
extends java.lang.Object
implements org.eclipse.jface.viewers.ICheckStateListener, IDatasetProvider

This view can view and plot any file. It is most efficient if the Loader that LoaderFactory uses for this file type is an IMetaLoader.


Field Summary
static java.lang.String ID
           
 
Constructor Summary
PlotDataComponent(IDatasetProvider providerDeligate)
           
 
Method Summary
 void addExpression()
           
 void addSelectionListener(org.eclipse.jface.viewers.ISelectionChangedListener l)
          Call to be notified of data set collections being made.
 void checkStateChanged(org.eclipse.jface.viewers.CheckStateChangedEvent event)
           
 void createPartControl(org.eclipse.swt.widgets.Composite parent)
          Create contents of the view part.
 void deleteExpression()
           
 void dispose()
           
 uk.ac.diamond.scisoft.analysis.dataset.AbstractDataset getDataSet(java.lang.String name, uk.ac.gda.monitor.IMonitor monitor)
          Return data set for name
 int getDimensionCount(java.lang.Object element)
           
 java.util.List<java.lang.Object> getExpressions(IDatasetProvider prov)
           
 java.lang.String getFileName()
           
static java.util.List<java.util.regex.Pattern> getIgnored()
           
 uk.ac.diamond.scisoft.analysis.io.IMetaData getMetaData()
           
 PlotType getPlotMode()
           
 AbstractPlottingSystem getPlottingSystem()
          May return null, if data not plotting
 java.lang.String getRootName()
           
 java.util.List<java.lang.Object> getSelections()
           
 boolean isDataSetName(java.lang.String name, uk.ac.gda.monitor.IMonitor monitor)
          Test if data set name.
 void refresh()
           
 void removeSelectionListener(org.eclipse.jface.viewers.ISelectionChangedListener l)
           
 uk.ac.diamond.scisoft.analysis.dataset.AbstractDataset setDatasetSelected(java.lang.String name, boolean clearOthers)
          Thread safe
 void setFile(java.lang.String path, org.eclipse.core.runtime.IProgressMonitor monitor)
          Call to load a data file and display it.
 void setFileName(java.lang.String fileName)
           
 void setFocus()
           
 void setMetaData(uk.ac.diamond.scisoft.analysis.io.IMetaData meta)
          Used when the view is being controlled from a Dialog.
 void setPlotMode(PlotType pm)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ID

public static final java.lang.String ID
See Also:
Constant Field Values
Constructor Detail

PlotDataComponent

public PlotDataComponent(IDatasetProvider providerDeligate)
Method Detail

createPartControl

public void createPartControl(org.eclipse.swt.widgets.Composite parent)
Create contents of the view part.

Parameters:
parent -

setFocus

public void setFocus()

setFile

public void setFile(java.lang.String path,
                    org.eclipse.core.runtime.IProgressMonitor monitor)
             throws java.lang.Exception
Call to load a data file and display it.

Parameters:
path -
Throws:
java.lang.Exception

getSelections

public java.util.List<java.lang.Object> getSelections()
Returns:
Returns the selections.

checkStateChanged

public void checkStateChanged(org.eclipse.jface.viewers.CheckStateChangedEvent event)
Specified by:
checkStateChanged in interface org.eclipse.jface.viewers.ICheckStateListener

addSelectionListener

public void addSelectionListener(org.eclipse.jface.viewers.ISelectionChangedListener l)
Call to be notified of data set collections being made. The selections returned are a StructuredSelection with a list of objects some are Strings for the data set name and others are ExpressionObject if the user created expressions. NOTE: The listener is NOT called on the GUI thread.

Parameters:
l -

removeSelectionListener

public void removeSelectionListener(org.eclipse.jface.viewers.ISelectionChangedListener l)

getRootName

public java.lang.String getRootName()

getPlotMode

public PlotType getPlotMode()

setPlotMode

public void setPlotMode(PlotType pm)
Parameters:
pm - The plotMode to set.

getDataSet

public uk.ac.diamond.scisoft.analysis.dataset.AbstractDataset getDataSet(java.lang.String name,
                                                                         uk.ac.gda.monitor.IMonitor monitor)
Description copied from interface: IDatasetProvider
Return data set for name

Specified by:
getDataSet in interface IDatasetProvider
Returns:

isDataSetName

public boolean isDataSetName(java.lang.String name,
                             uk.ac.gda.monitor.IMonitor monitor)
Description copied from interface: IDatasetProvider
Test if data set name.

Specified by:
isDataSetName in interface IDatasetProvider
Returns:

dispose

public void dispose()

getDimensionCount

public int getDimensionCount(java.lang.Object element)

addExpression

public void addExpression()

deleteExpression

public void deleteExpression()

getIgnored

public static java.util.List<java.util.regex.Pattern> getIgnored()

setMetaData

public void setMetaData(uk.ac.diamond.scisoft.analysis.io.IMetaData meta)
Used when the view is being controlled from a Dialog.

Parameters:
meta -

refresh

public void refresh()

getExpressions

public java.util.List<java.lang.Object> getExpressions(IDatasetProvider prov)
Returns:
exprs can be null or empty

getFileName

public java.lang.String getFileName()

setFileName

public void setFileName(java.lang.String fileName)

setDatasetSelected

public uk.ac.diamond.scisoft.analysis.dataset.AbstractDataset setDatasetSelected(java.lang.String name,
                                                                                 boolean clearOthers)
Thread safe

Parameters:
name -

getMetaData

public uk.ac.diamond.scisoft.analysis.io.IMetaData getMetaData()

getPlottingSystem

public AbstractPlottingSystem getPlottingSystem()
Description copied from interface: IDatasetProvider
May return null, if data not plotting

Specified by:
getPlottingSystem in interface IDatasetProvider
Returns: