Class NeuroMLReader

java.lang.Object
org.episteme.core.io.AbstractResourceReader<NeuroMLDocument>
org.episteme.natural.biology.loaders.neuroml.NeuroMLReader
All Implemented Interfaces:
ResourceIO<NeuroMLDocument>, ResourceReader<NeuroMLDocument>
public class NeuroMLReader extends AbstractResourceReader<NeuroMLDocument>
NeuroML Reader for computational neuroscience models.

NeuroML is an XML-based format for representing neural network models including morphology, biophysics, and network connectivity.

Supported NeuroML v2 Elements:

  • Cell morphology (segments, segment groups)
  • Ion channels and synapses
  • Networks (populations, projections)
  • Inputs and stimuli

* @see NeuroML.org
Since:
1.0
Author:
Silvere Martin-Michiellot, Gemini AI (Google DeepMind)

  • Constructor Details

    • NeuroMLReader

      public NeuroMLReader()

  • Method Details

    • getResourcePath

      public String getResourcePath()
      Description copied from interface: ResourceIO
      Returns the base path where this resource is located.

    • getResourceType

      public Class<NeuroMLDocument> getResourceType()
      Description copied from interface: ResourceIO
      Returns the type of resource.

    • getName

      public String getName()
      Description copied from interface: ResourceIO
      Returns the display name of this resource handler. MUST be implemented with I18N support.
      Returns:
      the display name

    • getDescription

      public String getDescription()
      Description copied from interface: ResourceIO
      Returns a short description of this resource handler. MUST be implemented with I18N support.
      Returns:
      the description

    • getLongDescription

      public String getLongDescription()
      Description copied from interface: ResourceIO
      Returns a long description of this resource handler. MUST be implemented with I18N support.
      Returns:
      the long description

    • getCategory

      public String getCategory()
      Description copied from interface: ResourceIO
      Returns the category for grouping. MUST be implemented with I18N support.
      Returns:
      the category name

    • getSupportedVersions

      public String[] getSupportedVersions()
      Description copied from interface: ResourceIO
      Returns the supported versions of the format this reader/writer handles.

      Each implementation MUST override this method to declare which versions of the underlying format are supported. The returned array should contain version strings in the format's standard notation (e.g., "3.0", "2.1", "Level 3 Version 2").

      Examples:

      • MathML: {"3.0", "2.0"}
      • SBML: {"Level 3 Version 2", "Level 3 Version 1", "Level 2 Version 5"}
      • PhyloXML: {"1.10", "1.00"}

      Returns:
      array of supported version strings, never null (empty array if version-agnostic)

    • loadFromSource

      protected NeuroMLDocument loadFromSource(String resourceId) throws Exception
      Specified by:
      loadFromSource in class AbstractResourceReader<NeuroMLDocument>
      Throws:
      Exception

    • loadFromInputStream

      protected NeuroMLDocument loadFromInputStream(InputStream is, String id) throws Exception
      Overrides:
      loadFromInputStream in class AbstractResourceReader<NeuroMLDocument>
      Throws:
      Exception

    • read

      public NeuroMLDocument read(InputStream input) throws NeuroMLException
      Reads a NeuroML model from an input stream.
      Throws:
      NeuroMLException

    • read

      public NeuroMLDocument read(File file) throws NeuroMLException
      Reads a NeuroML model from a file.
      Throws:
      NeuroMLException