Class LocalProjectProperties

java.lang.Object

ca.phon.project.LocalProjectProperties

All Implemented Interfaces:

ProjectProperties

public final class LocalProjectProperties
extends Object
implements ProjectProperties

Extension for LocalProjects. This class will be used to load, access, modify and save project properties in the form of a JSON object.

Nested Class Summary

Nested classes/interfaces inherited from interface ca.phon.project.ProjectProperties

ProjectProperties.PropertyModifier

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CORPUS_MEDIAFOLDER_PROP	Deprecated.
static final String	PROJECT_MEDIAFOLDER_PROP	Deprecated.
static final String	PROJECT_MEDIAFOLDERS_KEY
static final String	PROJECT_NAME_KEY
static final String	PROJECT_NAME_PROP	Deprecated.
static final String	PROJECT_UUID_KEY
static final String	PROJECT_UUID_PROP	Deprecated.

Constructor Summary

Constructors

Constructor	Description
LocalProjectProperties(LocalProject localProject)

Method Summary

Modifier and Type	Method	Description
org.json.JSONObject	getProjectJson()	Get the project JSON object
protected void	loadProjectJson(File projectJsonFile)	Load project JSON data from a provided file
void	modifyProjectJson(ProjectProperties.PropertyModifier modifier)	Atomically modify the project JSON object
void	saveProjectJson()
protected void	saveProperties()	Deprecated.

Methods inherited from class java.lang.Object

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

Field Details

PROJECT_MEDIAFOLDER_PROP

@Deprecated
public static final String PROJECT_MEDIAFOLDER_PROP

Deprecated.

Media folders for project

See Also:

• Constant Field Values

PROJECT_MEDIAFOLDERS_KEY

public static final String PROJECT_MEDIAFOLDERS_KEY

See Also:

• Constant Field Values

CORPUS_MEDIAFOLDER_PROP

@Deprecated
public static final String CORPUS_MEDIAFOLDER_PROP

Deprecated.

See Also:

• Constant Field Values

PROJECT_NAME_PROP

@Deprecated
public static final String PROJECT_NAME_PROP

Deprecated.

Project name property

See Also:

• Constant Field Values

PROJECT_NAME_KEY

public static final String PROJECT_NAME_KEY

See Also:

• Constant Field Values

PROJECT_UUID_PROP

@Deprecated
public static final String PROJECT_UUID_PROP

Deprecated.

Project UUID property

See Also:

• Constant Field Values

PROJECT_UUID_KEY

public static final String PROJECT_UUID_KEY

See Also:

• Constant Field Values

Constructor Details

LocalProjectProperties

public LocalProjectProperties(LocalProject localProject)

Method Details

getProjectJson

public org.json.JSONObject getProjectJson()

Get the project JSON object

Specified by:

getProjectJson in interface ProjectProperties

Returns:

modifyProjectJson

public void modifyProjectJson(ProjectProperties.PropertyModifier modifier)
                       throws IOException

Description copied from interface: ProjectProperties

Atomically modify the project JSON object

Specified by:

modifyProjectJson in interface ProjectProperties

Parameters:

modifier - function that receives current JSON and returns modified JSON

Throws:

IOException - on error

loadProjectJson

protected void loadProjectJson(File projectJsonFile)

Load project JSON data from a provided file

Parameters:

projectJsonFile -

saveProjectJson

public void saveProjectJson()
                     throws IOException

Throws:

IOException

saveProperties

@Deprecated
protected void saveProperties()
                       throws IOException

Deprecated.

Throws:

IOException