Package mgui.io

Class InterfaceIOOptions

java.lang.Object
mgui.interfaces.InterfaceOptions
mgui.io.InterfaceIOOptions
All Implemented Interfaces:
InterfaceObject, NamedObject, TreeObject, CleanableObject, XMLObject
Direct Known Subclasses:
CaretAreaColourOutputOptions, CaretMetricOptions, CorticalNetworkMatrixInOptions, DefaultIOOptions, DiscreteColourMapInOptions, DiscreteColourMapOutOptions, ExportDataTableOptions, Graph3DOutputOptions, GraphInputOptions, GraphOutputOptions, ImportDataTableOptions, MatrixInOptions, MatrixOutOptions, NameMapInOptions, NameMapOutOptions, PipelineInputOptions, PipelineOutputOptions, PointSet3DDataInputOptions, ShapeDataInputOptions, ShapeInputOptions, ShapeModel3DInputOptions, ShapeOutputOptions, StringVectorInOptions, SurfaceDataInputOptions, SurfaceDataOutputOptions, SurfaceOutputOptions, Vector3DInputOptions, VideoInputOptions, VideoOutputOptions, View3DInputOptions, View3DOutputOptions, VolumeOutputOptions, XMLOutputOptions
public abstract class InterfaceIOOptions
extends InterfaceOptions
implements XMLObject
Extends InterfaceOptions specifically for I/O methods. This class should be used to specify parameters/variables/objects required for specific I/O operations. It also specifies a number of standard variables (e.g., a file/URL list) and abstract methods.
Since:
1.0
Version:
1.0
Author:
Andrew Reid

  • Nested Class Summary

    Nested classes/interfaces inherited from interface mgui.interfaces.xml.XMLObject

    XMLObject.XMLEncoding, XMLObject.XMLType

  • Constructor Summary

    Constructors
    Constructor Description
    InterfaceIOOptions()  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getDTD()
    Returns the Data Type Declaration (DTD) for this object's XML representation
    abstract javax.swing.JFileChooser getFileChooser()
    Returns a file chooser appropriate for this options instance
    abstract javax.swing.JFileChooser getFileChooser​(java.io.File file)
    Returns a file chooser appropriate for this options instance
    abstract java.io.File[] getFiles()
    Returns the list of files associated with this options instance
    java.lang.String getLocalName()
    Returns the local name associated with this XML object.
    java.lang.String getShortXML​(int tab)
    Returns a short XML representation of this object.
    java.lang.String getXML()
    Returns this object's XML representation as a single string.
    java.lang.String getXML​(int tab)
    Returns this object's XML representation as a single string.
    java.lang.String getXMLSchema()
    Returns the XML schema for this object's XML representation
    void handleXMLElementEnd​(java.lang.String localName)
    Handles the end of an XML element.
    void handleXMLElementStart​(java.lang.String localName, org.xml.sax.Attributes attributes, XMLObject.XMLType type)
    Handles the start of an XML element.
    void handleXMLString​(java.lang.String s)
    Handles a string within an XML element.
    abstract void setFiles​(java.io.File[] files)
    Sets the list of files associated with this options instance
    void setFromComplementaryOptions​(InterfaceIOOptions options)
    Sets the values of this object from those of options, defined for its complementary I/O interface.
    abstract void setObject​(InterfaceObject obj)
    Sets the object on which to perform an I/O operation
    void writeXML​(int tab, java.io.Writer writer)
    Writes the XML representation of this object to file.
    void writeXML​(int tab, java.io.Writer writer, ProgressUpdater progress_bar)
    Writes the XML representation of this object to file, as XMLType.Normal.
    void writeXML​(int tab, java.io.Writer writer, XMLOutputOptions options, ProgressUpdater progress_bar)
    Writes the XML representation of this object to file.

    Methods inherited from class mgui.interfaces.InterfaceOptions

    clean, destroy, getName, getTreeLabel, isDestroyed, issueTreeNode, setName, setTreeNode

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • InterfaceIOOptions

      public InterfaceIOOptions()

  • Method Details

    • getFiles

      public abstract java.io.File[] getFiles()
      Returns the list of files associated with this options instance
      Returns:

    • setFiles

      public abstract void setFiles​(java.io.File[] files)
      Sets the list of files associated with this options instance

    • getFileChooser

      public abstract javax.swing.JFileChooser getFileChooser()
      Returns a file chooser appropriate for this options instance
      Returns:

    • getFileChooser

      public abstract javax.swing.JFileChooser getFileChooser​(java.io.File file)
      Returns a file chooser appropriate for this options instance
      Parameters:
      file -
      Returns:

    • setObject

      public abstract void setObject​(InterfaceObject obj) throws java.lang.ClassCastException
      Sets the object on which to perform an I/O operation
      Parameters:
      obj -
      Throws:
      java.lang.ClassCastException - if obj is the wrong class for this options instance

    • setFromComplementaryOptions

      public void setFromComplementaryOptions​(InterfaceIOOptions options)
      Sets the values of this object from those of options, defined for its complementary I/O interface.
      Parameters:
      options -

    • getDTD

      public java.lang.String getDTD()
      Description copied from interface: XMLObject
      Returns the Data Type Declaration (DTD) for this object's XML representation

      See http://en.wikipedia.org/wiki/Document_Type_Definition for a description.

      Specified by:
      getDTD in interface XMLObject
      Returns:

    • getXMLSchema

      public java.lang.String getXMLSchema()
      Description copied from interface: XMLObject
      Returns the XML schema for this object's XML representation

      See http://en.wikipedia.org/wiki/XML_schema.

      Specified by:
      getXMLSchema in interface XMLObject
      Returns:

    • getXML

      public java.lang.String getXML()
      Description copied from interface: XMLObject
      Returns this object's XML representation as a single string. NOTE: this is not feasible for larger objects and containers, thus may not be implemented for these objects. Use the XMLObject.writeXML(int,java.io.Writer,mgui.io.standard.xml.XMLOutputOptions,mgui.interfaces.ProgressUpdater) functions to write larger objects to file.
      Specified by:
      getXML in interface XMLObject
      Returns:

    • getXML

      public java.lang.String getXML​(int tab)
      Description copied from interface: XMLObject
      Returns this object's XML representation as a single string. NOTE: this is not feasible for larger objects and containers, thus may not be implemented for these objects. Use the XMLObject.writeXML(int,java.io.Writer,mgui.io.standard.xml.XMLOutputOptions,mgui.interfaces.ProgressUpdater) functions to write larger objects to file.
      Specified by:
      getXML in interface XMLObject
      Parameters:
      tab - The number of tabs to place before the opening XML wrapper
      Returns:

    • handleXMLElementStart

      public void handleXMLElementStart​(java.lang.String localName, org.xml.sax.Attributes attributes, XMLObject.XMLType type) throws org.xml.sax.SAXException
      Description copied from interface: XMLObject
      Handles the start of an XML element.
      Specified by:
      handleXMLElementStart in interface XMLObject
      Parameters:
      localName - Local name of the element
      attributes - Set of element attributes
      type - The XMLType of this element
      Throws:
      org.xml.sax.SAXException

    • handleXMLElementEnd

      public void handleXMLElementEnd​(java.lang.String localName) throws org.xml.sax.SAXException
      Description copied from interface: XMLObject
      Handles the end of an XML element.
      Specified by:
      handleXMLElementEnd in interface XMLObject
      Parameters:
      localName - Local name of the element
      Throws:
      org.xml.sax.SAXException

    • handleXMLString

      public void handleXMLString​(java.lang.String s) throws org.xml.sax.SAXException
      Description copied from interface: XMLObject
      Handles a string within an XML element.
      Specified by:
      handleXMLString in interface XMLObject
      Parameters:
      s - String to handle
      Throws:
      org.xml.sax.SAXException

    • getLocalName

      public java.lang.String getLocalName()
      Description copied from interface: XMLObject
      Returns the local name associated with this XML object.
      Specified by:
      getLocalName in interface XMLObject
      Returns:

    • writeXML

      public void writeXML​(int tab, java.io.Writer writer, XMLOutputOptions options, ProgressUpdater progress_bar) throws java.io.IOException
      Description copied from interface: XMLObject
      Writes the XML representation of this object to file. The basic contract for this method is that it should not write a newline character at its start or end. The default format of XMLFormat.Ascii will be used.
      Specified by:
      writeXML in interface XMLObject
      Parameters:
      tab - The number of tabs to place before the XML text
      writer - The writer
      options - XMLOutputOptions defining the write parameters
      progress_bar - Optional progress updater (may be null)
      Throws:
      java.io.IOException

    • writeXML

      public void writeXML​(int tab, java.io.Writer writer, ProgressUpdater progress_bar) throws java.io.IOException
      Description copied from interface: XMLObject
      Writes the XML representation of this object to file, as XMLType.Normal. The default format of XMLFormat.Ascii will be used. The basic contract for this method is that it should not write a newline character at its start or end.
      Specified by:
      writeXML in interface XMLObject
      Parameters:
      tab - The number of tabs to place before the XML text
      writer - The writer
      progress_bar - Optional progress updater (may be null)
      Throws:
      java.io.IOException

    • writeXML

      public void writeXML​(int tab, java.io.Writer writer) throws java.io.IOException
      Description copied from interface: XMLObject
      Writes the XML representation of this object to file. The basic contract for this method is that it should not write a newline character at its start or end. The default format of XMLFormat.Ascii will be used.
      Specified by:
      writeXML in interface XMLObject
      Parameters:
      tab - The number of tabs to place before the XML text
      writer - The writer
      Throws:
      java.io.IOException

    • getShortXML

      public java.lang.String getShortXML​(int tab)
      Description copied from interface: XMLObject
      Returns a short XML representation of this object.
      Specified by:
      getShortXML in interface XMLObject
      Returns: