org.eclipse.sphinx.emf.workspace.jobs

Class CreateNewModelFileJob

java.lang.Object

org.eclipse.core.runtime.PlatformObject

org.eclipse.core.internal.jobs.InternalJob

org.eclipse.core.runtime.jobs.Job

org.eclipse.core.internal.resources.InternalWorkspaceJob

org.eclipse.core.resources.WorkspaceJob

org.eclipse.sphinx.emf.workspace.jobs.CreateNewModelFileJob

All Implemented Interfaces:

java.lang.Comparable, org.eclipse.core.runtime.IAdaptable

public class CreateNewModelFileJob
extends org.eclipse.core.resources.WorkspaceJob

A create new model job capable of creating and saving an initial model to be added to the new model compliant file in the workspace. This model file to be created must not be null. The initial model is based on the given metamodel descriptor. The initial model will create a root object using a root object classifier, and a root object package for the model to be contained.

This job is set by default the priority to Job.BUILD and the rule to the workspace root to be run with the job manager.

Field Summary

Fields

Modifier and Type	Field and Description
protected IMetaModelDescriptor	metaModelDescriptor
protected org.eclipse.core.resources.IFile	newFile
protected org.eclipse.emf.ecore.EClassifier	rootObjectEClassifier
protected org.eclipse.emf.ecore.EPackage	rootObjectEPackage

Fields inherited from class org.eclipse.core.runtime.jobs.Job

ASYNC_FINISH, BUILD, DECORATE, INTERACTIVE, LONG, NONE, RUNNING, SHORT, SLEEPING, WAITING

Fields inherited from class org.eclipse.core.internal.jobs.InternalJob

manager

Constructor Summary

Constructors

Constructor and Description
CreateNewModelFileJob(java.lang.String jobName, org.eclipse.core.resources.IFile newFile, IMetaModelDescriptor metaModelDescriptor, org.eclipse.emf.ecore.EPackage rootObjectEPackage, org.eclipse.emf.ecore.EClassifier rootObjectEClassifier) Creates a new instance of this CreateNewModelFileJob.

Method Summary

Methods

Modifier and Type	Method and Description
protected org.eclipse.emf.ecore.EObject	createInitialModel() Creates the initial model to be added to the new model file.
org.eclipse.core.runtime.IStatus	runInWorkspace(org.eclipse.core.runtime.IProgressMonitor monitor)
protected void	saveInitialModel(org.eclipse.emf.ecore.EObject rootObject, org.eclipse.core.runtime.IProgressMonitor monitor) Saves the initial model rooted by given root object to a new file in the workspace.

Methods inherited from class org.eclipse.core.internal.resources.InternalWorkspaceJob

run

Methods inherited from class org.eclipse.core.runtime.jobs.Job

addJobChangeListener, belongsTo, cancel, canceling, create, done, getJobGroup, getJobManager, getName, getPriority, getProperty, getResult, getRule, getState, getThread, isBlocking, isSystem, isUser, join, join, removeJobChangeListener, schedule, schedule, setJobGroup, setName, setPriority, setProgressGroup, setProperty, setRule, setSystem, setThread, setUser, shouldRun, shouldSchedule, sleep, toString, wakeUp, wakeUp, yieldRule

Methods inherited from class org.eclipse.core.internal.jobs.InternalJob

compareTo

Methods inherited from class org.eclipse.core.runtime.PlatformObject

getAdapter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Field Detail

newFile

protected org.eclipse.core.resources.IFile newFile

metaModelDescriptor

protected IMetaModelDescriptor metaModelDescriptor

rootObjectEPackage

protected org.eclipse.emf.ecore.EPackage rootObjectEPackage

rootObjectEClassifier

protected org.eclipse.emf.ecore.EClassifier rootObjectEClassifier

Constructor Detail

CreateNewModelFileJob

public CreateNewModelFileJob(java.lang.String jobName,
                     org.eclipse.core.resources.IFile newFile,
                     IMetaModelDescriptor metaModelDescriptor,
                     org.eclipse.emf.ecore.EPackage rootObjectEPackage,
                     org.eclipse.emf.ecore.EClassifier rootObjectEClassifier)

Creates a new instance of this CreateNewModelFileJob. It sets by default the priority to Job.BUILD and the rule to the workspace root. The model file that will be created and the metamodel descriptor that this model file is based on must not be null.

Parameters:

jobName - the name of the job

newFile - the model file that will be created, must not be null

metaModelDescriptor - the descriptor of metamodel the model file should be based on, must not be null

rootObjectEPackage - the root object package to be used for creating the initial model to be contained by the model file, must not be null

rootObjectEClassifier - the root object classifier of the initial model's root object, must not be null

Method Detail

runInWorkspace

public org.eclipse.core.runtime.IStatus runInWorkspace(org.eclipse.core.runtime.IProgressMonitor monitor)
                                                throws org.eclipse.core.runtime.CoreException

Specified by:

runInWorkspace in class org.eclipse.core.resources.WorkspaceJob

Throws:

org.eclipse.core.runtime.CoreException

createInitialModel

protected org.eclipse.emf.ecore.EObject createInitialModel()

Creates the initial model to be added to the new model file.

This implementation creates a new root object using the root object package and root object classifier provided to this CreateNewModelFileJob.

saveInitialModel

protected void saveInitialModel(org.eclipse.emf.ecore.EObject rootObject,
                    org.eclipse.core.runtime.IProgressMonitor monitor)

Saves the initial model rooted by given root object to a new file in the workspace.

Parameters:

rootObject - the root object to be saved in a file

monitor - a progress monitor monitor, or null if progress reporting and cancelation are not desired