Package mgui.neuro.imaging.camino

Class CaminoProject

java.lang.Object
mgui.neuro.imaging.camino.CaminoProject
All Implemented Interfaces:
java.io.Serializable, XMLObject, IconObject
public class CaminoProject
extends java.lang.Object
implements IconObject, XMLObject, java.io.Serializable
See Also:
Serialized Form

  • Nested Class Summary

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

    XMLObject.XMLEncoding, XMLObject.XMLType

  • Field Summary

    Fields
    Modifier and Type Field Description
    java.lang.String name  
    java.util.ArrayList<InterfacePipeline> pipelines  
    java.io.File root_directory  
    java.util.ArrayList<java.lang.String> subdirs  
    java.lang.String subject_prefix  
    java.util.ArrayList<java.lang.String> subjects  

  • Constructor Summary

    Constructors
    Constructor Description
    CaminoProject​(java.lang.String name, java.io.File root_directory)  
    CaminoProject​(java.lang.String name, java.lang.String root_directory)  

  • Method Summary

    Modifier and Type Method Description
    void addPipeline​(InterfacePipeline pipeline)  
    boolean applySubdirs​(boolean remove)  
    boolean applySubjects​(boolean remove)  
    java.lang.String getDTD()
    Returns the Data Type Declaration (DTD) for this object's XML representation
    java.lang.String getLocalName()
    Returns the local name associated with this XML object.
    javax.swing.Icon getObjectIcon()
    Returns the Icon associated with this object.
    java.io.File getRootDirectory()  
    javax.swing.Icon getSelectedIcon()  
    java.lang.String getShortXML​(int tab)
    Returns a short XML representation of this object.
    javax.swing.tree.DefaultMutableTreeNode getTreeNode​(javax.swing.JTree tree)  
    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.
    void removePipeline​(InterfacePipeline pipeline)  
    void setSubdirs()  
    void setSubjects()  
    java.lang.String toString()  
    boolean updateFileSystem​(boolean remove)  
    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 java.lang.Object

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

  • Field Details

    • name

      public java.lang.String name

    • subject_prefix

      public java.lang.String subject_prefix

    • root_directory

      public java.io.File root_directory

    • pipelines

      public java.util.ArrayList<InterfacePipeline> pipelines

    • subjects

      public java.util.ArrayList<java.lang.String> subjects

    • subdirs

      public java.util.ArrayList<java.lang.String> subdirs

  • Constructor Details

    • CaminoProject

      public CaminoProject​(java.lang.String name, java.io.File root_directory)

    • CaminoProject

      public CaminoProject​(java.lang.String name, java.lang.String root_directory)

  • Method Details

    • getObjectIcon

      public javax.swing.Icon getObjectIcon()
      Description copied from interface: IconObject
      Returns the Icon associated with this object.
      Specified by:
      getObjectIcon in interface IconObject
      Returns:

    • getSelectedIcon

      public javax.swing.Icon getSelectedIcon()

    • applySubjects

      public boolean applySubjects​(boolean remove)

    • applySubdirs

      public boolean applySubdirs​(boolean remove)

    • updateFileSystem

      public boolean updateFileSystem​(boolean remove)

    • setSubjects

      public void setSubjects()

    • setSubdirs

      public void setSubdirs()

    • addPipeline

      public void addPipeline​(InterfacePipeline pipeline)

    • removePipeline

      public void removePipeline​(InterfacePipeline pipeline)

    • getRootDirectory

      public java.io.File getRootDirectory()

    • getTreeNode

      public javax.swing.tree.DefaultMutableTreeNode getTreeNode​(javax.swing.JTree tree)

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • handleXMLElementEnd

      public void handleXMLElementEnd​(java.lang.String localName)
      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

    • handleXMLElementStart

      public void handleXMLElementStart​(java.lang.String localName, org.xml.sax.Attributes attributes, XMLObject.XMLType type)
      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

    • handleXMLString

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

    • 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, 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) 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