org.corpus_tools.salt.common

Interface SaltProject

All Superinterfaces:

Serializable

All Known Implementing Classes:

SaltProjectImpl

public interface SaltProject
extends Serializable

The salt project is a kind of a super container for a Salt model. It contains a set of corpus structures, which could contain a set of document structures each. This makes the SaltProject object the entry point for a salt model. In case you have more than one salt project, you can name it by setName(String)

Author:

florian

Method Summary

Methods

Modifier and Type	Method and Description
void	addCorpusGraph(SCorpusGraph corpusGraph) Adds the passed SCorpusGraph object to the list of corpus graphs.
SCorpusGraph	createCorpusGraph() Creates a new corpus graph and adds it to the Salt project.
List<SCorpusGraph>	getCorpusGraphs() Returns all corpus structures contained in this project.
String	getName() Returns the name of this salt project.
void	loadCorpusStructure(org.eclipse.emf.common.util.URI saltProjectURI) Reads a saltProject.salt file and imports the contained corpus structure, without importing the document structure corresponding to the imported SDocument nodes.
void	loadSaltProject(org.eclipse.emf.common.util.URI saltProjectURI) Loads data from URI into this SaltProject object.
void	removeCorpusGraph(SCorpusGraph corpusGraph) Removes the passed SCorpusGraph object to the list of corpus graphs.
void	saveSaltProject(org.eclipse.emf.common.util.URI saltProjectURI) Persists this SaltProject object to the location given by the passed URI object as SaltXML.
void	setName(String name) Sets the name of this salt project.

Method Detail

getCorpusGraphs

List<SCorpusGraph> getCorpusGraphs()

Returns all corpus structures contained in this project.

Returns:

all contained corpus structures

addCorpusGraph

void addCorpusGraph(SCorpusGraph corpusGraph)

Adds the passed SCorpusGraph object to the list of corpus graphs.

Parameters:

corpusGraph - new corpus graph object

removeCorpusGraph

void removeCorpusGraph(SCorpusGraph corpusGraph)

Removes the passed SCorpusGraph object to the list of corpus graphs.

Parameters:

corpusGraph - new corpus graph object

getName

String getName()

Returns the name of this salt project. A name is optional.

Returns:

name of the project

setName

void setName(String name)

Sets the name of this salt project. A name is optional.

Parameters:

name - of the project

saveSaltProject

void saveSaltProject(org.eclipse.emf.common.util.URI saltProjectURI)

Persists this SaltProject object to the location given by the passed URI object as SaltXML.

Parameters:

saltProjectURI - the URI to the location to persist the project

loadSaltProject

void loadSaltProject(org.eclipse.emf.common.util.URI saltProjectURI)

Loads data from URI into this SaltProject object. Data in location saltProjectURI must be conform to SaltXML format.

This will load all document graphs into memory as well. If you only intend to load the corpus structure call loadCorpusStructure(org.eclipse.emf.common.util.URI) instead. Then you can load the single document graphs you are interested in with SDocument.loadDocumentGraph().

Parameters:

saltProjectURI - the URI to the location to load the project

loadCorpusStructure

void loadCorpusStructure(org.eclipse.emf.common.util.URI saltProjectURI)

Reads a saltProject.salt file and imports the contained corpus structure, without importing the document structure corresponding to the imported SDocument nodes.

Parameters:

saltProjectURI - the uri to the location of the folder containing the saltProject.salt file.

createCorpusGraph

SCorpusGraph createCorpusGraph()

Creates a new corpus graph and adds it to the Salt project.

Returns:

the new created Salt project