com.sun.faban.driver.engine
Class MatrixMix

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

All Implemented Interfaces:

Serializable, Cloneable

public class MatrixMix
extends Mix

The implementation of the matrix mix annotation, provides all utilities for matrix mix.

Author:

Akara Sucharitakul

See Also:

Serialized Form

Nested Class Summary

static class

MatrixMix.Selector Selector implementation for the matrix mix.

Field Summary

Fields inherited from class com.sun.faban.driver.engine.Mix

className

Constructor Summary

MatrixMix()

Method Summary

Object	clone() Creates and returns a copy of this object.
void	configure(Element driverConfigNode) Configures/overrides the mix from the driverConfig DOM node read from the configuration file.
FlatMix	flatMix() Calculates flat mix ratios from a matrix mix.
void	init(Class<?> driverClass, Annotation a) Initializes this mix according to the annotation.
void	normalize() Normalizes the mix so each row will have a sum of 1.0d.
MatrixMix.Selector	selector(Random random) Obtains the per-thread and per-driver instance selector.
String	toString() Provides a string representation of this MatrixMix.
void	validate() Validates the mix spec in the benchmark definitions to ensure all the rows and columns are valid.

Methods inherited from class com.sun.faban.driver.engine.Mix

getLogger, getMix

Methods inherited from class java.lang.Object

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

Constructor Detail

MatrixMix

public MatrixMix()

Method Detail

init

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

Initializes this mix according to the annotation.

Specified by:

init in class Mix

Parameters:

driverClass - The driver class annotating this mix

a - The annotation

Throws:

DefinitionException - If there is an error in the annotation

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 Mix

Returns:

a clone of this instance.

See Also:

Cloneable

configure

public void configure(Element driverConfigNode)
               throws ConfigurationException

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

Specified by:

configure in class Mix

Parameters:

driverConfigNode - The driverConfig DOM node

Throws:

ConfigurationException - If there is a configuration error

validate

public void validate()
              throws DefinitionException

Validates the mix spec in the benchmark definitions to ensure all the rows and columns are valid.

Throws:

DefinitionException - Found missing or invalid row/column

normalize

public void normalize()

Normalizes the mix so each row will have a sum of 1.0d. This is important as we do not require the spec input to sum to this amount but the selector (doMenu) will base the random number generator to 1.

Specified by:

normalize in class Mix

flatMix

public FlatMix flatMix()

Calculates flat mix ratios from a matrix mix. The matrix must be checked and adjusted before calculating the flat mix or otherwise runtime exceptions or divergence (infinite loops) may occur.

Specified by:

flatMix in class Mix

Returns:

the flat mix equivalent of this mix

toString

public String toString()

Provides a string representation of this MatrixMix.

Overrides:

toString in class Object

Returns:

The string representation

See Also:

Object.toString()

selector

public MatrixMix.Selector selector(Random random)

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

Specified by:

selector in class Mix

Parameters:

random - The per-thread random value generator

Returns:

The selector to be used by the driver