org.eclipse.ohf.stem.definitions.labels
Interface PopulationLabel

All Superinterfaces:
org.eclipse.emf.ecore.EObject, Identifiable, Label, NodeLabel, org.eclipse.emf.common.notify.Notifier, SanityChecker, StaticNodeLabel
All Known Implementing Classes:
PopulationLabelImpl

public interface PopulationLabel
extends StaticNodeLabel

This interface defines a class in an EMF model for PopulationLabel.


Field Summary
static java.lang.String BIRD
          Generic bird population.
static java.lang.String BIRD_CHICKEN
          Chicken population.
static java.lang.String BIRD_DUCK
          Duck population.
static java.lang.String copyright
           
static java.lang.String HUMAN
          Generic human population.
static java.lang.String HUMAN_FEMALE_ADULT
          Human adult female population.
static java.lang.String HUMAN_FEMALE_CHILD
          Human child female population.
static java.lang.String HUMAN_MALE
          Human male population.
static java.lang.String HUMAN_MALE_ADULT
          Human adult male population.
static java.lang.String HUMAN_MALE_CHILD
          Human child male population.
static java.lang.String MOSQUITO
          Generic mosquito population.
static java.lang.String MOSQUITO_ANOPHELES
          Anopheles mosquito population.
static java.lang.String SWINE
          Generic swine (pig) population.
static org.eclipse.emf.common.util.URI URI_TYPE_POPULATION_LABEL
          This is the type URI for population labels
static java.lang.String URI_TYPE_POPULATION_LABEL_SEGMENT
          This is the segment of the type URI that prefixes all other segments in a population label type URI.
 
Fields inherited from interface org.eclipse.ohf.stem.core.graph.Label
URI_TYPE_LABEL, URI_TYPE_LABEL_SEGMENT
 
Method Summary
 PopulationLabelValue getCurrentPopulationValue()
           
 java.lang.String getName()
           
 double getPopulatedArea()
          This value can be used to compute a more accurate population density for cases where the area of a node might be quite large while the actual distribution of population members is quite small.
 java.lang.String getPopulationIdentifier()
           
 void setName(java.lang.String value)
          Sets the value of the 'Name' attribute.
 void setPopulatedArea(double value)
          Sets the value of the 'Populated Area' attribute.
 void setPopulationIdentifier(java.lang.String value)
          Sets the value of the 'Population Identifier' attribute.
 
Methods inherited from interface org.eclipse.ohf.stem.core.graph.NodeLabel
getNode, setNode
 
Methods inherited from interface org.eclipse.ohf.stem.core.graph.Label
getCurrentValue, getIdentifiable, getURIOfIdentifiableToBeLabeled, setCurrentValue, setIdentifiable, setURIOfIdentifiableToBeLabeled
 
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

copyright

static final java.lang.String copyright

See Also:
Constant Field Values

URI_TYPE_POPULATION_LABEL_SEGMENT

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

See Also:
Constant Field Values

URI_TYPE_POPULATION_LABEL

static final org.eclipse.emf.common.util.URI URI_TYPE_POPULATION_LABEL
This is the type URI for population labels


HUMAN

static final java.lang.String HUMAN
Generic human population.

See Also:
getPopulationIdentifier(), Constant Field Values

HUMAN_MALE

static final java.lang.String HUMAN_MALE
Human male population.

See Also:
getPopulationIdentifier(), Constant Field Values

HUMAN_MALE_ADULT

static final java.lang.String HUMAN_MALE_ADULT
Human adult male population.

See Also:
getPopulationIdentifier(), Constant Field Values

HUMAN_MALE_CHILD

static final java.lang.String HUMAN_MALE_CHILD
Human child male population.

See Also:
getPopulationIdentifier(), Constant Field Values

HUMAN_FEMALE_ADULT

static final java.lang.String HUMAN_FEMALE_ADULT
Human adult female population.

See Also:
getPopulationIdentifier(), Constant Field Values

HUMAN_FEMALE_CHILD

static final java.lang.String HUMAN_FEMALE_CHILD
Human child female population.

See Also:
getPopulationIdentifier(), Constant Field Values

BIRD

static final java.lang.String BIRD
Generic bird population.

See Also:
getPopulationIdentifier(), Constant Field Values

BIRD_DUCK

static final java.lang.String BIRD_DUCK
Duck population.

See Also:
getPopulationIdentifier(), Constant Field Values

BIRD_CHICKEN

static final java.lang.String BIRD_CHICKEN
Chicken population.

See Also:
getPopulationIdentifier(), Constant Field Values

SWINE

static final java.lang.String SWINE
Generic swine (pig) population.

See Also:
getPopulationIdentifier(), Constant Field Values

MOSQUITO

static final java.lang.String MOSQUITO
Generic mosquito population.

See Also:
getPopulationIdentifier(), Constant Field Values

MOSQUITO_ANOPHELES

static final java.lang.String MOSQUITO_ANOPHELES
Anopheles mosquito population.

See Also:
getPopulationIdentifier(), Constant Field Values
Method Detail

getPopulationIdentifier

java.lang.String getPopulationIdentifier()
Returns:
a string that is a non-NLS'd identifier of the population. e.g. "boys", "birds"

setPopulationIdentifier

void setPopulationIdentifier(java.lang.String value)
Sets the value of the 'Population Identifier' attribute.

Parameters:
value - the new value of the 'Population Identifier' attribute.
See Also:
getPopulationIdentifier()

getName

java.lang.String getName()
Returns:
the NLS'd name of the population

setName

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

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

getCurrentPopulationValue

PopulationLabelValue getCurrentPopulationValue()
Returns:
the current population value

getPopulatedArea

double getPopulatedArea()
This value can be used to compute a more accurate population density for cases where the area of a node might be quite large while the actual distribution of population members is quite small. This would be the case for instance if a node represented a large empty area with a few cities and towns (e.g., The State of Wyoming in the United States). If this optional value value is set, then it represents the smaller area that is actually populated. Typically, this value would not be set and the population density would be computed by using the actual area of the region that this label labels.

Returns:
the actual area that is populated (square kilometers).

setPopulatedArea

void setPopulatedArea(double value)
Sets the value of the 'Populated Area' attribute.

Parameters:
value - the new value of the 'Populated Area' attribute.
See Also:
getPopulatedArea()