Package repast.simphony.data2.engine

Class DataSetDescriptor

java.lang.Object

repast.simphony.scenario.AbstractDescriptor

repast.simphony.data2.engine.DataSetDescriptor

All Implemented Interfaces:

Descriptor

public class DataSetDescriptor
extends AbstractDescriptor

Descriptor that defines a single DataSet.

Author:

Nick Collier

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataSetDescriptor.DataSetType

Field Summary

Fields inherited from class repast.simphony.scenario.AbstractDescriptor

scs

Constructor Summary

Constructors

Constructor	Description
DataSetDescriptor(String name)
DataSetDescriptor(String name, DataSetDescriptor.DataSetType type)

Method Summary

Modifier and Type	Method	Description
void	addAggregateDataSource(String id, String className)	Adds an AggregateDataSource by className.
void	addAggregateMethodDataSource(String id, String className, String methodName, AggregateOp aggType)
void	addCountDataSource(String id, String className)
void	addMethodDataSource(String id, String className, String methodName)
void	addNonAggregateDataSource(String id, String className)	Adds a NonAggregateDataSource by className.
void	clearCountDataSources()
void	clearCustomDataSources()
void	clearMethodDataSources()
Iterable<CountSourceDefinition>	countDataSources()
Iterable<CustomDataSourceDefinition>	customAggDataSources()
Iterable<CustomDataSourceDefinition>	customNonAggDataSources()
Iterable<String>	dataSourceIds()
ScheduleParameters	getScheduleParameters()
String	getSourceType()
DataSetDescriptor.DataSetType	getType()
boolean	includeBatchRun()
boolean	includeRandomSeed()
boolean	includeTick()
boolean	isScheduleAtEnd()
Iterable<MethodDataSourceDefinition>	methodDataSources()
void	removeCountDataSource(String id)
void	removeCustomDataSource(String id)
void	removeMethodDataSource(String id)
void	setIncludeBatchRun(boolean inclBatchRun)
void	setIncludeRandomSeed(boolean inclRandomSeed)
void	setIncludeTick(boolean inclTick)
void	setScheduleAtEnd(boolean val)
void	setScheduleParameters(ScheduleParameters scheduleParams)
void	setSourceType(String sourceType)
void	setType(DataSetDescriptor.DataSetType type)

Methods inherited from class repast.simphony.scenario.AbstractDescriptor

addScenarioChangedListener, getName, readResolve, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataSetDescriptor

public DataSetDescriptor(String name)

DataSetDescriptor

public DataSetDescriptor(String name,
                         DataSetDescriptor.DataSetType type)

Method Detail

dataSourceIds

public Iterable<String> dataSourceIds()

getScheduleParameters

public ScheduleParameters getScheduleParameters()

Returns:

the scheduleParams

addNonAggregateDataSource

public void addNonAggregateDataSource(String id,
                                      String className)

Adds a NonAggregateDataSource by className. The specified class must implement NonAggregateDataSource.

Parameters:

className -

addAggregateDataSource

public void addAggregateDataSource(String id,
                                   String className)

Adds an AggregateDataSource by className. The specified class must implementAggregateDataSource.

Parameters:

className -

removeCustomDataSource

public void removeCustomDataSource(String id)

customAggDataSources

public Iterable<CustomDataSourceDefinition> customAggDataSources()

customNonAggDataSources

public Iterable<CustomDataSourceDefinition> customNonAggDataSources()

setScheduleParameters

public void setScheduleParameters(ScheduleParameters scheduleParams)

Parameters:

scheduleParams - the scheduleParams to set

includeTick

public boolean includeTick()

Returns:

the inclTick

setIncludeTick

public void setIncludeTick(boolean inclTick)

Parameters:

inclTick - the inclTick to set

includeBatchRun

public boolean includeBatchRun()

Returns:

the inclBatchRun

setIncludeBatchRun

public void setIncludeBatchRun(boolean inclBatchRun)

Parameters:

inclBatchRun - the inclBatchRun to set

includeRandomSeed

public boolean includeRandomSeed()

Returns:

the inclRandomSeed

setIncludeRandomSeed

public void setIncludeRandomSeed(boolean inclRandomSeed)

Parameters:

inclRandomSeed - the inclRandomSeed to set

getSourceType

public String getSourceType()

Returns:

the targetType

setSourceType

public void setSourceType(String sourceType)

getType

public DataSetDescriptor.DataSetType getType()

Returns:

the type

setType

public void setType(DataSetDescriptor.DataSetType type)

Parameters:

type - the type to set

isScheduleAtEnd

public boolean isScheduleAtEnd()

setScheduleAtEnd

public void setScheduleAtEnd(boolean val)

addMethodDataSource

public void addMethodDataSource(String id,
                                String className,
                                String methodName)

addAggregateMethodDataSource

public void addAggregateMethodDataSource(String id,
                                         String className,
                                         String methodName,
                                         AggregateOp aggType)

addCountDataSource

public void addCountDataSource(String id,
                               String className)

countDataSources

public Iterable<CountSourceDefinition> countDataSources()

removeMethodDataSource

public void removeMethodDataSource(String id)

removeCountDataSource

public void removeCountDataSource(String id)

methodDataSources

public Iterable<MethodDataSourceDefinition> methodDataSources()

clearCountDataSources

public void clearCountDataSources()

clearMethodDataSources

public void clearMethodDataSources()

clearCustomDataSources

public void clearCustomDataSources()