org.jbind.xml.schema.reader
Class ComponentJob

java.lang.Object
  extended byorg.jbind.xml.schema.reader.Job
      extended byorg.jbind.xml.schema.reader.ComponentJob
All Implemented Interfaces:
IComponentJob, IElementHelper, IHasLocation, IJob

public class ComponentJob
extends Job
implements IComponentJob


Constructor Summary
ComponentJob(IComponentJobHelper aHelper, IComponentSetter anAfterCreation, IComponentSetter anAfterValidation)
           
 
Method Summary
 void addSubJob(IComponentJobHelper aHelper, IComponentSetter aComponentSetter)
          Creates a sub job and adds it to this job.
protected  void collectRefsForCompletion(IJobRefs aJobRefs)
           
protected  void collectRefsForCreation(IJobRefs aJobRefs)
           
protected  void collectRefsForValidation(IJobRefs aJobRefs)
           
 void doExecuteCompletion(IConstraintViolations aViolations)
           
 void doExecuteCreation(IConstraintViolations aViolations)
           
 void doExecuteValidation(IConstraintViolations aViolations)
           
 IComponent getComponent(IRef aGlobalRef, boolean aMustBeValidated)
          Resolves a component reference.
 java.lang.String getDescription()
          Gets a short description of the job.
 IInstantiator getInstantiator()
          Gets the instantiator that controls the execution of this job.
 
Methods inherited from class org.jbind.xml.schema.reader.Job
addSubJob, checkSubJobsValidated, executeCompletion, executeCreation, executeValidation, getHelper, getIsValidated, getLocation, getParent, iterRefsForCompletion, iterRefsForCreation, iterRefsForValidation, iterSubJobs, setParent, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.jbind.xml.schema.reader.IJob
checkSubJobsValidated, executeCompletion, executeCreation, executeValidation, getIsValidated, getParent, iterRefsForCompletion, iterRefsForCreation, iterRefsForValidation, iterSubJobs, setParent
 
Methods inherited from interface org.jbind.xml.base.IHasLocation
getLocation
 

Constructor Detail

ComponentJob

public ComponentJob(IComponentJobHelper aHelper,
                    IComponentSetter anAfterCreation,
                    IComponentSetter anAfterValidation)
Method Detail

getInstantiator

public IInstantiator getInstantiator()
Description copied from interface: IJob
Gets the instantiator that controls the execution of this job.

Specified by:
getInstantiator in interface IJob
Returns:
An instantiator. (required)

collectRefsForCreation

protected void collectRefsForCreation(IJobRefs aJobRefs)
Specified by:
collectRefsForCreation in class Job

collectRefsForCompletion

protected void collectRefsForCompletion(IJobRefs aJobRefs)
Specified by:
collectRefsForCompletion in class Job

collectRefsForValidation

protected void collectRefsForValidation(IJobRefs aJobRefs)
Specified by:
collectRefsForValidation in class Job

doExecuteCreation

public void doExecuteCreation(IConstraintViolations aViolations)
Specified by:
doExecuteCreation in class Job

doExecuteCompletion

public void doExecuteCompletion(IConstraintViolations aViolations)
Specified by:
doExecuteCompletion in class Job

doExecuteValidation

public void doExecuteValidation(IConstraintViolations aViolations)
Specified by:
doExecuteValidation in class Job

getComponent

public IComponent getComponent(IRef aGlobalRef,
                               boolean aMustBeValidated)
Description copied from interface: IElementHelper
Resolves a component reference. Depend on the usage of the component it may be sufficient that a component is created but not yet validated in order to be retrieved.

Specified by:
getComponent in interface IElementHelper
Parameters:
aGlobalRef - (required).
aMustBeValidated - Determines if the retrieved component must have been validated or not. If the component is not yet validated and true is specified for this parameter then null is returned.
Returns:
(optional).

addSubJob

public void addSubJob(IComponentJobHelper aHelper,
                      IComponentSetter aComponentSetter)
Description copied from interface: IElementHelper
Creates a sub job and adds it to this job.

Specified by:
addSubJob in interface IElementHelper
Parameters:
aHelper - (required).
aComponentSetter - (required).

getDescription

public java.lang.String getDescription()
Description copied from interface: IJob
Gets a short description of the job.

Specified by:
getDescription in interface IJob
Returns:
A string (required).