public class JobCreator extends TypedAtomicActor
Create a job. It does not execute it!
This actor uses the Job and JobFactory classes to create a job that can be submitted with JobSubmitter.
The cmdFile should be the path to the job submission file that you have created before. This is jobmanager specific! It can be empty, if you want the JobManager to create the submission file for the (later) selected JobManager. Note: this capability of the job managers classes is not implemented yet, so you have to feed here the job submission file (prepared in advance). The file can either local or remote. Indicate in cmdFileLocal which case holds.
Executable is the path to the executable if it is located on this local machine. It will be staged to the remote site (into the job's working directory) before job submission. If the executable is located on the remote site, do not give it here, and use its absolute path in your submission file.
The working directory is the path to the remote working directory in which you want the job's files to be created. It will be expanded with the job's unique id assigned by the JobFactory.
The array of inputfiles is the list of (local) inputfiles to be staged to the remote site before job submission.
The array of remotefiles is the list of remote input files that are to be copied into the job's working directory before job submission.
The output is the created job (of type Object) that can be used later to submit the job in JobSubmitter and query its status in JobStatus actor. It is null if job creation failed.
Entity.ContainedObjectsIterator| Modifier and Type | Field and Description |
|---|---|
PortParameter |
cmdFile
The submit file to be used at job submission.
|
Parameter |
cmdFileLocal
Specifying whether the cmdFile is locally stored or on the remote target.
|
PortParameter |
executable
The executable file to be used at job submission.
|
PortParameter |
inputfiles
The string array of inputfiles.
|
TypedIOPort |
job
The job object.
|
PortParameter |
remotefiles
The string array of remote input files.
|
PortParameter |
workdir
The working directory in which the actual job submission command will be
executed (on the remote machine if the job manager is a remote
jobmanager).
|
_typesValid_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKSCOMPLETED, NOT_READY, STOP_ITERATING| Constructor and Description |
|---|
JobCreator(CompositeEntity container,
java.lang.String name)
Construct an actor with the given container and name.
|
| Modifier and Type | Method and Description |
|---|---|
void |
fire()
fire
|
_containedTypeConstraints, _customTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, clone, isBackwardTypeInferenceEnabled, newPort, typeConstraintList, typeConstraints_actorFiring, _actorFiring, _declareDelayDependency, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, initialize, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, postfire, prefire, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate, wrapup_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName_addPort, _description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeChanged, attributeDeleted, attributeList, attributeList, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspaceequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitcreateReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortListisFireFunctional, isStrict, iterate, postfire, prefire, stop, stopFire, terminateaddInitializable, initialize, preinitialize, removeInitializable, wrapupdescription, getContainer, getDisplayName, getFullName, getName, getName, setNamegetDerivedLevel, getDerivedList, propagateValuepublic PortParameter cmdFile
This parameter is read each time in fire().
public Parameter cmdFileLocal
This parameter is read each time in fire().
public PortParameter executable
This parameter is read each time in fire().
public PortParameter workdir
It should be an absolute path, or a relative one. In the latter case on remote machine, the directory path will be relative to the user's home directory (coming from the use of ssh)
This parameter is read each time in fire().
public PortParameter inputfiles
This parameter is read each time in fire().
public PortParameter remotefiles
This parameter is read each time in fire().
public TypedIOPort job
public JobCreator(CompositeEntity container, java.lang.String name) throws NameDuplicationException, IllegalActionException
container - The container.name - The name of this actor.IllegalActionException - If the actor cannot be contained by the proposed
container.NameDuplicationException - If the container already has an actor with this name.public void fire() throws IllegalActionException
fire in interface Executablefire in class AtomicActor<TypedIOPort>IllegalActionException - Not thrown.