org.corpus_tools.salt.common.SaltProject Interface Reference

The salt project is a kind of a super container for a Salt model. More...

Inherits Serializable.

Inherited by org.corpus_tools.salt.common.impl.SaltProjectImpl.

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

Detailed Description

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

Member Function Documentation

addCorpusGraph()

void org.corpus_tools.salt.common.SaltProject.addCorpusGraph

(

SCorpusGraph

corpusGraph

)

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

Parameters

corpusGraph

new corpus graph object

Implemented in org.corpus_tools.salt.common.impl.SaltProjectImpl.

createCorpusGraph()

SCorpusGraph org.corpus_tools.salt.common.SaltProject.createCorpusGraph

(

)

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

Returns

the new created Salt project

Implemented in org.corpus_tools.salt.common.impl.SaltProjectImpl.

getCorpusGraphs()

List<SCorpusGraph> org.corpus_tools.salt.common.SaltProject.getCorpusGraphs

(

)

Returns all corpus structures contained in this project.

Returns

all contained corpus structures

Implemented in org.corpus_tools.salt.common.impl.SaltProjectImpl.

getName()

String org.corpus_tools.salt.common.SaltProject.getName

(

)

Returns the name of this salt project.

A name is optional.

Returns

name of the project

Implemented in org.corpus_tools.salt.common.impl.SaltProjectImpl.

loadCorpusStructure()

void org.corpus_tools.salt.common.SaltProject.loadCorpusStructure

(

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.

Implemented in org.corpus_tools.salt.common.impl.SaltProjectImpl.

loadSaltProject()

void org.corpus_tools.salt.common.SaltProject.loadSaltProject

(

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

Implemented in org.corpus_tools.salt.common.impl.SaltProjectImpl.

removeCorpusGraph()

void org.corpus_tools.salt.common.SaltProject.removeCorpusGraph

(

SCorpusGraph

corpusGraph

)

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

Parameters

corpusGraph

new corpus graph object

Implemented in org.corpus_tools.salt.common.impl.SaltProjectImpl.

saveSaltProject()

void org.corpus_tools.salt.common.SaltProject.saveSaltProject

(

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

Implemented in org.corpus_tools.salt.common.impl.SaltProjectImpl.

setName()

void org.corpus_tools.salt.common.SaltProject.setName

(

String

name

)

Sets the name of this salt project.

A name is optional.

Parameters

name	of the project

Implemented in org.corpus_tools.salt.common.impl.SaltProjectImpl.