org.eclipse.ohf.stem.internal.data
Class ScenarioRecord

java.lang.Object
  extended by org.eclipse.ohf.stem.internal.data.IdentifiableRecord
      extended by org.eclipse.ohf.stem.internal.data.ScenarioRecord
All Implemented Interfaces:
java.lang.Comparable<IdentifiableRecord>
Direct Known Subclasses:
ScenarioRecord.DiseaseScenarioRecord

public abstract class ScenarioRecord
extends IdentifiableRecord

This class represents a Scenario and its metadata.


Nested Class Summary
static class ScenarioRecord.DiseaseScenarioRecord
          This class represents a Scenario with a disease model.
 
Nested classes/interfaces inherited from class org.eclipse.ohf.stem.internal.data.IdentifiableRecord
IdentifiableRecord.AdminLevel
 
Field Summary
static java.lang.String SCENARIO_RECORD_TYPE_NAME
          The name of the type of IdentifiableRecord this is.
 
Fields inherited from class org.eclipse.ohf.stem.internal.data.IdentifiableRecord
BIBLIOGRAPHIC_CITATION_PROPERTY, CONTRIBUTOR_PROPERTY, COVERAGE_PROPERTY, CREATED_PROPERTY, CREATOR_PROPERTY, DATE_PROPERTY, DESCRIPTION_PROPERTY, FORMAT_PROPERTY, identifiableURIPrefix, IDENTIFIER_PROPERTY, LANGUAGE_PROPERTY, LICENSE_PROPERTY, PUBLISHER_PROPERTY, RELATION_PROPERTY, REQUIRED_PROPERTY, RIGHTS_PROPERTY, SERIALIZATION_DATE_RANGE_FORMAT_1_DATE, SERIALIZATION_DATE_RANGE_FORMAT_1_DATE_YEAR, SERIALIZATION_DATE_RANGE_FORMAT_2_DATES, SOURCE_PROPERTY, SPATIAL_PROPERTY, SUBJECT_PROPERTY, TITLE_PROPERTY, TYPE_PROPERTY, VALID_PROPERTY
 
Constructor Summary
ScenarioRecord(java.lang.String scenarioName, ModelRecord modelRecord, java.util.List<DecoratorRecord> decorators, long timeIncrement, SequencerRecord sequencerRecord, java.lang.String catagory)
           
 
Method Summary
 java.lang.String getCatagory()
           
 ModelRecord getModelRecord()
           
 int getNumEdges()
           
 int getNumLabels()
           
 int getNumModelDecorators()
           
 int getNumNodes()
           
 int getNumScenarioDecorators()
           
 Scenario getScenario()
           
 
Methods inherited from class org.eclipse.ohf.stem.internal.data.IdentifiableRecord
addAdminLevel, addAdminLevel, addAdminLevels, compareTo, getAdminLevels, getAdminLevelsAsString, getAdminLevelsMaxToMin, getDublinCore, getEndDate, getIdentifiable, getMaxAdminLevel, getMinAdminLevel, getNumAdminLevels, getStartDate, inDateRange, isYounger, serialize, serializeIdentifiable, setDublinCore, setEndDate, setIdentifiable, setStartDate
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SCENARIO_RECORD_TYPE_NAME

public static final java.lang.String SCENARIO_RECORD_TYPE_NAME
The name of the type of IdentifiableRecord this is.

See Also:
Constant Field Values
Constructor Detail

ScenarioRecord

public ScenarioRecord(java.lang.String scenarioName,
                      ModelRecord modelRecord,
                      java.util.List<DecoratorRecord> decorators,
                      long timeIncrement,
                      SequencerRecord sequencerRecord,
                      java.lang.String catagory)
Parameters:
scenarioName - the name of the Scenario
modelRecord - the ModelRecord containing the Scenario's Model
decorators - the Scenario's Decorators.
timeIncrement - the number of milliseconds in each simulation cycle
sequencerRecord - the SequencerRecord containing the ScenarioFactory's Sequencer.
catagory -
Method Detail

getScenario

public Scenario getScenario()
Returns:
the Scenario

getModelRecord

public final ModelRecord getModelRecord()
Returns:
the modelRecord

getNumEdges

public int getNumEdges()
Specified by:
getNumEdges in class IdentifiableRecord
Returns:
the number of Edges in the Identifiable
See Also:
IdentifiableRecord.getNumEdges()

getNumLabels

public int getNumLabels()
Specified by:
getNumLabels in class IdentifiableRecord
Returns:
the number of Labels in the Identifiable
See Also:
IdentifiableRecord.getNumLabels()

getNumNodes

public int getNumNodes()
Specified by:
getNumNodes in class IdentifiableRecord
Returns:
the number of Nodes in the Identifiable
See Also:
IdentifiableRecord.getNumNodes()

getNumModelDecorators

public int getNumModelDecorators()
Specified by:
getNumModelDecorators in class IdentifiableRecord
Returns:
the number of model Decorators in the Identifiable
See Also:
IdentifiableRecord.getNumModelDecorators()

getNumScenarioDecorators

public int getNumScenarioDecorators()
Specified by:
getNumScenarioDecorators in class IdentifiableRecord
Returns:
the number of scenario Decorators in the Identifiable
See Also:
IdentifiableRecord.getNumScenarioDecorators()

getCatagory

public java.lang.String getCatagory()
Returns:
the catagory