org.eclipse.january.dataset

## Interface IRemoteData

- All Superinterfaces:
    IFileConnection

      public interface IRemoteData
      extends IFileConnection

  This class provides access to remote data which may consist of more than one remote dataset. It provides meta information about the contents of the remote data which can be used to determine which remote dataset to open. It provides a convenience method for creating a remote dataset which must be connected when it is returned but must be disconnected or its parent IRemoteData disconnected at some point later to close the connection with the server.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `IDatasetConnector` | `createRemoteDataset(String datasetPath)` Create a remote dataset looking at the dataset path named.
    `Map<String,Object>` | `getTree()` Map of path to collection of attributes at that path.

    - ### Methods inherited from interface org.eclipse.january.dataset.IFileConnection

      `getPath, setPath`

- - ### Method Detail

    - #### getTree

          Map<String,Object> getTree()
                              throws Exception

      Map of path to collection of attributes at that path.
      Returns:
        NeXus meta-data objects in most instances.
      Throws:
        `Exception` - when cannot retrieve tree

    - #### createRemoteDataset

          IDatasetConnector createRemoteDataset(String datasetPath)
                                         throws Exception

      Create a remote dataset looking at the dataset path named. connect() before use and disconnect() after use must be performed.
      Parameters:
        `datasetPath` - path in tree to dataset
      Returns:
        IRemoteDataset
      Throws:
        `Exception` - when cannot connect to dataset

Copyright © 2014–2022 Eclipse Foundation. All rights reserved.