org.ivoa.simdb.experiment
Class CompositeExperiment

java.lang.Object
  extended by org.ivoa.dm.model.MetadataElement
      extended by org.ivoa.dm.model.MetadataObject
          extended by org.ivoa.simdb.Resource
              extended by org.ivoa.simdb.experiment.Experiment
                  extended by org.ivoa.simdb.experiment.CompositeExperiment
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class CompositeExperiment
extends Experiment

UML Object CompositeExperiment : A CompositeExperiment is a group of experiments run together in a kind of workflow or pipeline mode. They have their own protocol, consiting of sub protocols for the child experiments.

Author:
generated by UML2 Generator tool (UML->XMI->XSLT->java code)
See Also:
Serialized Form

Field Summary
private  java.util.List<ChildExperiment> child
          Collection child : Colelction of associative ChildExperiment classes inidcating which Experiment-s are part of the composite experiment. ( Multiplicity : 1.. )
private static long serialVersionUID
          serial uid = last modification date of the UML model
 
Fields inherited from class org.ivoa.simdb.Resource
classType, jpaVersion
 
Fields inherited from class org.ivoa.dm.model.MetadataObject
id, identity
 
Fields inherited from class org.ivoa.dm.model.MetadataElement
log, metaModelFactory, PRESENT, STRING_BUFFER_CAPACITY, USE_JAXB_META_MODEL
 
Constructor Summary
CompositeExperiment()
          Creates a new CompositeExperiment
 
Method Summary
 void addChild(ChildExperiment pChildExperiment)
          Add a ChildExperiment to the collection
protected  java.lang.StringBuilder deepToString(java.lang.StringBuilder sb, boolean isDeep, java.util.Map<MetadataElement,java.lang.Object> ids)
          Puts the string representation in the given string buffer :
"Type =[class name @ hashcode] : { field name = field value , ...}"
 boolean equals(java.lang.Object object, boolean isDeep)
          Returns equals from id attribute here.
 java.util.List<ChildExperiment> getChild()
          Returns child Collection
 CompositeProtocol getProtocol()
          Returns protocol Reference If the protocol variable is null but its "lazy" version p_protocol is not, that lazy reference will be resolved to the actual object.
 void setChild(java.util.List<ChildExperiment> pChild)
          Defines child Collection
 void setProtocol(CompositeProtocol pProtocol)
          Defines protocol Reference
 
Methods inherited from class org.ivoa.simdb.experiment.Experiment
addAlgorithm, addInputData, addParameter, addRepresentationObject, addService, addSnapshot, addTargetObject, addTargetProcess, getAlgorithm, getInputData, getParameter, getRepresentationObject, getService, getSnapshot, getTargetObject, getTargetProcess, setAlgorithm, setInputData, setParameter, setProtocol, setRepresentationObject, setService, setSnapshot, setTargetObject, setTargetProcess
 
Methods inherited from class org.ivoa.simdb.Resource
addContact, getClassType, getContact, getCreated, getDescription, getJpaVersion, getMainContact, getName, getPublisherDID, getReferenceURL, getStatus, getUpdated, setContact, setCreated, setDescription, setMainContact, setName, setPublisherDID, setReferenceURL, setStatus, setUpdated
 
Methods inherited from class org.ivoa.dm.model.MetadataObject
afterMarshal, afterUnmarshal, baseToString, getId, getIdentity, getIdentityField, getObjectMetaData, hashCode, hashCode, resolve, updateIdentity
 
Methods inherited from class org.ivoa.dm.model.MetadataElement
areEquals, clone, deepToString, deepToString, equals, exists, toString, toString, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
serial uid = last modification date of the UML model

See Also:
Constant Field Values

child

private java.util.List<ChildExperiment> child
Collection child : Colelction of associative ChildExperiment classes inidcating which Experiment-s are part of the composite experiment. ( Multiplicity : 1.. )

Constructor Detail

CompositeExperiment

public CompositeExperiment()
Creates a new CompositeExperiment

Method Detail

getChild

public java.util.List<ChildExperiment> getChild()
Returns child Collection

Returns:
child Collection

setChild

public void setChild(java.util.List<ChildExperiment> pChild)
Defines child Collection

Parameters:
pChild - collection to set

addChild

public void addChild(ChildExperiment pChildExperiment)
Add a ChildExperiment to the collection

Parameters:
pChildExperiment - ChildExperiment to add

getProtocol

public CompositeProtocol getProtocol()
Returns protocol Reference If the protocol variable is null but its "lazy" version p_protocol is not, that lazy reference will be resolved to the actual object.

Overrides:
getProtocol in class Experiment
Returns:
protocol Reference

setProtocol

public void setProtocol(CompositeProtocol pProtocol)
Defines protocol Reference

Parameters:
pProtocol - reference to set

equals

public boolean equals(java.lang.Object object,
                      boolean isDeep)
Returns equals from id attribute here. Child classes can override this method to allow deep equals with attributes / references / collections

Overrides:
equals in class Experiment
Parameters:
object - the reference object with which to compare.
isDeep - true means to call hashCode(sb, true) for all attributes / references / collections which are MetadataElement implementations
Returns:
true if this object is the same as the obj argument; false otherwise.
See Also:
method

deepToString

protected java.lang.StringBuilder deepToString(java.lang.StringBuilder sb,
                                               boolean isDeep,
                                               java.util.Map<MetadataElement,java.lang.Object> ids)
Puts the string representation in the given string buffer :
"Type =[class name @ hashcode] : { field name = field value , ...}"

Overrides:
deepToString in class Experiment
Parameters:
sb - given string buffer to fill
isDeep - true means to call deepToString(sb, true, ids) for all attributes / references / collections which are MetadataElement implementations
ids - identity map to avoid cyclic loops
Returns:
stringbuffer the given string buffer filled with the string representation