ucl.physiol.neuroconstruct.project
Class ProjectStructure

java.lang.Object
  ucl.physiol.neuroconstruct.project.ProjectStructure

public class ProjectStructure
extends Object

Class defining, and if necessary creating, project directories, etc.

Author:

Padraig Gleeson

Field Summary

static String	JAVA_OBJ_FORMAT
static String	JAVA_XML_FORMAT
static String	NC_HOME_ENV_VAR
static String	neuroMLPyUtilsDir
static String	neuronPyUtilsDir
static String	PROJ_QUICK_SAVE
static String	PROJ_SVN_SAVE
static String	pynnUtilsDir

Constructor Summary

ProjectStructure()

Method Summary

static int	compareVersions(String currAppVersion, String projFileVersion)
static File	findProjectFile(File projectMainDir)
static void	findProjectFile(File projectMainDir, ArrayList<File> projFiles)
static File	getCellMechanismDir(File projectDir)
static File	getCellMechanismDir(File projectDir, boolean createIfNotFound)
static File	getCellProcessesDir(File projectDir, boolean createIfNotFound)
static File	getChannelml2Neuroml2File()
static File	getCMLExamplesDir()
static File	getCMLTemplatesDir()
static String	getDataSetExtension() Just in case I decide to change the extension...
static File	getDataSetsDir(File projectDir)
static File	getDefaultnCProjectsDir()
static File	getDirForCellMechFiles(Project project, String cellMechName)
static File	getDirForCellMechFiles(Project project, String cellMechName, boolean createIfNotFound)
static File	getDirForSimFiles(String simRef, Project project)
static File	getFileBasedCellProcessesDir(File projectDir, boolean createIfNotFound)
static String	getGeneralSettingsFilename()
static File	getGenesisCodeDir(File projectDir)
static File	getGenesisTemplatesDir()
static File	getGenesisUtilsFile()
static File	getGenesisWinScript()
static File	getGlobalIgorNeuroMaticDir()
static File	getGlobalMatlabOctaveDir()
static File	getGlossaryHtmlFile()
static String	getHDF5FileExtension()
static File	getHelpImportFile()
static File	getHelpMenuFile()
static File	getImportedMorphologiesDir(File projectDir, boolean createIfNotFound)
static String	getJavaObjFileExtension()
static String	getJavaXMLFileExtension() Just in case I decide to change the extension...
static File	getMainHelpFile()
static String	getMatplotlibEpsFilename()
static File	getModTemplatesDir()
static File	getMooseCodeDir(File projectDir)
static String	getMorphMLFileExtension() Just in case I decide to change the extension...
static File	getMorphologiesDir(File projectDir)
static File	getnCExamplesDir()
static File	getnCHome()
static File	getnCModelsDir()
static File	getNeosimCodeDir(File projectDir)
static String	getNeuConRecentFilesFilename()
static File	getNeuroML2Dir()
static String	getNeuroMLCompressedFileExtension()
static File	getNeuroMLDir(File projectDir)
static String	getNeuroMLFileExtension()
static File	getNeuroMLSchemataDir()
static File	getNeuronCellCheckFile()
static File	getNeuronCodeDir(File projectDir)
static File	getNeuronUtilsFile()
static File	getNeuronUtilsWinModCompileFile()
static String	getNewProjectFileExtension()
static String	getNewProjectZipFileExtension()
static String	getNmodlEditRecentFilesFilename()
static String	getOldProjectFileExtension()
static String	getOldProjectZipFileExtension()
static File	getOsbProjsDir()
static SimpleFileFilter	getProjectFileFilter()
static File	getProjIgorNeuroMaticDir(File projectDir, boolean createIfNotFound)
static String	getProjIgorNeuroMaticName(File projectDir)
static File	getProjMatlabOctaveDir(File projectDir, boolean createIfNotFound)
static String	getProjMatlabOctaveDirName(File projectDir)
static File	getPsicsCodeDir(File projectDir)
static File	getPynnCodeDir(File projectDir)
static File	getPynnUtilsDir(File projectDir)
static File	getPythonNeuroMLDir(File projectDir)
static File	getPythonNeuroMLUtilsDir(File projectDir)
static File	getPythonNeuronUtilsDir(File projectDir)
static File	getPythonScriptsDir(File projectDir, boolean createIfNotFound)
static File	getRelNotesFile()
static File	getSavedNetworksDir(File projectDir)
static File	getSbml2NeuronFile()
static File	getSimulationsDir(File projectDir)
static File	getToolTipFile()
static String	getUpdateCheckUrl()
static String	getXMLFileExtension()
static File	getXMLTemplatesDir()
static String	getZippedDataSetExtension() Just in case I decide to change the extension...
static SimpleFileFilter	getZippedProjectFileFilter()
static void	main(String[] args)

Methods inherited from class java.lang.Object

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

Field Detail

JAVA_XML_FORMAT

public static final String JAVA_XML_FORMAT

See Also:

Constant Field Values

JAVA_OBJ_FORMAT

public static final String JAVA_OBJ_FORMAT

See Also:

Constant Field Values

NC_HOME_ENV_VAR

public static final String NC_HOME_ENV_VAR

See Also:

Constant Field Values

PROJ_QUICK_SAVE

public static final String PROJ_QUICK_SAVE

See Also:

Constant Field Values

PROJ_SVN_SAVE

public static final String PROJ_SVN_SAVE

See Also:

Constant Field Values

neuroMLPyUtilsDir

public static String neuroMLPyUtilsDir

neuronPyUtilsDir

public static String neuronPyUtilsDir

pynnUtilsDir

public static String pynnUtilsDir

Constructor Detail

ProjectStructure

public ProjectStructure()

Method Detail

getnCHome

public static File getnCHome()

main

public static void main(String[] args)

compareVersions

public static int compareVersions(String currAppVersion,
                                  String projFileVersion)

Returns:

0 if versions identical, 1 if currAppVersion is more recent than projFileVersion, -1 if projFileVersion is more recent than currAppVersion, or if either version string isn't parsable

getDirForSimFiles

public static File getDirForSimFiles(String simRef,
                                     Project project)

getGeneralSettingsFilename

public static String getGeneralSettingsFilename()

getToolTipFile

public static File getToolTipFile()

getGlossaryHtmlFile

public static File getGlossaryHtmlFile()

getUpdateCheckUrl

public static String getUpdateCheckUrl()

getMainHelpFile

public static File getMainHelpFile()

getSbml2NeuronFile

public static File getSbml2NeuronFile()

getChannelml2Neuroml2File

public static File getChannelml2Neuroml2File()

getNeuroML2Dir

public static File getNeuroML2Dir()

getRelNotesFile

public static File getRelNotesFile()

getHelpMenuFile

public static File getHelpMenuFile()

getHelpImportFile

public static File getHelpImportFile()

getNeuronUtilsFile

public static File getNeuronUtilsFile()

getNeuronUtilsWinModCompileFile

public static File getNeuronUtilsWinModCompileFile()

getNeuronCellCheckFile

public static File getNeuronCellCheckFile()

getGenesisUtilsFile

public static File getGenesisUtilsFile()

getnCExamplesDir

public static File getnCExamplesDir()

getOsbProjsDir

public static File getOsbProjsDir()

getnCModelsDir

public static File getnCModelsDir()

getDefaultnCProjectsDir

public static File getDefaultnCProjectsDir()

getNeuronCodeDir

public static File getNeuronCodeDir(File projectDir)

getGenesisCodeDir

public static File getGenesisCodeDir(File projectDir)

getMooseCodeDir

public static File getMooseCodeDir(File projectDir)

getPsicsCodeDir

public static File getPsicsCodeDir(File projectDir)

getPynnCodeDir

public static File getPynnCodeDir(File projectDir)

getNeosimCodeDir

public static File getNeosimCodeDir(File projectDir)

getNeuroMLDir

public static File getNeuroMLDir(File projectDir)

getPythonNeuroMLDir

public static File getPythonNeuroMLDir(File projectDir)

getPythonNeuroMLUtilsDir

public static File getPythonNeuroMLUtilsDir(File projectDir)

getPythonNeuronUtilsDir

public static File getPythonNeuronUtilsDir(File projectDir)

getPynnUtilsDir

public static File getPynnUtilsDir(File projectDir)

getSavedNetworksDir

public static File getSavedNetworksDir(File projectDir)

getDataSetsDir

public static File getDataSetsDir(File projectDir)

getPythonScriptsDir

public static File getPythonScriptsDir(File projectDir,
                                       boolean createIfNotFound)

getImportedMorphologiesDir

public static File getImportedMorphologiesDir(File projectDir,
                                              boolean createIfNotFound)

getFileBasedCellProcessesDir

public static File getFileBasedCellProcessesDir(File projectDir,
                                                boolean createIfNotFound)

getCellProcessesDir

public static File getCellProcessesDir(File projectDir,
                                       boolean createIfNotFound)

getCellMechanismDir

public static File getCellMechanismDir(File projectDir)

getDirForCellMechFiles

public static File getDirForCellMechFiles(Project project,
                                          String cellMechName)

getDirForCellMechFiles

public static File getDirForCellMechFiles(Project project,
                                          String cellMechName,
                                          boolean createIfNotFound)

getGlobalMatlabOctaveDir

public static File getGlobalMatlabOctaveDir()

getGlobalIgorNeuroMaticDir

public static File getGlobalIgorNeuroMaticDir()

getCellMechanismDir

public static File getCellMechanismDir(File projectDir,
                                       boolean createIfNotFound)

getMorphologiesDir

public static File getMorphologiesDir(File projectDir)

getSimulationsDir

public static File getSimulationsDir(File projectDir)

getProjMatlabOctaveDir

public static File getProjMatlabOctaveDir(File projectDir,
                                          boolean createIfNotFound)

getProjMatlabOctaveDirName

public static String getProjMatlabOctaveDirName(File projectDir)

getProjIgorNeuroMaticDir

public static File getProjIgorNeuroMaticDir(File projectDir,
                                            boolean createIfNotFound)

getProjIgorNeuroMaticName

public static String getProjIgorNeuroMaticName(File projectDir)

getModTemplatesDir

public static File getModTemplatesDir()

getXMLTemplatesDir

public static File getXMLTemplatesDir()

getCMLTemplatesDir

public static File getCMLTemplatesDir()

getNeuroMLSchemataDir

public static File getNeuroMLSchemataDir()

getCMLExamplesDir

public static File getCMLExamplesDir()

getGenesisWinScript

public static File getGenesisWinScript()

getGenesisTemplatesDir

public static File getGenesisTemplatesDir()

getNeuConRecentFilesFilename

public static String getNeuConRecentFilesFilename()

getNmodlEditRecentFilesFilename

public static String getNmodlEditRecentFilesFilename()

getOldProjectFileExtension

public static String getOldProjectFileExtension()

getNewProjectFileExtension

public static String getNewProjectFileExtension()

getProjectFileFilter

public static SimpleFileFilter getProjectFileFilter()

getZippedProjectFileFilter

public static SimpleFileFilter getZippedProjectFileFilter()

findProjectFile

public static File findProjectFile(File projectMainDir)

findProjectFile

public static void findProjectFile(File projectMainDir,
                                   ArrayList<File> projFiles)

getMorphMLFileExtension

public static String getMorphMLFileExtension()

Just in case I decide to change the extension...

Returns:

The extension of MorphML files as stored by the application

getNeuroMLFileExtension

public static String getNeuroMLFileExtension()

Returns:

The extension of NeuroML files as stored by the application

getXMLFileExtension

public static String getXMLFileExtension()

Returns:

The default extension of XML files

getHDF5FileExtension

public static String getHDF5FileExtension()

Returns:

The extension of HDF5 files as stored by the application

getNeuroMLCompressedFileExtension

public static String getNeuroMLCompressedFileExtension()

Returns:

The extension of zipped NeuroML files as stored by the application

getMatplotlibEpsFilename

public static String getMatplotlibEpsFilename()

getJavaXMLFileExtension

public static String getJavaXMLFileExtension()

Just in case I decide to change the extension...

Returns:

The extension of Java XML files as stored by the application

getJavaObjFileExtension

public static String getJavaObjFileExtension()

Returns:

The extension of Java serialized object files as stored by the application

getOldProjectZipFileExtension

public static String getOldProjectZipFileExtension()

getNewProjectZipFileExtension

public static String getNewProjectZipFileExtension()

getDataSetExtension

public static String getDataSetExtension()

Just in case I decide to change the extension...

Returns:

The extension of a file storing a data set

getZippedDataSetExtension

public static String getZippedDataSetExtension()

Just in case I decide to change the extension...

Returns:

The extension of a file storing a zipped up data set