ds.funnel.traffic.factory

Class ComponentSpecification

java.lang.Object

ds.funnel.traffic.factory.ComponentSpecification

Direct Known Subclasses:

ComplexComponentSpecification

public class ComponentSpecification
extends java.lang.Object

An instance of the ComponentSpecification class contains all of the information needed to create a component for a TrafficGenerator. It stores the type of component which should be created, as well as a list of parameters with which to initialize the component. The ComponentSpecification purely holds the data for another class to act upon; it does not manipulate the data nor check anything for validity, etc.

Author:

Kira Lindburg

Constructor Summary

Constructors

Constructor and Description
ComponentSpecification() Creates a new specification with undefined main and specific types, and an empty parameter list.
ComponentSpecification(ComponentType mainType) Creates a new specification with the given main type, an undefined specific type, and an empty parameter list.
ComponentSpecification(ComponentType mainType, int specificType) Creates a new specification with the given main and specific types, and an empty parameter list.
ComponentSpecification(ComponentType mainType, int specificType, java.lang.String... parameters) Creates a new specification with the given parameter list and types.

Method Summary

Modifier and Type	Method and Description
void	addComponentParameter(java.lang.String parameterToAdd) Adds the given parameter to the list of parameters stored in this specification, at the end of the list.
java.util.List<java.lang.String>	getComponentParameters()
java.lang.String	getConfigurationString()
ComponentType	getMainComponentType()
int	getSpecificComponentType()
void	setComponentParameters(java.util.List<java.lang.String> newComponentParameters) Sets the list of parameters stored in this component specification to the provided list, overwriting all previous parameters.
void	setMainComponentType(ComponentType newComponentType) Sets the basic component type (packet generator, packet size distribution, etc) described by this specification to the provided type identifier.
void	setSpecificComponentType(int specificComponentType) Sets the specific component type (random, normal, etc) described by this specification to the provided type identifier.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ComponentSpecification

public ComponentSpecification()

Creates a new specification with undefined main and specific types, and an empty parameter list.

ComponentSpecification

public ComponentSpecification(ComponentType mainType)

Creates a new specification with the given main type, an undefined specific type, and an empty parameter list.

Parameters:

mainType - integer which identifies the basic type of component this specification will describe, such as PacketSizeDistribution or PacketGenerator; this should be one of the values defined within ComponentType

ComponentSpecification

public ComponentSpecification(ComponentType mainType,
                              int specificType)

Creates a new specification with the given main and specific types, and an empty parameter list.

Parameters:

mainType - integer identifying the basic type of component, such as PacketSizeDistribution or PacketGenerator, this component specification will describe; this should be one of the values defined in ComponentType

specificType - integer identifying the specific type, such as bursty or normal, of component that this component specification will describe; this varies depending upon the main component type, and should be one of the values defined in PacketGeneratorType, SizeDistributionType, or TimeDistributionType

ComponentSpecification

public ComponentSpecification(ComponentType mainType,
                              int specificType,
                              java.lang.String... parameters)

Creates a new specification with the given parameter list and types.

Parameters:

mainType - integer identifying the basic type of component, such as or PacketGenerator, this component specification will describe; this should be one of the values defined in ComponentType

specificType - integer identifying the specific type, such as bursty or normal, of component that this component specification will describe; this varies depending upon the main component type, and should be one of the values defined in Type, PacketGeneratorType, SizeDistributionType, or TimeDistributionType

parameters - the parameters for a component of the given type

Method Detail

getMainComponentType

public ComponentType getMainComponentType()

Returns:

integer indicating basic type of component (, packet generator, etc) described by this specification

setMainComponentType

public void setMainComponentType(ComponentType newComponentType)

Sets the basic component type (packet generator, packet size distribution, etc) described by this specification to the provided type identifier.

getSpecificComponentType

public int getSpecificComponentType()

Returns:

an integer indicating specific type of component (random, normal, etc) described by this specification

setSpecificComponentType

public void setSpecificComponentType(int specificComponentType)

Sets the specific component type (random, normal, etc) described by this specification to the provided type identifier.

getComponentParameters

public java.util.List<java.lang.String> getComponentParameters()

Returns:

the list of component parameters stored in this specification

setComponentParameters

public void setComponentParameters(java.util.List<java.lang.String> newComponentParameters)

Sets the list of parameters stored in this component specification to the provided list, overwriting all previous parameters.

addComponentParameter

public void addComponentParameter(java.lang.String parameterToAdd)

Adds the given parameter to the list of parameters stored in this specification, at the end of the list.

getConfigurationString

public java.lang.String getConfigurationString()

Returns:

a string representation of this ComponentSpecification which could be parsed by the ConfigurationParser

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object