org.eclipse.ohf.stem.diseasemodels.standard
Interface Infector

All Superinterfaces:
Decorator, org.eclipse.emf.ecore.EObject, Identifiable, NodeDecorator, org.eclipse.emf.common.notify.Notifier, SanityChecker
All Known Subinterfaces:
SIInfector, StandardInfector
All Known Implementing Classes:
InfectorImpl, SIInfectorImpl, StandardInfectorImpl

public interface Infector
extends NodeDecorator

This interface defines a class in an EMF model for the initialization of an infectious population in a disease model.


Field Summary
static java.lang.String URI_TYPE_INFECTOR_SEGMENT
          This is the segment of the type URI that prefixes all other segments in a infector type URI.
 
Method Summary
 StandardDiseaseModel getDiseaseModel()
           
 java.lang.String getDiseaseName()
           
 org.eclipse.emf.common.util.EList<DiseaseModelLabel> getLabelsToInfect()
           
 java.lang.String getPopulationIdentifer()
           
 java.lang.String getTargetISOKey()
           
 org.eclipse.emf.common.util.URI getTargetURI()
           
 void setDiseaseModel(StandardDiseaseModel value)
          Sets the value of the 'Disease Model' reference.
 void setDiseaseName(java.lang.String value)
          Sets the value of the 'Disease Name' attribute.
 void setPopulationIdentifer(java.lang.String value)
          Sets the value of the 'Population Identifer' attribute.
 void setTargetISOKey(java.lang.String value)
          Sets the value of the 'Target ISO Key' attribute.
 void setTargetURI(org.eclipse.emf.common.util.URI value)
          Sets the value of the 'Target URI' attribute.
 
Methods inherited from interface org.eclipse.ohf.stem.core.model.Decorator
decorateGraph, getGraph, getLabelsToUpdate, resetLabels, setGraph, updateLabels
 
Methods inherited from interface org.eclipse.ohf.stem.core.common.Identifiable
getDublinCore, getTypeURI, getURI, sane, setDublinCore, setTypeURI, setURI
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Field Detail

URI_TYPE_INFECTOR_SEGMENT

static final java.lang.String URI_TYPE_INFECTOR_SEGMENT
This is the segment of the type URI that prefixes all other segments in a infector type URI.

See Also:
Constant Field Values
Method Detail

getDiseaseName

java.lang.String getDiseaseName()
Returns:
the name of the disease to be infected

setDiseaseName

void setDiseaseName(java.lang.String value)
Sets the value of the 'Disease Name' attribute.

Parameters:
value - the new value of the 'Disease Name' attribute.
See Also:
getDiseaseName()

getTargetISOKey

java.lang.String getTargetISOKey()
Returns:
the ISO3166 based key for the Region to be infected.

setTargetISOKey

void setTargetISOKey(java.lang.String value)
Sets the value of the 'Target ISO Key' attribute.

Parameters:
value - the new value of the 'Target ISO Key' attribute.
See Also:
getTargetISOKey()

getPopulationIdentifer

java.lang.String getPopulationIdentifer()
Returns:
the identifier of the population that is to be infected

setPopulationIdentifer

void setPopulationIdentifer(java.lang.String value)
Sets the value of the 'Population Identifer' attribute.

Parameters:
value - the new value of the 'Population Identifer' attribute.
See Also:
getPopulationIdentifer()

getDiseaseModel

StandardDiseaseModel getDiseaseModel()
Returns:
the disease model that this infector initializes

setDiseaseModel

void setDiseaseModel(StandardDiseaseModel value)
Sets the value of the 'Disease Model' reference.

Parameters:
value - the new value of the 'Disease Model' reference.
See Also:
getDiseaseModel()

getTargetURI

org.eclipse.emf.common.util.URI getTargetURI()
Returns:
the URI of the node that will receive the infectious population

setTargetURI

void setTargetURI(org.eclipse.emf.common.util.URI value)
Sets the value of the 'Target URI' attribute.

Parameters:
value - the new value of the 'Target URI' attribute.
See Also:
getTargetURI()

getLabelsToInfect

org.eclipse.emf.common.util.EList<DiseaseModelLabel> getLabelsToInfect()
Returns:
the list of DiseaseLabels that this Infector is responsible for "infecting".