it.uniroma2.art.semanticturkey.project

Class ProjectManager

java.lang.Object

it.uniroma2.art.semanticturkey.project.ProjectManager

public class ProjectManager
extends Object

a manager/factory class for creating new projects, for retrieving existing ones or for accessing the loaded projects

Apart from project factoring, The ProjectManager allows to specify the ACL (Access Control List) and to administer the online status of each project.

The ACL is described by the ProjectACL class, and provides information about which ProjectConsumers can access to this project, and which grants they have. Specifically, for each project, it contains the following descriptions:

• a list of ProjectConsumers, together with their access permissions ProjectACL.AccessLevel.
• a "lockable" property, telling if the project associated to this ACL, can be locked for use by a ProjectConsumer, and by which modality

the online status of each project reports:

• the list of its consumers, together with the for each of them
• the LockStatus, which is represented by a <ProjectACL.LockLevel, ProjectConsumer&rt;

TODO We should split ProjectManager into two classes: the real ProjectManager, and a ProjectFactory. ProjectManager should not deal with things like having "hands-in-the-details" of how a project is structured. ProjectFactory should do this.

Author:

Armando Stellato

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProjectManager.AccessResponse
static class	ProjectManager.ProjectType

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger
static String	triples_exchange_FileName

Constructor Summary

Constructors

Constructor and Description
ProjectManager()

Method Summary

Methods

Modifier and Type	Method and Description
static Project<? extends RDFModel>	accessProject(ProjectConsumer consumer, String projectName, ProjectACL.AccessLevel requestedAccessLevel, ProjectACL.LockLevel requestedLockLevel) ProjectConsumers may request access to a project through this method.
static ProjectManager.AccessResponse	checkAccessibility(ProjectConsumer consumer, Project<?> project, ProjectACL.AccessLevel requestedAccessLevel, ProjectACL.LockLevel requestedLockLevel)
static void	cloneProjectToNewProject(String projectName, String newProjectName) this method copies a project to another location.
static void	closeCurrentProject()
static Project<? extends RDFModel>	createProject(ProjectConsumer consumer, String projectName, Class<? extends RDFModel> modelType, File projectDir, String baseURI, String defaultNamespace, String ontManagerFactoryID, String modelConfigurationClassName, Properties modelConfiguration, String uriGeneratorFactoryID, String uriGenConfigurationClassName, Properties uriGenConfiguration, String renderingEngineFactoryID, String renderingEngineConfigurationClass, Properties renderingEngineConfiguration) This method sets up all the necessary files which characterize projects and then generates a new instance on the initialized folder Note: by using directly this method you may create projects in any place in the file system, and Semantic Turkey won't be able to localize them.
static Project<? extends RDFModel>	createProject(ProjectConsumer consumer, String projectName, Class<? extends RDFModel> modelType, String baseURI, String ontManagerFactoryID, String modelConfigurationClass, Properties modelConfiguration, String uriGeneratorFactoryID, String uriGenConfigurationClass, Properties uriGenConfiguration, String renderingEngineFactoryID, String renderingEngineConfigurationClass, Properties renderingEngineConfiguration) a shortcut for #createProject(ProjectConsumer, String, Class, String, String, String, String, Properties) with defaultNamespace automatically assigned from the baseuri
static Project<? extends RDFModel>	createProject(ProjectConsumer consumer, String projectName, Class<? extends RDFModel> modelType, String baseURI, String defaultNamespace, String ontManagerFactoryID, String modelConfigurationClass, Properties modelConfiguration, String uriGeneratorFactoryID, String uriGenConfigurationClass, Properties uriGenConfiguration, String renderingEngineFactoryID, String renderingEngineConfigurationClass, Properties renderingEngineConfiguration) as for #createProject(ProjectConsumer, String, Class, File, String, String, String, String, Properties) but the directory of the project bears the name of the project itself and is located inside the SemanticTurkeyData directory of your Firefox profile.
static Project<? extends RDFModel>	createProject(String projectName, Class<? extends RDFModel> modelType, String baseURI, String ontManagerFactoryID, String modelConfigurationClass, Properties modelConfiguration, String uriGeneratorFactoryID, String uriGenConfigurationClass, Properties uriGenConfiguration, String renderingEngineFactoryID, String renderingEngineConfigurationClass, Properties renderingEngineConfiguration) a shortcut for #createProject(ProjectConsumer, String, Class, String, String, String, Properties) with ProjectConsumer set to ProjectConsumer.SYSTEM
static Project<? extends RDFModel>	createProjectAndSetAsCurrent(String projectName, Class<? extends RDFModel> modelType, String baseURI, String ontManagerFactoryID, String modelConfigurationClass, Properties modelConfiguration, String uriGeneratorFactoryID, String uriGenConfigurationClass, Properties uriGenConfiguration, String renderingEngineFactoryID, String renderingEngineConfigurationClass, Properties renderingEngineConfiguration)
static void	deleteProject(String projectName)
static void	disconnectFromProject(ProjectConsumer consumer, String projectName) this method allows ProjectConsumer consumer to be disconnected from the Project identified by projectName.
static String	escape(String in)
static boolean	existsProject(String projectName)
static void	exportCurrentProject(File semTurkeyProjectFile)
static void	exportProject(String projectName, File semTurkeyProjectFile)
static ProjectACL.AccessLevel	getAccessedLevel(String projectName, ProjectConsumer consumer) Return the access level with which the consumer is accessing the project.
static Project<? extends RDFModel>	getCurrentProject() gets the currently loaded project
static ProjectConsumer	getLockingConsumer(String projectName) Returns the ProjectConsumer that is locking the given project.
static ProjectACL.LockLevel	getLockingLevel(String projectName, ProjectConsumer consumer) Returns the LockLevel which with the project is locked by the consumer.
static Project<? extends RDFModel>	getProject(String projectName) returns the Project with name = projectName.
static String	getProjectBaseURI(String projectName) gets the baseuri of the project with name projectName.
static ProjectConsumer	getProjectConsumer(String consumerName) returns a project consumer from its string description.
static String	getProjectDefaultNamespace(String projectName) gets the default namespace of the project with name projectName.
static <MODELTYPE extends RDFModel> Project<MODELTYPE>	getProjectDescription(String projectName) returns a instance of a concrete implementation of class Project, with the sole exception that the project is not activated (no data is loaded)
static File	getProjectDir(String projectName) This method: invokes resolveProjectNameToDir(String) and gets the project dir associated to that name returns the directory if the project exists, otherwise throws a ProjectInexistentException
static Class<? extends RDFModel>	getProjectModelType(String projectName) gets the model type for the project.
static String	getProjectOntologyManagerID(String projectName) return the id of the project manager implementation adopted by project projectName
static String	getProjectProperty(String projectName, String property) gets the value of the given property property for project with name projectName use specific get methods for standard project properties; this method is left public to support customized properties defined over projects
static String	getProjectPropertyFileContent(String projectName) gets the project.info file content for project with name projectName
static Map<String,String>	getProjectPropertyMap(String projectName) gets name-value pairs for each property of project with name projectName
static long	getProjectTimeStamp(String projectName) gets the timestamp of the project with name projectName.
static ProjectManager.ProjectType	getProjectType(String projectName) gets the type fo the project.
static String	getRequiredProjectProperty(String projectName, String property) as for but throws a {@link ProjectInconsistentException} if the property has a null value
static void	importProject(File semTurkeyProjectFile, String name)
static boolean	isOpen(Project<?> project)
static boolean	isOpen(String project)
static Collection<AbstractProject>	listProjects()
static Collection<AbstractProject>	listProjects(ProjectConsumer consumer) lists the projects available (stored in the projects directory of Semantic Turkey).
static Project<? extends RDFModel>	openProject(String projectName) as for #accessProject(ProjectConsumer, String, AccessLevel, LockLevel) with ProjectConsumer set to ProjectConsumer.SYSTEM ProjectACL.AccessLevel = ProjectACL.AccessLevel.RW ProjectACL.LockLevel = ProjectACL.LockLevel.NO and sets the project identified by projectName as currentProject
static File	resolveProjectNameToDir(String projectName) returns the directory of a project given its name.
static void	saveProjectPropertyFileContent(String projectName, String content) saves the project.info file content for project with name projectName
static void	setProjectProperty(String projectName, String property, String propValue) sets the value of the given property property for project with name projectName use specific get methods for standard project properties; this method is left public to support customized properties defined over projects
static boolean	validProjectName(String projectName)

Methods inherited from class java.lang.Object

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

Field Detail

triples_exchange_FileName

public static final String triples_exchange_FileName

See Also:

Constant Field Values

logger

protected static org.slf4j.Logger logger

Constructor Detail

ProjectManager

public ProjectManager()

Method Detail

listProjects

public static Collection<AbstractProject> listProjects(ProjectConsumer consumer)
                                                throws ProjectAccessException

lists the projects available (stored in the projects directory of Semantic Turkey). If consumer is not null, filters the list by reporting only the projects which contain consumer in their ACL

Parameters:

consumer - if null, all the projects in the projects folder are listed. Corrupted projects are also listed in this case.

Returns:

Throws:

ProjectAccessException

listProjects

public static Collection<AbstractProject> listProjects()
                                                throws ProjectAccessException

Throws:

ProjectAccessException

deleteProject

public static void deleteProject(String projectName)
                          throws ProjectDeletionException

Parameters:

projectName -

Throws:

ProjectDeletionException

createProject

public static Project<? extends RDFModel> createProject(String projectName,
                                        Class<? extends RDFModel> modelType,
                                        String baseURI,
                                        String ontManagerFactoryID,
                                        String modelConfigurationClass,
                                        Properties modelConfiguration,
                                        String uriGeneratorFactoryID,
                                        String uriGenConfigurationClass,
                                        Properties uriGenConfiguration,
                                        String renderingEngineFactoryID,
                                        String renderingEngineConfigurationClass,
                                        Properties renderingEngineConfiguration)
                                                 throws DuplicatedResourceException,
                                                        InvalidProjectNameException,
                                                        ProjectCreationException,
                                                        ProjectInconsistentException,
                                                        ProjectUpdateException

a shortcut for #createProject(ProjectConsumer, String, Class, String, String, String, Properties) with ProjectConsumer set to ProjectConsumer.SYSTEM

Parameters:

projectName -

modelType -

baseURI -

ontManagerFactoryID -

modelConfigurationClass -

modelConfiguration -

uriGeneratorFactoryID -

uriGenConfigurationClassName -

uriGenConfiguration -

renderingEngineFactoryID -

renderingEngineConfigurationClass -

renderingEngineConfiguration -

Returns:

Throws:

DuplicatedResourceException

InvalidProjectNameException

ProjectCreationException

ProjectInconsistentException

ProjectUpdateException

createProject

public static Project<? extends RDFModel> createProject(ProjectConsumer consumer,
                                        String projectName,
                                        Class<? extends RDFModel> modelType,
                                        String baseURI,
                                        String ontManagerFactoryID,
                                        String modelConfigurationClass,
                                        Properties modelConfiguration,
                                        String uriGeneratorFactoryID,
                                        String uriGenConfigurationClass,
                                        Properties uriGenConfiguration,
                                        String renderingEngineFactoryID,
                                        String renderingEngineConfigurationClass,
                                        Properties renderingEngineConfiguration)
                                                 throws DuplicatedResourceException,
                                                        InvalidProjectNameException,
                                                        ProjectCreationException,
                                                        ProjectInconsistentException,
                                                        ProjectUpdateException

a shortcut for #createProject(ProjectConsumer, String, Class, String, String, String, String, Properties) with defaultNamespace automatically assigned from the baseuri

Parameters:

consumer -

projectName -

modelType -

baseURI -

ontManagerFactoryID -

modelConfigurationClass -

modelConfiguration -

uriGeneratorFactoryID -

uriGenConfigurationClassName -

uriGenConfiguration -

renderingEngineFactoryID -

renderingEngineConfigurationClass -

renderingEngineConfiguration -

Returns:

Throws:

DuplicatedResourceException

InvalidProjectNameException

ProjectCreationException

ProjectInconsistentException

ProjectUpdateException

createProject

public static Project<? extends RDFModel> createProject(ProjectConsumer consumer,
                                        String projectName,
                                        Class<? extends RDFModel> modelType,
                                        String baseURI,
                                        String defaultNamespace,
                                        String ontManagerFactoryID,
                                        String modelConfigurationClass,
                                        Properties modelConfiguration,
                                        String uriGeneratorFactoryID,
                                        String uriGenConfigurationClass,
                                        Properties uriGenConfiguration,
                                        String renderingEngineFactoryID,
                                        String renderingEngineConfigurationClass,
                                        Properties renderingEngineConfiguration)
                                                 throws DuplicatedResourceException,
                                                        InvalidProjectNameException,
                                                        ProjectCreationException,
                                                        ProjectInconsistentException,
                                                        ProjectUpdateException

as for #createProject(ProjectConsumer, String, Class, File, String, String, String, String, Properties) but the directory of the project bears the name of the project itself and is located inside the SemanticTurkeyData directory of your Firefox profile. You should normally use this method to create new projects which are expected to be found by the main system

Parameters:

consumer -

projectName -

modelType -

baseURI -

defaultNamespace -

ontManagerFactoryID -

modelConfigurationClass -

modelConfiguration -

uriGeneratorFactoryID -

uriGenConfigurationClassName -

uriGenConfiguration -

renderingEngineFactoryID -

renderingEngineConfigurationClass -

renderingEngineConfiguration -

Returns:

Throws:

DuplicatedResourceException

InvalidProjectNameException

ProjectCreationException

ProjectInconsistentException

ProjectUpdateException

createProject

public static Project<? extends RDFModel> createProject(ProjectConsumer consumer,
                                        String projectName,
                                        Class<? extends RDFModel> modelType,
                                        File projectDir,
                                        String baseURI,
                                        String defaultNamespace,
                                        String ontManagerFactoryID,
                                        String modelConfigurationClassName,
                                        Properties modelConfiguration,
                                        String uriGeneratorFactoryID,
                                        String uriGenConfigurationClassName,
                                        Properties uriGenConfiguration,
                                        String renderingEngineFactoryID,
                                        String renderingEngineConfigurationClass,
                                        Properties renderingEngineConfiguration)
                                                 throws ProjectCreationException

This method sets up all the necessary files which characterize projects and then generates a new instance on the initialized folder

Note: by using directly this method you may create projects in any place in the file system, and Semantic Turkey won't be able to localize them. For this reason, it should only be used by Semantic Turkey extensions which are adopting a new project folder, providing also dedicated API to access/manage its projects.
use #createProject(String, Class, String, String, String, Properties) or #createProject(String, Class, String, String, String, String, Properties) to create a new project

Parameters:

consumer -

projectName -

modelType -

projectDir -

baseURI -

defaultNamespace -

ontManagerFactoryID -

modelConfigurationClassName -

modelConfiguration -

uriGeneratorFactoryID -

uriGenConfigurationClassName -

uriGenConfiguration -

renderingEngineFactoryID -

renderingEngineConfigurationClass -

renderingEngineConfiguration -

Returns:

Throws:

ProjectCreationException

getProject

public static Project<? extends RDFModel> getProject(String projectName)

returns the Project with name = projectName. In case no project with that name is open, null is returned.

Parameters:

projectName -

Returns:

existsProject

public static boolean existsProject(String projectName)
                             throws InvalidProjectNameException

Throws:

InvalidProjectNameException

getProjectConsumer

public static ProjectConsumer getProjectConsumer(String consumerName)

returns a project consumer from its string description. A valid project consumer is either ProjectConsumer.SYSTEM or an open project. If consumerName

Parameters:

consumerName -

Returns:

cloneProjectToNewProject

public static void cloneProjectToNewProject(String projectName,
                            String newProjectName)
                                     throws InvalidProjectNameException,
                                            DuplicatedResourceException,
                                            IOException,
                                            UnavailableResourceException,
                                            ProjectInexistentException

this method copies a project to another location. The project identified by projectName must not be open.

Parameters:

projectName -

newProjectName -

Throws:

InvalidProjectNameException

DuplicatedResourceException

IOException

UnavailableResourceException

ProjectInexistentException

getProjectDir

public static File getProjectDir(String projectName)
                          throws InvalidProjectNameException,
                                 ProjectInexistentException

This method:

• invokes resolveProjectNameToDir(String) and gets the project dir associated to that name
• returns the directory if the project exists, otherwise throws a ProjectInexistentException

Parameters:

projectName -

Returns:

Throws:

InvalidProjectNameException

ProjectInexistentException

resolveProjectNameToDir

public static File resolveProjectNameToDir(String projectName)
                                    throws InvalidProjectNameException

returns the directory of a project given its name. This is based on the assumption that the project directory is assigned on the basis of project's name (as done by the ProjectManager).
Note that this method does not guarantees that the project dir (and thus the project) exists

Parameters:

projectName -

Returns:

Throws:

InvalidProjectNameException

exportProject

public static void exportProject(String projectName,
                 File semTurkeyProjectFile)
                          throws IOException,
                                 ModelAccessException,
                                 UnsupportedRDFFormatException,
                                 UnavailableResourceException

Throws:

IOException

ModelAccessException

UnsupportedRDFFormatException

UnavailableResourceException

importProject

public static void importProject(File semTurkeyProjectFile,
                 String name)
                          throws IOException,
                                 ModelAccessException,
                                 UnsupportedRDFFormatException,
                                 ProjectCreationException,
                                 DuplicatedResourceException,
                                 ProjectInconsistentException,
                                 ProjectUpdateException,
                                 ModelUpdateException,
                                 InvalidProjectNameException

Throws:

IOException

ModelAccessException

UnsupportedRDFFormatException

ProjectCreationException

DuplicatedResourceException

ProjectInconsistentException

ProjectUpdateException

ModelUpdateException

InvalidProjectNameException

getProjectDescription

public static <MODELTYPE extends RDFModel> Project<MODELTYPE> getProjectDescription(String projectName)
                                                                 throws InvalidProjectNameException,
                                                                        ProjectInexistentException,
                                                                        ProjectAccessException

returns a instance of a concrete implementation of class Project, with the sole exception that the project is not activated (no data is loaded)

Parameters:

projectName -

Returns:

Throws:

InvalidProjectNameException

ProjectInexistentException

ProjectAccessException

validProjectName

public static boolean validProjectName(String projectName)

setProjectProperty

public static void setProjectProperty(String projectName,
                      String property,
                      String propValue)
                               throws IOException,
                                      InvalidProjectNameException,
                                      ProjectInexistentException

sets the value of the given property property for project with name projectName

use specific get methods for standard project properties; this method is left public to support customized properties defined over projects

Parameters:

projectName -

property -

propValue -

Throws:

IOException

InvalidProjectNameException

ProjectInexistentException

getProjectProperty

public static String getProjectProperty(String projectName,
                        String property)
                                 throws IOException,
                                        InvalidProjectNameException,
                                        ProjectInexistentException

gets the value of the given property property for project with name projectName

use specific get methods for standard project properties; this method is left public to support customized properties defined over projects

Parameters:

projectName -

property -

Returns:

Throws:

IOException

InvalidProjectNameException

ProjectInexistentException

getProjectPropertyMap

public static Map<String,String> getProjectPropertyMap(String projectName)
                                                throws IOException,
                                                       InvalidProjectNameException,
                                                       ProjectInexistentException

gets name-value pairs for each property of project with name projectName

Parameters:

projectName -

Returns:

Throws:

IOException

InvalidProjectNameException

ProjectInexistentException

getProjectPropertyFileContent

public static String getProjectPropertyFileContent(String projectName)
                                            throws IOException,
                                                   InvalidProjectNameException,
                                                   ProjectInexistentException

gets the project.info file content for project with name projectName

Parameters:

projectName -

Returns:

Throws:

IOException

InvalidProjectNameException

ProjectInexistentException

saveProjectPropertyFileContent

public static void saveProjectPropertyFileContent(String projectName,
                                  String content)
                                           throws IOException,
                                                  InvalidProjectNameException,
                                                  ProjectInexistentException

saves the project.info file content for project with name projectName

Parameters:

projectName -

content -

Throws:

IOException

InvalidProjectNameException

ProjectInexistentException

getRequiredProjectProperty

public static String getRequiredProjectProperty(String projectName,
                                String property)
                                         throws ProjectInconsistentException,
                                                IOException,
                                                InvalidProjectNameException,
                                                ProjectInexistentException

as for but throws a {@link ProjectInconsistentException} if the property has a null value

Parameters:

projectName -

property -

Returns:

Throws:

ProjectInconsistentException

IOException

InvalidProjectNameException

ProjectInexistentException

getProjectOntologyManagerID

public static String getProjectOntologyManagerID(String projectName)
                                          throws IOException,
                                                 InvalidProjectNameException,
                                                 ProjectInexistentException,
                                                 ProjectInconsistentException

return the id of the project manager implementation adopted by project projectName

Parameters:

projectName -

Returns:

Throws:

IOException

ProjectInexistentException

InvalidProjectNameException

ProjectInconsistentException

getProjectType

public static ProjectManager.ProjectType getProjectType(String projectName)
                                                 throws IOException,
                                                        InvalidProjectNameException,
                                                        ProjectInexistentException,
                                                        ProjectInconsistentException

gets the type fo the project. It is not applicable for the main project, which is anyway assumed to be always a PersistentStoreProject

Parameters:

projectName -

Returns:

Throws:

IOException

ProjectInexistentException

InvalidProjectNameException

ProjectInconsistentException

FileNotFoundException

getProjectModelType

public static Class<? extends RDFModel> getProjectModelType(String projectName)
                                                     throws InvalidProjectNameException,
                                                            ProjectInexistentException,
                                                            ProjectAccessException,
                                                            ProjectInconsistentException

gets the model type for the project. It is not applicable for the main project, which is anyway assumed to be always a OWLModel

Parameters:

projectName -

Returns:

Throws:

IOException

ClassNotFoundException

IllegalClassFormatException

ProjectInexistentException

InvalidProjectNameException

ProjectAccessException

ProjectInconsistentException

FileNotFoundException

getProjectBaseURI

public static String getProjectBaseURI(String projectName)
                                throws IOException,
                                       InvalidProjectNameException,
                                       ProjectInexistentException

gets the baseuri of the project with name projectName.

Parameters:

projectName -

Returns:

Throws:

IOException

ProjectInexistentException

InvalidProjectNameException

getProjectDefaultNamespace

public static String getProjectDefaultNamespace(String projectName)
                                         throws IOException,
                                                InvalidProjectNameException,
                                                ProjectInexistentException

gets the default namespace of the project with name projectName.

Parameters:

projectName -

Returns:

Throws:

IOException

ProjectInexistentException

InvalidProjectNameException

getProjectTimeStamp

public static long getProjectTimeStamp(String projectName)
                                throws IOException,
                                       InvalidProjectNameException,
                                       ProjectInexistentException

gets the timestamp of the project with name projectName.

Parameters:

projectName -

Returns:

Throws:

ProjectInexistentException

InvalidProjectNameException

IOException

IOException

escape

public static String escape(String in)

checkAccessibility

public static ProjectManager.AccessResponse checkAccessibility(ProjectConsumer consumer,
                                               Project<?> project,
                                               ProjectACL.AccessLevel requestedAccessLevel,
                                               ProjectACL.LockLevel requestedLockLevel)

accessProject

public static Project<? extends RDFModel> accessProject(ProjectConsumer consumer,
                                        String projectName,
                                        ProjectACL.AccessLevel requestedAccessLevel,
                                        ProjectACL.LockLevel requestedLockLevel)
                                                 throws InvalidProjectNameException,
                                                        ProjectInexistentException,
                                                        ProjectAccessException,
                                                        ForbiddenProjectAccessException

ProjectConsumers may request access to a project through this method. The ProjectManager verifies that the access can be granted to the requesting consumer, and in affirmative case handles all the necessary operations (verifying that the project is open, or opening it in negative case and adding it to the list of open projects, making its data available) to make the project available to the consumer.

Parameters:

consumer -

projectName -

requestedAccessLevel -

requestedLockLevel -

Returns:

Throws:

InvalidProjectNameException

ProjectInexistentException

ProjectAccessException

ForbiddenProjectAccessException

disconnectFromProject

public static void disconnectFromProject(ProjectConsumer consumer,
                         String projectName)
                                  throws ModelUpdateException

this method allows ProjectConsumer consumer to be disconnected from the Project identified by projectName.
If the consumer is ProjectConsumer.SYSTEM, then projectName is disconnected in turn from the projects it consumes.

Parameters:

consumer -

projectName -

Throws:

ModelUpdateException

isOpen

public static boolean isOpen(Project<?> project)

isOpen

public static boolean isOpen(String project)

getAccessedLevel

public static ProjectACL.AccessLevel getAccessedLevel(String projectName,
                                      ProjectConsumer consumer)
                                               throws InvalidProjectNameException,
                                                      ProjectInexistentException,
                                                      ProjectAccessException

Return the access level with which the consumer is accessing the project. Null if the consumer does not access the given project.

Parameters:

project -

consumer -

Returns:

Throws:

ProjectAccessException

ProjectInexistentException

InvalidProjectNameException

getLockingConsumer

public static ProjectConsumer getLockingConsumer(String projectName)
                                          throws InvalidProjectNameException,
                                                 ProjectInexistentException,
                                                 ProjectAccessException

Returns the ProjectConsumer that is locking the given project. null if the project is not currently locked

Parameters:

projectName -

consumer -

Returns:

Throws:

InvalidProjectNameException

ProjectInexistentException

ProjectAccessException

getLockingLevel

public static ProjectACL.LockLevel getLockingLevel(String projectName,
                                   ProjectConsumer consumer)
                                            throws InvalidProjectNameException,
                                                   ProjectInexistentException,
                                                   ProjectAccessException

Returns the LockLevel which with the project is locked by the consumer. null if the project is not locked by the given consumer.

Parameters:

projectName -

consumer -

Returns:

Throws:

InvalidProjectNameException

ProjectInexistentException

ProjectAccessException

getCurrentProject

public static Project<? extends RDFModel> getCurrentProject()

gets the currently loaded project

Returns:

openProject

public static Project<? extends RDFModel> openProject(String projectName)
                                               throws ProjectAccessException,
                                                      ProjectInexistentException,
                                                      InvalidProjectNameException,
                                                      ForbiddenProjectAccessException

as for #accessProject(ProjectConsumer, String, AccessLevel, LockLevel) with

• ProjectConsumer set to ProjectConsumer.SYSTEM
• ProjectACL.AccessLevel = ProjectACL.AccessLevel.RW
• ProjectACL.LockLevel = ProjectACL.LockLevel.NO

and sets the project identified by projectName as currentProject

Parameters:

projectName -

Returns:

Throws:

ProjectAccessException

ProjectInexistentException

ForbiddenProjectAccessException

InvalidProjectNameException

closeCurrentProject

public static void closeCurrentProject()
                                throws ModelUpdateException

Throws:

ModelUpdateException

exportCurrentProject

public static void exportCurrentProject(File semTurkeyProjectFile)
                                 throws IOException,
                                        ModelAccessException,
                                        UnsupportedRDFFormatException,
                                        UnavailableResourceException

Throws:

IOException

ModelAccessException

UnsupportedRDFFormatException

UnavailableResourceException

createProjectAndSetAsCurrent

public static Project<? extends RDFModel> createProjectAndSetAsCurrent(String projectName,
                                                       Class<? extends RDFModel> modelType,
                                                       String baseURI,
                                                       String ontManagerFactoryID,
                                                       String modelConfigurationClass,
                                                       Properties modelConfiguration,
                                                       String uriGeneratorFactoryID,
                                                       String uriGenConfigurationClass,
                                                       Properties uriGenConfiguration,
                                                       String renderingEngineFactoryID,
                                                       String renderingEngineConfigurationClass,
                                                       Properties renderingEngineConfiguration)
                                                                throws DuplicatedResourceException,
                                                                       InvalidProjectNameException,
                                                                       ProjectCreationException,
                                                                       ProjectInconsistentException,
                                                                       ProjectUpdateException

Throws:

DuplicatedResourceException

InvalidProjectNameException

ProjectCreationException

ProjectInconsistentException

ProjectUpdateException