MdsDataProvider (MDSplus jScope 7.134.9 API)

java.lang.Object
- mds.provider.MdsDataProvider

All Implemented Interfaces:

AutoCloseable, DataProvider

Direct Known Subclasses:

AsdexDataProvider, FtuDataProvider, JetDataProvider, MdsDataProviderAsync, MdsDataProviderLocal, MdsDataProviderSsh, TsDataProvider
```
public class MdsDataProvider
extends Object
implements DataProvider
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface MdsDataProvider.AsyncDataSource

Nested Classes
Modifier and Type	Class and Description
`static interface`	`MdsDataProvider.AsyncDataSource`

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`connected`
`protected String`	`error`
`protected String`	`experiment`
`protected MdsConnection`	`mds`
`protected boolean`	`open`
`protected String`	`provider`
`protected long`	`shot`
`protected boolean`	`use_compression`
`protected int`	`var_idx`

Fields inherited from interface mds.wave.DataProvider
LOGIN_CANCEL, LOGIN_ERROR, LOGIN_OK

Constructor Summary

Constructors
Constructor and Description

MdsDataProvider()

MdsDataProvider(String provider)

MdsDataProvider(String exp, int s)

Constructors
Constructor and Description
`MdsDataProvider()`
`MdsDataProvider(String provider)`
`MdsDataProvider(String exp, int s)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addConnectionListener(ConnectionListener l)` Method AddConnectionListener is called by jScope after the instantiation of a DataProvider implementation, in order to be notified of the status of data transfer.
`void`	`addUpdateEventListener(UpdateEventListener l, String event_name)` Method AddUpdateEventListener is called by jScope when asynchronous update on event is defined.
`protected void`	`CheckConnection()`
`protected boolean`	`CheckOpen()`
`protected boolean`	`CheckOpen(String experiment, long shot, String defaultNode)`
`void`	`close()` Method Dispose is called by jScope each time a DataProvider is no more used.
`protected void`	`dispatchConnectionEvent(ConnectionEvent e)`
`void`	`enableAsyncUpdate(boolean enable)`
`protected void`	`finalize()`
`byte[]`	`GetAllFrames(String in_frame)`
`MdsDataProvider.AsyncDataSource`	`getAsynchSource()`
`byte[]`	`GetByteArray(String in)`
`byte[]`	`GetByteArray(String in, Vector<Descriptor> args)`
`protected MdsConnection`	`getConnection()`
`protected MdsConnection`	`getConnection(String arg)`
`double[]`	`GetDoubleArray(String in)`
`String`	`getError()` If an error is encountered in the evaluation of a signal (GetWaveData or GetResampledWaveData returning null or generating IOException), jScope calls ErrorString method to retrieve the description of the error just occurred.
`protected String`	`GetExperimentName(String in_frame)`
`double`	`getFloat(String in, int row, int col, int index)` Method GetFloat is called by jScope to evaluate x min, x max, y min, y max when defined in the stup data source popup form.
`float[]`	`GetFloatArray(String in)`
`byte[]`	`GetFrameAt(String in_frame, int frame_idx)`
`FrameData`	`getFrameData(String in_y, String in_x, float time_min, float time_max)` GetFrameData is called by jScope to retrieve and display a frame sequence.
`float[]`	`GetFrameTimes(String in_frame)`
`int[]`	`getIntArray(String in)`
`protected int[]`	`getNumDimensions(String in_y)`
`protected String`	`getProvider()`
`mds.provider.MdsDataProvider.RealArray`	`GetRealArray(String in)`
`long[]`	`getShots(String in, String experiment)` Evaluate the passed string to provide an array of shot numbers.
`String`	`getString(String _in, int row, int col, int index)` GetString is called by jScope to evaluate title, X label and Y label.
`String`	`getStringValue(String expr)`
`WaveData`	`getWaveData(String in, int row, int col, int index)` Method GetWaveData called by jScope when a waveform has to be evaluated and only the Y axis is defined.
`WaveData`	`getWaveData(String in_y, String in_x, int col, int row, int index)` Method GetWaveData called by jScope when a waveform has to be evaluated and both X and Y axis are defined.
`int`	`inquireCredentials(JFrame f, DataServerItem server_item)` Some DataProvider implemenations may require additional information (e.g.
`boolean`	`isBusy()` Can be used to check if provider is busy (helps scheduling).
`protected boolean`	`NotYetNumber(String in)`
`protected boolean`	`NotYetString(String in)`
`void`	`removeConnectionListener(ConnectionListener l)` Called by jScope when transfer notification is no more requested.
`void`	`removeUpdateEventListener(UpdateEventListener l, String event_name)` Method RemoveUpdateEventListeneris called by jScope when the display of a waveform panel is no more triggered by an event.
`protected void`	`resetPrevious()`
`void`	`setArgument(String arg)` As DataProvider implementations are instantiated by jScope by means of the Class.newInstance(), no arguments can be passed to the constructor method.
`void`	`SetCompression(boolean state)`
`void`	`setEnvironment(String in)` Defines the environment for data retrieval.
`boolean`	`SupportsCompression()`
`boolean`	`supportsTunneling()` Enable tunneling activation.
`void`	`update(String experiment, long shot)` Method Update is called by jScope to notify the experiment name and the shot number.
`void`	`Update(String experiment, long shot, boolean resetExperiment)`

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - provider
```
protected String provider
```
  - experiment
```
protected String experiment
```
  - shot
```
protected long shot
```
  - open
```
protected boolean open
```
  - connected
```
protected boolean connected
```
  - mds
```
protected final MdsConnection mds
```
  - error
```
protected String error
```
  - use_compression
```
protected boolean use_compression
```
  - var_idx
```
protected int var_idx
```
- Constructor Detail
  - MdsDataProvider
```
public MdsDataProvider()
```
  - MdsDataProvider
```
public MdsDataProvider(String provider)
```
  - MdsDataProvider
```
public MdsDataProvider(String exp,
                       int s)
```
- Method Detail
  - addConnectionListener
```
public void addConnectionListener(ConnectionListener l)
```
    Description copied from interface: DataProvider
    
    Method AddConnectionListener is called by jScope after the instantiation of a DataProvider implementation, in order to be notified of the status of data transfer. If a DataProvider implementation has to handle the transfer of large chunks of data (e.g. frame sequences) requiring a relatively long time, it should be able to communicate the current status of the transfer to jScope which displays then a status bar. To do this, the DataProvider implementation calls ConnectionListener's method processConnectionEvent, passing an istance of ConnectionEvent as argument. Class ConnectionEvent defines the following information:
    - int total_size: total size of the data to be transferred
    - int current_size: the size of the data transferred so far
    - String info: an additional information string which is displayed by jScope
    If the DataProvider implementation does not support transfer notification, method AddConnectionListener is empty.
    
    Specified by:
    
    addConnectionListener in interface DataProvider
    
    Parameters:
    
    l - The ConnectionListener which has to be notified by means of method processConnectionEvent(ConnenctionEvent)
    
    See Also:
    
    ConnectionListener, ConnectionEvent
  - addUpdateEventListener
```
public void addUpdateEventListener(UpdateEventListener l,
                                   String event_name)
                            throws IOException
```
    Description copied from interface: DataProvider
    
    Method AddUpdateEventListener is called by jScope when asynchronous update on event is defined. To connect data visualization to asynchronous event an event name has to be defined in the Update event field of the setup data form popup dialog. DataProvider implementations supporting asynchronous signal updating should notify event occurrence to all registered listeners by calling method processUpdateEvent(UpdateEvent e). UpdateEvent defines the following field, in addition to those defined in the AWTEvent superclass:
    - String name: the name of the event
    The possibility of connecting data display to asynchronous events is useful when jScope is used during data acquisition, for an automatic display update when a signal has been acquired. In this case the data acquisition system would generate an event when the signal has been acquired, and the DataProvider implementation would call method processUpdateEvent (defined in UpdateEventListener interface) to request the display update to jScope.
    If the DataProvider implementation does not support asynchronous events, the method is void
    
    Specified by:
    
    addUpdateEventListener in interface DataProvider
    
    Parameters:
    
    l - The passed instance of UpdateEventListener.
    
    event_name - The name of the event for which the UpdateEventListener is registering.
    
    Throws:
    
    IOException
    
    See Also:
    
    UpdateEventListener, UpdateEvent
  - CheckConnection
```
protected void CheckConnection()
                        throws IOException
```
    Throws:
    
    IOException
  - CheckOpen
```
protected boolean CheckOpen()
                     throws IOException
```
    Throws:
    
    IOException
  - CheckOpen
```
protected boolean CheckOpen(String experiment,
                            long shot,
                            String defaultNode)
                     throws IOException
```
    Throws:
    
    IOException
  - close
```
public void close()
```
    Description copied from interface: DataProvider
    
    Method Dispose is called by jScope each time a DataProvider is no more used. Unlike Object.finalize(), method Dispose is guaranteed to be called at the time the DataProvider implementation is no more used by jScope.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface DataProvider
  - dispatchConnectionEvent
```
protected void dispatchConnectionEvent(ConnectionEvent e)
```
  - enableAsyncUpdate
```
public void enableAsyncUpdate(boolean enable)
```
  - finalize
```
protected void finalize()
```
    Overrides:
    
    finalize in class Object
  - GetAllFrames
```
public byte[] GetAllFrames(String in_frame)
                    throws IOException
```
    Throws:
    
    IOException
  - getAsynchSource
```
public MdsDataProvider.AsyncDataSource getAsynchSource()
```
  - GetByteArray
```
public byte[] GetByteArray(String in)
                    throws IOException
```
    Throws:
    
    IOException
  - GetByteArray
```
public byte[] GetByteArray(String in,
                           Vector<Descriptor> args)
                    throws IOException
```
    Throws:
    
    IOException
  - getConnection
```
protected MdsConnection getConnection()
```
  - getConnection
```
protected MdsConnection getConnection(String arg)
```
  - GetDoubleArray
```
public double[] GetDoubleArray(String in)
                        throws IOException
```
    Throws:
    
    IOException
  - getError
```
public String getError()
```
    Description copied from interface: DataProvider
    
    If an error is encountered in the evaluation of a signal (GetWaveData or GetResampledWaveData returning null or generating IOException), jScope calls ErrorString method to retrieve the description of the error just occurred.
    
    Specified by:
    
    getError in interface DataProvider
    
    Returns:
    
    A verbose description of the last error.
  - GetExperimentName
```
protected String GetExperimentName(String in_frame)
```
  - getFloat
```
public double getFloat(String in,
                       int row,
                       int col,
                       int index)
                throws IOException
```
    Description copied from interface: DataProvider
    
    Method GetFloat is called by jScope to evaluate x min, x max, y min, y max when defined in the stup data source popup form. The argument is in fact the string typed by the user in the form. In its simplest implementation, method GetFloat converts the string into a float value and returns it. Other data providers, such as MdsDataProvider, evaluate, possibly remotely, the passed string which may therefore be represented by an expression.
    
    Specified by:
    
    getFloat in interface DataProvider
    
    Parameters:
    
    in - The specification of the value.
    
    Returns:
    
    The evaluated value.
    
    Throws:
    
    IOException
  - GetFloatArray
```
public float[] GetFloatArray(String in)
                      throws IOException
```
    Throws:
    
    IOException
  - GetFrameAt
```
public byte[] GetFrameAt(String in_frame,
                         int frame_idx)
                  throws IOException
```
    Throws:
    
    IOException
  - getFrameData
```
public FrameData getFrameData(String in_y,
                              String in_x,
                              float time_min,
                              float time_max)
                       throws IOException
```
    Description copied from interface: DataProvider
    
    GetFrameData is called by jScope to retrieve and display a frame sequence. The frame sequence is returned by means of an object implementing the FrameData interface.
    
    Specified by:
    
    getFrameData in interface DataProvider
    
    Parameters:
    
    in_y - The frame sequence specification as defined in the frames field of the setup data popup dialog
    
    in_x - The definition of the time specification for the frame list as defined in the times field of the setup data popup dialog.
    
    time_min - Initial considered time for the frame sequence.
    
    time_max - Final considered time for the frame sequence.
    
    Returns:
    
    An implementation of the FrameData interface representing the corresponding frame sequence
    
    Throws:
    
    IOException
    
    See Also:
    
    FrameData
  - GetFrameTimes
```
public float[] GetFrameTimes(String in_frame)
```
  - getIntArray
```
public int[] getIntArray(String in)
                  throws IOException
```
    Throws:
    
    IOException
  - getNumDimensions
```
protected int[] getNumDimensions(String in_y)
                          throws IOException
```
    Throws:
    
    IOException
  - getProvider
```
protected String getProvider()
```
  - GetRealArray
```
public mds.provider.MdsDataProvider.RealArray GetRealArray(String in)
                                                    throws IOException
```
    Throws:
    
    IOException
  - getShots
```
public long[] getShots(String in,
                       String experiment)
                throws IOException
```
    Description copied from interface: DataProvider
    
    Evaluate the passed string to provide an array of shot numbers.
    
    Specified by:
    
    getShots in interface DataProvider
    
    Parameters:
    
    in - The shot(s) specification as typed in the "Shot" field of jScope panel
    
    Throws:
    
    IOException
  - getString
```
public String getString(String _in,
                        int row,
                        int col,
                        int index)
                 throws IOException
```
    Description copied from interface: DataProvider
    
    GetString is called by jScope to evaluate title, X label and Y label. These labels are defined as string in the Setup data source popup form. In the simplest case labels are exactly the same as defined, and therefore GetString simply returns its argument. In any case the data provider is free to interpret differently the argument.
    
    Specified by:
    
    getString in interface DataProvider
    
    Parameters:
    
    _in - The specification of the label or title.
    
    Returns:
    
    The evaluated label or title.
    
    Throws:
    
    IOException
  - getStringValue
```
public String getStringValue(String expr)
                      throws IOException
```
    Throws:
    
    IOException
  - getWaveData
```
public WaveData getWaveData(String in,
                            int row,
                            int col,
                            int index)
```
    Description copied from interface: DataProvider
    
    Method GetWaveData called by jScope when a waveform has to be evaluated and only the Y axis is defined. In this case jScope assumes that the specification is enough and it is up to the data provider implementation to retrieve X and Y axis. The evaluated signal is not directly returned as a vector, rather as a object implementing the WaveData interface.
    
    Specified by:
    
    getWaveData in interface DataProvider
    
    Parameters:
    
    in - The specification of the signal, typed in the Y axis field of the setup data source popup form, or in the lower right window of jScope.
    
    row - Row number of the corresponding panel
    
    col - Column number of the corresponding panel
    
    index - Index the corresponding panel
    
    Returns:
    
    The evaluated signal embedded in a WaveData object, or null if an error is encountered.
    
    See Also:
    
    WaveData
  - getWaveData
```
public WaveData getWaveData(String in_y,
                            String in_x,
                            int col,
                            int row,
                            int index)
```
    Description copied from interface: DataProvider
    
    Method GetWaveData called by jScope when a waveform has to be evaluated and both X and Y axis are defined. The evaluated signal is not directly treturned as a vector, rather as a object implementing the WaveData interface. jScope the uses the returned object to retieve X and Y axis.
    
    Specified by:
    
    getWaveData in interface DataProvider
    
    Parameters:
    
    in_y - Y axis specification as typed in the setup data source popupo dialog.
    
    in_x - X axis specification as typed in the setup data source popupo dialog.
    
    col - Row number of the corresponding panel
    
    row - Column number of the corresponding panel
    
    index - Index the corresponding panel
    
    Returns:
    
    The evaluated signal, embedded in a WaveData object, or null if an error is encountered.
    
    See Also:
    
    WaveData
  - inquireCredentials
```
public int inquireCredentials(JFrame f,
                              DataServerItem server_item)
```
    Description copied from interface: DataProvider
    
    Some DataProvider implemenations may require additional information (e.g. username and password) typed by users in a login form. As jScope does not make any assumption on this kind of information it is up to the DataProvider implementation to realize such a form (if any). For this reason jScope calls method InquireCredential passing as argument the container JFrame. InquireCredentials may return:
    -DataProvider.LOGIN_OK if the DataProvider has been succesfully validated
    -DataProvider.LOGIN_ERROR if the DataProvided did not succeed in validation
    -DataProvider.LOGIN_CANCEL if the login proess has been aborted by user (usually pressing
    a cancel button)
    Only in the first case jScope will proceede with the usega of the DataProvider implementation. In the secon case a warning dialog is shown, and in the third case the DataProvider is simply discarded.
    
    Specified by:
    
    inquireCredentials in interface DataProvider
    
    Parameters:
    
    f - The container Frame.
    
    Returns:
    
    The status of the DataProvider specific validation process
  - isBusy
```
public boolean isBusy()
```
    Description copied from interface: DataProvider
    
    Can be used to check if provider is busy (helps scheduling).
    
    Specified by:
    
    isBusy in interface DataProvider
    
    Returns:
    
    true is busy.
  - NotYetNumber
```
protected boolean NotYetNumber(String in)
```
  - NotYetString
```
protected boolean NotYetString(String in)
```
  - removeConnectionListener
```
public void removeConnectionListener(ConnectionListener l)
```
    Description copied from interface: DataProvider
    
    Called by jScope when transfer notification is no more requested. Empty if the DataProvider implementation does not support transfer status notification.
    
    Specified by:
    
    removeConnectionListener in interface DataProvider
    
    Parameters:
    
    l - The previously registered ConnectionListener.
    
    See Also:
    
    ConnectionListener
  - removeUpdateEventListener
```
public void removeUpdateEventListener(UpdateEventListener l,
                                      String event_name)
                               throws IOException
```
    Description copied from interface: DataProvider
    
    Method RemoveUpdateEventListeneris called by jScope when the display of a waveform panel is no more triggered by an event.
    
    Specified by:
    
    removeUpdateEventListener in interface DataProvider
    
    Parameters:
    
    l - The instance of UpdateEventListener previously registered.
    
    event_name - The event to which the listener was previously registered.
    
    Throws:
    
    IOException
    
    See Also:
    
    UpdateEventListener
  - resetPrevious
```
protected void resetPrevious()
```
  - setArgument
```
public void setArgument(String arg)
                 throws IOException
```
    Description copied from interface: DataProvider
    
    As DataProvider implementations are instantiated by jScope by means of the Class.newInstance(), no arguments can be passed to the constructor method. If an additional argument is required for the proper initialization of the DataProvider implementation (e.g. the ip address for the MdsDataProvider), the argument, defined in the server_n.argument item of the property file is passed through method SetArgument called by jScope just after the DataProvider instantiation.
    
    Specified by:
    
    setArgument in interface DataProvider
    
    Parameters:
    
    arg - The argument passed to the DataProvider implementation.
    
    Throws:
    
    IOException
  - SetCompression
```
public void SetCompression(boolean state)
```
  - setEnvironment
```
public void setEnvironment(String in)
                    throws IOException
```
    Description copied from interface: DataProvider
    
    Defines the environment for data retrieval. Depending on the nature of the provider of data, some environment variable may be defined. For example the MdsDataProvider allows the definition of TDI variables which may be useful for configuring remote data access. jScope allows the definition of an arbitrary set of environment variable using the customize--public variables... option. As jScope does not make any assumption on the syntax of the defined variables, each variable definition is passed to the Data provider by means of the SetEnvironment method, whose argument is a String which defines name value pairs. If the DataProvider implementation does not support such a feature, it simply returns.
    
    Specified by:
    
    setEnvironment in interface DataProvider
    
    Parameters:
    
    in - The variable definition expressed as name value pair.
    
    Throws:
    
    IOException
  - SupportsCompression
```
public boolean SupportsCompression()
```
  - supportsTunneling
```
public boolean supportsTunneling()
```
    Description copied from interface: DataProvider
    
    Enable tunneling activation. Return False if no ssh tunneling available.
    
    Specified by:
    
    supportsTunneling in interface DataProvider
    
    Returns:
    
    Tunneling flag
  - update
```
public void update(String experiment,
                   long shot)
```
    Description copied from interface: DataProvider
    
    Method Update is called by jScope to notify the experiment name and the shot number. Update can be called several time by jScope for the same DataProvider implementation in the case user changes either the experiment name or the shot number.
    
    Specified by:
    
    update in interface DataProvider
    
    Parameters:
    
    experiment - The experiment name
  - Update
```
public void Update(String experiment,
                   long shot,
                   boolean resetExperiment)
```

Class MdsDataProvider

Nested Class Summary

Field Summary

Fields inherited from interface mds.wave.DataProvider

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

provider

experiment

shot

open

connected

mds

error

use_compression

var_idx

Constructor Detail

MdsDataProvider

MdsDataProvider

MdsDataProvider

Method Detail

addConnectionListener

addUpdateEventListener

CheckConnection

CheckOpen

CheckOpen

close

dispatchConnectionEvent

enableAsyncUpdate

finalize

GetAllFrames

getAsynchSource

GetByteArray

GetByteArray

getConnection

getConnection

GetDoubleArray

getError

GetExperimentName

getFloat

GetFloatArray

GetFrameAt

getFrameData

GetFrameTimes

getIntArray

getNumDimensions

getProvider

GetRealArray

getShots

getString

getStringValue

getWaveData

getWaveData

inquireCredentials

isBusy

NotYetNumber

NotYetString

removeConnectionListener

removeUpdateEventListener

resetPrevious

setArgument

SetCompression

setEnvironment

SupportsCompression

supportsTunneling

update

Update