ds.funnel.traffic.factory

Class ComplexComponentSpecification

java.lang.Object

ds.funnel.traffic.factory.ComponentSpecification

ds.funnel.traffic.factory.ComplexComponentSpecification

public class ComplexComponentSpecification
extends ComponentSpecification

A ComplexComponentSpecification is a ComponentSpecification which specifies how to construct a 'complex' component for a TrafficGenerator. Here, a 'complex component' is a component which requires one or more 'base components' as parameter(s) in order to be constructed, such as a BurstyTimeDistribution. In addition to the component type and the list of parameters (which should contain any primitive parameters needed for constructing the component), a complex component specification contains a list of component specifications. Each entry in this list should be a component specification which specifies how to construct one of the base components for the complex component.

Author:

Kira Lindburg

Constructor Summary

Constructors

Constructor and Description
ComplexComponentSpecification() Creates a new complex component specification with undefined types and empty parameter and base component lists.
ComplexComponentSpecification(ComponentType mainType) Creates a new complex component specification with the provided main type, undefined specific type, and empty parameter and base component lists.
ComplexComponentSpecification(ComponentType mainType, int specificType) Creates a new complex component specification with the provided types and empty parameter and base component lists.
ComplexComponentSpecification(ComponentType mainType, int specificType, java.util.List<ComponentSpecification> baseComponents, java.lang.String... parameters) Creates a new complex component specification with the provided types, parameter list, and base component list.
ComplexComponentSpecification(ComponentType mainType, int specificType, java.lang.String... parameters) Creates a new complex component specification with the provided types and parameter list, and an empty base component list.

Method Summary

Modifier and Type	Method and Description
void	addBaseComponent(ComponentSpecification specificationToAdd) Adds the provided component specification to the list of base components for this complex component specification, at the end of the list.
java.util.List<ComponentSpecification>	getBaseComponents()
java.lang.String	getConfigurationString()
void	setBaseComponents(java.util.List<ComponentSpecification> newBaseComponents) Sets the list of base components for this complex component specification to the provided list, overwriting any components which were previously stored.
java.lang.String	toString()

Methods inherited from class ds.funnel.traffic.factory.ComponentSpecification

addComponentParameter, getComponentParameters, getMainComponentType, getSpecificComponentType, setComponentParameters, setMainComponentType, setSpecificComponentType

Methods inherited from class java.lang.Object

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

Constructor Detail

ComplexComponentSpecification

public ComplexComponentSpecification()

Creates a new complex component specification with undefined types and empty parameter and base component lists.

ComplexComponentSpecification

public ComplexComponentSpecification(ComponentType mainType)

Creates a new complex component specification with the provided main type, undefined specific type, and empty parameter and base component lists.

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

ComplexComponentSpecification

public ComplexComponentSpecification(ComponentType mainType,
                                     int specificType)

Creates a new complex component specification with the provided types and empty parameter and base component lists.

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

ComplexComponentSpecification

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

Creates a new complex component specification with the provided types and parameter list, and an empty base component 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

parameters - a list containing the primitive type parameters for a component of the given type

ComplexComponentSpecification

public ComplexComponentSpecification(ComponentType mainType,
                                     int specificType,
                                     java.util.List<ComponentSpecification> baseComponents,
                                     java.lang.String... parameters)

Creates a new complex component specification with the provided types, parameter list, and base component 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

parameters - a list containing the primitive type parameters for a component of the given type

baseComponents - a list containing component specifications for any base components needed for a component of this type

Method Detail

getBaseComponents

public java.util.List<ComponentSpecification> getBaseComponents()

Returns:

the list of base components currently stored in this complex component specification

setBaseComponents

public void setBaseComponents(java.util.List<ComponentSpecification> newBaseComponents)

Sets the list of base components for this complex component specification to the provided list, overwriting any components which were previously stored.

addBaseComponent

public void addBaseComponent(ComponentSpecification specificationToAdd)

Adds the provided component specification to the list of base components for this complex component specification, at the end of the list.

getConfigurationString

public java.lang.String getConfigurationString()

Overrides:

getConfigurationString in class ComponentSpecification

Returns:

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

toString

public java.lang.String toString()

Overrides:

toString in class ComponentSpecification