jitas.util
Class Settings

java.lang.Object
  extended by jitas.util.Settings

public class Settings
extends java.lang.Object

Settings class is mainly used to configure the paths to different components of a Tutor. Currently it uses a singleton-style getSettings method for access by other classes.

Version:
10 July 2007
Author:
DeathMarch (c314g2)

Method Summary
 java.lang.String getAlgorithmFileName(java.lang.String nameOfDomain)
          Get the path to the specific domain Problem Selection Algorithm file
 java.lang.String getAllDomainsFileName()
          Get the name of the file that contains all the domain names
 java.lang.String getFeedbackObjectFile(java.lang.String nameOfDomain)
          Get the name of the jar containing the custom feedback object
 java.lang.String getFullPathToAllDomains()
          Get the full path to AllDomains xml file
static Settings getInstance()
          Get an instance of a Settings object
 java.lang.String getJESSParserFile(java.lang.String nameOfDomain)
          Get the name of the jar containing the custom JESSParser object
 java.lang.String getRootPath()
          Get the root path of where the documents are
 java.lang.String getSemanticConstraintsPath(java.lang.String nameOfDomain)
          Get the full path to a semantic constraint file of a specific domain
 java.lang.String getSemanticConstraintsPath(java.lang.String nameOfDomain, java.lang.String subDomainName)
          Get the full path to a semantic constraint file of a specific domain and subdomain
 java.lang.String getStudentFileName()
          Gets the global student details file
 java.lang.String getStudentModelPath(java.lang.String domainName)
           
 java.lang.String getStudentModelsFileName()
          Get the file name for the student models
 java.lang.String getStudentPath()
          Gets the global student details file path.
 java.lang.String getSyntaxConstraintsPath(java.lang.String nameOfDomain)
          Get the full path to a syntax constraint file of a specific domain
 java.lang.String getSyntaxConstraintsPath(java.lang.String nameOfDomain, java.lang.String subDomainName)
          Get the full path to a syntax constraint file of a specific domain and subdomain
 void setRootPath(java.lang.String s)
          Set the root path of all the docs related to the domain
 void setStudentFileName(java.lang.String studentFileName)
          Sets the global student details file
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static Settings getInstance()
Get an instance of a Settings object

Returns:
An instance of a Settings object

getAllDomainsFileName

public java.lang.String getAllDomainsFileName()
Get the name of the file that contains all the domain names

Returns:
The file name

setRootPath

public void setRootPath(java.lang.String s)
Set the root path of all the docs related to the domain

Parameters:
s - The root path

getRootPath

public java.lang.String getRootPath()
Get the root path of where the documents are

Returns:
The root path

getFullPathToAllDomains

public java.lang.String getFullPathToAllDomains()
Get the full path to AllDomains xml file

Returns:
The full path to the file which contains all the domain names

getSemanticConstraintsPath

public java.lang.String getSemanticConstraintsPath(java.lang.String nameOfDomain)
Get the full path to a semantic constraint file of a specific domain

Parameters:
nameOfDomain - The name of the domain which requires its constraint path
Returns:
The path to a specific domain constraint file

getSyntaxConstraintsPath

public java.lang.String getSyntaxConstraintsPath(java.lang.String nameOfDomain)
Get the full path to a syntax constraint file of a specific domain

Parameters:
nameOfDomain - The name of the domain which requires its constraint path
Returns:
The path to a specific domain constraint file

getSemanticConstraintsPath

public java.lang.String getSemanticConstraintsPath(java.lang.String nameOfDomain,
                                                   java.lang.String subDomainName)
Get the full path to a semantic constraint file of a specific domain and subdomain

Parameters:
nameOfDomain - The name of the domain which requires its constraint path
subDomainName - The name of the subdomain
Returns:
The path to a specific domain constraint file

getSyntaxConstraintsPath

public java.lang.String getSyntaxConstraintsPath(java.lang.String nameOfDomain,
                                                 java.lang.String subDomainName)
Get the full path to a syntax constraint file of a specific domain and subdomain

Parameters:
nameOfDomain - The name of the domain which requires its constraint path
subDomainName - The name of the subdomain
Returns:
The path to a specific domain constraint file

getStudentFileName

public java.lang.String getStudentFileName()
Gets the global student details file

Returns:
the name of the global student details file

setStudentFileName

public void setStudentFileName(java.lang.String studentFileName)
Sets the global student details file

Parameters:
studentFileName - the name of the global student details file

getStudentPath

public java.lang.String getStudentPath()
Gets the global student details file path.

Returns:
the path to the global student details file

getAlgorithmFileName

public java.lang.String getAlgorithmFileName(java.lang.String nameOfDomain)
Get the path to the specific domain Problem Selection Algorithm file

Parameters:
nameOfDomain - The name of the domain
Returns:
the path to the specific domain Problem Selection Algorithm file

getFeedbackObjectFile

public java.lang.String getFeedbackObjectFile(java.lang.String nameOfDomain)
Get the name of the jar containing the custom feedback object

Parameters:
nameOfDomain - The name of the domain
Returns:
The name of the jar containing the custom feedback object

getJESSParserFile

public java.lang.String getJESSParserFile(java.lang.String nameOfDomain)
Get the name of the jar containing the custom JESSParser object

Parameters:
nameOfDomain - The name of the domain
Returns:
The name of the jar containing the custom JESSParser object

getStudentModelsFileName

public java.lang.String getStudentModelsFileName()
Get the file name for the student models

Returns:
Student models file name

getStudentModelPath

public java.lang.String getStudentModelPath(java.lang.String domainName)