Package mgui.io

Interface InterfaceIO

All Superinterfaces:
IconObject
All Known Implementing Classes:
AmiraTractLoader, CaminoPipelineLoader, CaminoPipelineWriter, CaminoProjectLoader, CaminoProjectWriter, CaretAreaColourLoader, CaretAreaColourWriter, CaretMetricLoader, CaretPaintLoader, CaretPaintWriter, CaretSurfaceLoader, CaretSurfaceWriter, ColourMapLoader, ContinuousColourMapLoader, ContinuousColourMapWriter, CorticalNetworkMatrixLoader, DataSourceDriverLoader, DataSourceDriverWriter, DataSourceLoader, DataSourceWriter, DefaultMatrixFileLoader, DefaultMatrixFileWriter, DiscreteColourMapLoader, DiscreteColourMapWriter, DuffSurfaceLoader, ExportDataTableExcelWriter, ExportDataTableTextWriter, ExportDataTableWriter, FileLoader, FileWriter, FreesurferSurfaceLoader, FreesurferSurfaceWriter, FreesurferVertexDataLoader, FSLSurfaceLoader, FSLVolumeLoader, GiftiSurfaceLoader, GiftiSurfaceWriter, Graph3DWriter, GraphFileLoader, GraphFileWriter, GreyFileLoader, ImageFileLoader, ImageStackVideoWriter, ImportDataTableLoader, ImportDataTableTextLoader, InterfaceShapeLoader, InterfaceShapeWriter, InterfileLoader, JsonFileLoader, JsonFileWriter, MatrixFileLoader, MatrixFileWriter, MatrixTransformLoader, Mesh3DLoader, Mesh3DWriter, MincSurfaceDataLoader, MincSurfaceDataWriter, MincSurfaceLoader, MincSurfaceWriter, MincTransformLoader, MricroLutLoader, MricroLutWriter, NameMapLoader, NameMapWriter, NiftiVolumeLoader, NiftiVolumeWriter, PajekGraphLoader, PipelineLoader, PipelineProcessLibraryLoader, PipelineProcessLibraryWriter, PipelineWriter, Point2DShapeLoader, PointSet2DLoader, PointSet3DDataLoader, PointSet3DLoader, PolygonSet3DLoader, RGBFileLoader, ShapeDataLoader, ShapeModel3DLoader, ShapeModel3DWriter, ShapeXmlLoader, ShapeXmlWriter, StlWriter, StringVectorLoader, SurfaceDataFileLoader, SurfaceDataFileWriter, SurfaceFileLoader, SurfaceFileWriter, TrackVisTractLoader, Vector3DFileLoader, VectorDataLoader, VectorSet3DLoader, VideoLoader, VideoWriter, VideoXMLLoader, View3DLoader, View3DWriter, VolFileLoader, VolumeFileLoader, VolumeFileWriter, WavefrontSurfaceLoader, WavefrontSurfaceWriter, WorkspaceWriter, WunilVolumeLoader, XMLWriter
public interface InterfaceIO
extends IconObject
Interface for all classes performing I/O operations. The emphasis of this class is:
  1. Provide a standard interface for input and output operations
  2. Allow I/O interfaces to be loaded at runtime in the the InterfaceEnvironment
  3. Provide complementarity for input and output operations; interfaces should specify their complement (writers have a complementary loader, and vice versa), and should also be specifiable by this complement
Since:
1.0
Version:
1.0
Author:
Andrew Reid

  • Method Details

    • getProgressMessage

      java.lang.String getProgressMessage()

    • getSuccessMessage

      java.lang.String getSuccessMessage()

    • getTitle

      java.lang.String getTitle()

    • setFile

      void setFile​(java.io.File file)

    • setURL

      void setURL​(java.net.URL url)

    • setOptions

      void setOptions​(InterfaceIOOptions options)
      Sets the InterfaceIOOptions specifying this I/O operation
      Parameters:
      options -

    • getOptions

      InterfaceIOOptions getOptions()
      Gets the InterfaceIOOptions specifying this I/O operation, if options have been set; otherwise returns null.
      Parameters:
      options -

    • getIOType

      InterfaceIOType getIOType()
      Returns the registered IO type for this object, if one exists
      Returns:
      the registered IO type, or null if none exists

    • getSupportedObjects

      java.util.ArrayList<java.lang.Class<?>> getSupportedObjects()
      Returns a list of classes for objects which are supported by this I/O interface
      Returns:

    • getComplementIOType

      InterfaceIOType getComplementIOType()
      Returns an InterfaceIOType specifying the InterfaceIO which performs the complementary operation to this one. I.e., loaders should specify their complementary writers.
      Returns:
      The complementary class, or null if none is defined