Package caseine.project

Class CaseineCommonProject

java.lang.Object

caseine.project.CaseineCommonProject

All Implemented Interfaces:

CaseineProject

Direct Known Subclasses:

CaseineCppProject, CaseineJavaProject, CaseinePythonProject

public class CaseineCommonProject
extends Object
implements CaseineProject

Nested Class Summary

Nested classes/interfaces inherited from interface caseine.project.CaseineProject

CaseineProject.ProjectType

Field Summary

Fields

Modifier and Type	Field	Description
static String	CASEINE_VPL_ID
static String	CASEINE_VPL_TYPE
protected File	caseineFile
protected static final String	CF
protected static final String	EF
protected static String	INTERNAL_FILE
protected static Logger	log
protected static String	PATH_BIN	By convention binaries of a CaseInE project must be here.
protected static final String	PATH_CLASSES	By convention sources of a CaseInE project must be here.
protected static final String	PATH_DOC	By convention sources of a CaseInE project must be here.
protected static final String	PATH_RESOURCES_LIB	By convention lib resources of a CaseInE project must be here.
protected static final String	PATH_RESOURCES_SRC	By convention resources of a CaseInE project must be here.
protected static final String	PATH_RESOURCES_TEST	By convention test resources of a CaseInE project must be here.
protected static final String	PATH_SRC	By convention sources of a CaseInE project must be here.
protected static final String	PATH_TEST	By convention test sources of a CaseInE project must be here.
protected static final String	PLUGIN_LIB
protected String	projectPath
protected static final String	RF
protected boolean	settings
protected String	vplId
protected static final String	VPLID_0

Constructor Summary

Constructors

Constructor	Description
CaseineCommonProject(String projectPath, String vplId, String url, String token, boolean settings)

Method Summary

Modifier and Type	Method	Description
void	clean()	Cleans the local templates.
boolean	documentation()	Synchronize the documentation of the VPL
protected static vplwsclient.VplFile	fileToCaseinePath(File f, String projectLocation)
void	fillCaseine(String vplId)
protected void	fillCaseineProjectFile()
void	generate(boolean mvn, int template)	Generates the project template.
protected static String	getPATH_BIN()	By convention binaries of a CaseInE project must be generated here.
protected static String	getPATH_CORRECTED_FILES()	By convention corrected files generated for a CaseInE project must be here.
protected static String	getPATH_EXECUTION_FILES()	By convention execution files generated for a CaseInE project must be here.
protected static String	getPATH_OUTPUT()	By convention outputs of a CaseInE project must be here.
protected static String	getPATH_REQUESTED_FILES()	By convention requested files generated for a CaseInE project must be here.
String	getProjectName()
Properties	getProperties()
CaseineProject.ProjectType	getType()
String	getVplId()
boolean	isCaseine()
boolean	isGenerated()
void	local(ClassLoader cl)	Generates the local caseine templates into caseine-output.
void	nature()	Set the caseine nature to the project
void	push(ClassLoader cl)	Publishes the templates to the remote caseine server.
boolean	updateSettings()	Update the settings of the VPL

Methods inherited from class java.lang.Object

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

Field Details

VPLID_0

protected static final String VPLID_0

See Also:

• Constant Field Values

CASEINE_VPL_ID

public static String CASEINE_VPL_ID

CASEINE_VPL_TYPE

public static String CASEINE_VPL_TYPE

projectPath

protected String projectPath

vplId

protected String vplId

caseineFile

protected File caseineFile

INTERNAL_FILE

protected static String INTERNAL_FILE

log

protected static Logger log

RF

protected static final String RF

See Also:

• Constant Field Values

EF

protected static final String EF

See Also:

• Constant Field Values

CF

protected static final String CF

See Also:

• Constant Field Values

PATH_SRC

protected static final String PATH_SRC

By convention sources of a CaseInE project must be here.

PATH_CLASSES

protected static final String PATH_CLASSES

By convention sources of a CaseInE project must be here.

PATH_DOC

protected static final String PATH_DOC

By convention sources of a CaseInE project must be here.

PATH_BIN

protected static String PATH_BIN

By convention binaries of a CaseInE project must be here.

PATH_TEST

protected static final String PATH_TEST

By convention test sources of a CaseInE project must be here.

PATH_RESOURCES_SRC

protected static final String PATH_RESOURCES_SRC

By convention resources of a CaseInE project must be here.

PATH_RESOURCES_TEST

protected static final String PATH_RESOURCES_TEST

By convention test resources of a CaseInE project must be here.

PATH_RESOURCES_LIB

protected static final String PATH_RESOURCES_LIB

By convention lib resources of a CaseInE project must be here.

PLUGIN_LIB

protected static final String PLUGIN_LIB

See Also:

• Constant Field Values

settings

protected boolean settings

Constructor Details

CaseineCommonProject

public CaseineCommonProject(String projectPath,
 String vplId,
 String url,
 String token,
 boolean settings)

Method Details

isCaseine

public boolean isCaseine()

Specified by:

isCaseine in interface CaseineProject

Returns:

True if it is a Caseine project, Maven projects are not managed

getType

public CaseineProject.ProjectType getType()

Specified by:

getType in interface CaseineProject

getProperties

public Properties getProperties()

Returns:

all properties in the .caseine file

getVplId

public String getVplId()

Specified by:

getVplId in interface CaseineProject

fillCaseine

public void fillCaseine(String vplId)

generate

public void generate(boolean mvn,
 int template)
              throws CaseineProjectAlreadyExistingException,
BadIDEException,
IOException,
TestDirectoryMissingException,
FileMissingException,
UnitTestsFileMissingException

Description copied from interface: CaseineProject

Generates the project template.

Specified by:

generate in interface CaseineProject

Parameters:

mvn - True if we must generate the maven pom.xml

template - a number to define a kind of template

Throws:

CaseineProjectAlreadyExistingException

BadIDEException

IOException

TestDirectoryMissingException

FileMissingException

UnitTestsFileMissingException

local

public void local(ClassLoader cl)
           throws IOException,
ClassNotFoundException,
MavenProjectException

Description copied from interface: CaseineProject

Generates the local caseine templates into caseine-output.

Specified by:

local in interface CaseineProject

Parameters:

cl - an optional classloader to provide dependencies

Throws:

IOException - if ioException

ClassNotFoundException - if the class is not found

MavenProjectException

push

public void push(ClassLoader cl)
          throws IOException,
ClassNotFoundException,
vplwsclient.exception.VplException,
VPLIDMissingException,
MavenProjectException,
NothingPushedException

Publishes the templates to the remote caseine server. The full description of the lab is synchronized.

Specified by:

push in interface CaseineProject

Parameters:

cl - an optional classloader to provide dependencies

Throws:

IOException - if something wrong

ClassNotFoundException - if something wrong

vplwsclient.exception.VplException - if something wrong

VPLIDMissingException

MavenProjectException

NothingPushedException

clean

public void clean()
           throws IOException

Description copied from interface: CaseineProject

Cleans the local templates.

Specified by:

clean in interface CaseineProject

Throws:

IOException - if an error occurs with the deleted files

isGenerated

public boolean isGenerated()

Specified by:

isGenerated in interface CaseineProject

nature

public void nature()
            throws CaseineProjectAlreadyExistingException,
IOException

Description copied from interface: CaseineProject

Set the caseine nature to the project

Specified by:

nature in interface CaseineProject

Throws:

CaseineProjectAlreadyExistingException

IOException

documentation

public boolean documentation()
                      throws vplwsclient.exception.VplConnectionException,
vplwsclient.exception.MoodleWebServiceException,
IOException

Description copied from interface: CaseineProject

Synchronize the documentation of the VPL

Specified by:

documentation in interface CaseineProject

Returns:

true if something is published on the server

Throws:

vplwsclient.exception.VplConnectionException

vplwsclient.exception.MoodleWebServiceException

IOException

updateSettings

public boolean updateSettings()
                       throws vplwsclient.exception.VplConnectionException,
vplwsclient.exception.MoodleWebServiceException,
IOException

Description copied from interface: CaseineProject

Update the settings of the VPL

Specified by:

updateSettings in interface CaseineProject

Returns:

true if something is published on the server

Throws:

vplwsclient.exception.VplConnectionException

vplwsclient.exception.MoodleWebServiceException

IOException

getPATH_REQUESTED_FILES

protected static String getPATH_REQUESTED_FILES()

By convention requested files generated for a CaseInE project must be here.

getPATH_CORRECTED_FILES

protected static String getPATH_CORRECTED_FILES()

By convention corrected files generated for a CaseInE project must be here.

getPATH_EXECUTION_FILES

protected static String getPATH_EXECUTION_FILES()

By convention execution files generated for a CaseInE project must be here.

getPATH_OUTPUT

protected static String getPATH_OUTPUT()

By convention outputs of a CaseInE project must be here.

getPATH_BIN

protected static String getPATH_BIN()

By convention binaries of a CaseInE project must be generated here.

fillCaseineProjectFile

protected void fillCaseineProjectFile()

fileToCaseinePath

protected static vplwsclient.VplFile fileToCaseinePath(File f,
 String projectLocation)

getProjectName

public String getProjectName()