com.sun.faban.driver.engine
Class Mix

java.lang.Object
  com.sun.faban.driver.engine.Mix

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

FixedSequence, FlatMix, FlatSequenceMix, MatrixMix

public abstract class Mix
extends Object
implements Serializable, Cloneable

Superclass of all mixes.

Author:

Akara Sucharitakul

See Also:

Serialized Form

Nested Class Summary

static class

Mix.Selector The per-thread selector is used in the AgentThread for selection of the operation.

Field Summary

protected String

className The actual class name of the implementing subclass.

Constructor Summary

protected

Mix() Protected constructor ensures Mix cannot be constructed explicitly.

Method Summary

Object	clone() Creates and returns a copy of this object.
abstract void	configure(Element driverConfigNode) Configures/overrides the mix from the driverConfig DOM node read from the configuration file.
abstract FlatMix	flatMix() Returns the flat mix representation of this mix.
protected Logger	getLogger() Instead of accessing the logger directly, we'll have to access it through this method all the time as serialization may cause the logger to become null.
static Mix	getMix(Class<?> driverClass) Factory for obtaining the correct mix from the driver class.
abstract void	init(Class<?> driverClass, Annotation a) Initializes this mix according to the annotation.
abstract void	normalize() Normalizes the mix so it is ready for use in selections.
abstract Mix.Selector	selector(Random random) Obtains the per-thread and per-driver instance selector.

Methods inherited from class java.lang.Object

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

Field Detail

className

protected String className

The actual class name of the implementing subclass.

Constructor Detail

Mix

protected Mix()

Protected constructor ensures Mix cannot be constructed explicitly.

Method Detail

getMix

public static Mix getMix(Class<?> driverClass)
                  throws DefinitionException

Factory for obtaining the correct mix from the driver class. This factory has the knowledge about each mix and how to instantiate it.

Parameters:

driverClass - The originating driver class

Returns:

An instance of the appropriate mix subclass

Throws:

DefinitionException - If there is an error in the definition

getLogger

protected Logger getLogger()

Instead of accessing the logger directly, we'll have to access it through this method all the time as serialization may cause the logger to become null.

Returns:

The logger for this class

clone

public Object clone()

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

 x.clone() != x

will be true, and that the expression:

 x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

 x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

The method clone for class Object performs a specific cloning operation. First, if the class of this object does not implement the interface Cloneable, then a CloneNotSupportedException is thrown. Note that all arrays are considered to implement the interface Cloneable. Otherwise, this method creates a new instance of the class of this object and initializes all its fields with exactly the contents of the corresponding fields of this object, as if by assignment; the contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of this object, not a "deep copy" operation.

The class Object does not itself implement the interface Cloneable, so calling the clone method on an object whose class is Object will result in throwing an exception at run time.

Overrides:

clone in class Object

Returns:

a clone of this instance.

See Also:

Cloneable

init

public abstract void init(Class<?> driverClass,
                          Annotation a)
                   throws DefinitionException

Initializes this mix according to the annotation.

Parameters:

driverClass - The driver class annotating this mix

a - The annotation

Throws:

DefinitionException - If there is an error in the annotation

configure

public abstract void configure(Element driverConfigNode)
                        throws ConfigurationException

Configures/overrides the mix from the driverConfig DOM node read from the configuration file.

Parameters:

driverConfigNode - The driverConfig DOM node

Throws:

ConfigurationException - If there is a configuration error

normalize

public abstract void normalize()

Normalizes the mix so it is ready for use in selections. This normalization adjusts each mix to be between 0.0d and 1.0d and the sum of each selectable mix to be 1.0d

flatMix

public abstract FlatMix flatMix()

Returns the flat mix representation of this mix. This is used for consistent reporting.

Returns:

The flat mix representation.

selector

public abstract Mix.Selector selector(Random random)

Obtains the per-thread and per-driver instance selector.

Parameters:

random - The per-thread random value generator

Returns:

The selector to be used by the driver