edu.swri.swiftvis
Interface DataSource

All Superinterfaces:
GraphElement, java.io.Serializable
All Known Subinterfaces:
Filter
All Known Implementing Classes:
AbstractMultipleSourceFilter, AbstractSingleSourceFilter, AbstractSource, BinaryPositionData, BinnedFilter, CoordConvertFilter, DiscardData, ElementTableEditor, EncounterData, FunctionFilter, GeneralData, GroupNumberingFilter, KeySelectionFilter, MergeFilter, MovieFilter, RegionSelectionFilter, SelectFilter, SequenceSource, SliceSelectionFilter, SortFilter, ThinningFilter, WakePeakFilter

public interface DataSource
extends GraphElement


Method Summary
 void addOutput(DataSink sink)
           
 DataElement getElement(int i)
          Returns the specified data element for this source.
 int getNumElements()
          Returns the number of data elements that this source has in it.
 int getNumOutputs()
           
 int getNumParameters()
           
 int getNumValues()
           
 DataSink getOutput(int which)
           
 java.lang.String getParameterDescription(int which)
          Tells you what a particular parameter is used for.
 java.lang.String getParameterName(int which, int paramVal)
          Tells you the text that should be used to describe a particular value of a given parameter.
 java.lang.String getValueDescription(int which)
          Tells you what a particular value is used for.
 void removeOutput(DataSink sink)
           
 boolean useParameterNameString(int which)
          If this returns true then the value of a parameter for this type should be listed as the strong value returned by getParameterName.
 
Methods inherited from interface edu.swri.swiftvis.GraphElement
clearData, copy, getBounds, getDescription, getPaint, getPropertiesPanel, relink, setBounds
 

Method Detail

addOutput

void addOutput(DataSink sink)

removeOutput

void removeOutput(DataSink sink)

getNumOutputs

int getNumOutputs()

getOutput

DataSink getOutput(int which)

getNumElements

int getNumElements()
Returns the number of data elements that this source has in it. I'm using this instead of an iterator because direct access is much more efficient when trying to make tables of data.

Returns:
The number of data elements in this source.

getElement

DataElement getElement(int i)
Returns the specified data element for this source. I'm using this instead of an iterator because direct access is much more efficient when trying to make tables of data.

Parameters:
i - Which data element to return. Should be between 0 and getNumElements()-1.
Returns:
The selected element.
Throws:
java.lang.ArrayIndexOutOfBoundsException - if the provided index is out of bounds.

getNumParameters

int getNumParameters()

getParameterDescription

java.lang.String getParameterDescription(int which)
Tells you what a particular parameter is used for.


useParameterNameString

boolean useParameterNameString(int which)
If this returns true then the value of a parameter for this type should be listed as the strong value returned by getParameterName. Otherwise just the number should be displayed.


getParameterName

java.lang.String getParameterName(int which,
                                  int paramVal)
Tells you the text that should be used to describe a particular value of a given parameter.


getNumValues

int getNumValues()

getValueDescription

java.lang.String getValueDescription(int which)
Tells you what a particular value is used for.