com.oltpbenchmark.WorkloadConfiguration.java Source code

Introduction

Here is the source code for com.oltpbenchmark.WorkloadConfiguration.java

Source

/*******************************************************************************
 * oltpbenchmark.com
 *  
 *  Project Info:  http://oltpbenchmark.com
 *  Project Members:     Carlo Curino <carlo.curino@gmail.com>
 *             Evan Jones <ej@evanjones.ca>
 *             DIFALLAH Djellel Eddine <djelleleddine.difallah@unifr.ch>
 *             Andy Pavlo <pavlo@cs.brown.edu>
 *             CUDRE-MAUROUX Philippe <philippe.cudre-mauroux@unifr.ch>  
 *              Yang Zhang <yaaang@gmail.com> 
 * 
 *  This library is free software; you can redistribute it and/or modify it under the terms
 *  of the GNU General Public License as published by the Free Software Foundation;
 *  either version 3.0 of the License, or (at your option) any later version.
 * 
 *  This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 *  without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *  See the GNU Lesser General Public License for more details.
 ******************************************************************************/
package com.oltpbenchmark;

import java.lang.reflect.Field;
import java.sql.Connection;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import org.apache.commons.collections15.map.ListOrderedMap;
import org.apache.commons.configuration.XMLConfiguration;

import com.oltpbenchmark.api.TransactionTypes;
import com.oltpbenchmark.types.DatabaseType;
import com.oltpbenchmark.util.StringUtil;

public class WorkloadConfiguration {

    private DatabaseType db_type;
    private String benchmarkName;

    public String getBenchmarkName() {
        return benchmarkName;
    }

    public void setBenchmarkName(String benchmarkName) {
        this.benchmarkName = benchmarkName;
    }

    private String db_connection;
    private String db_name;
    private String db_username;
    private String db_password;
    private String db_driver;
    private double scaleFactor = 1.0;
    private int terminals;
    private int numTxnTypes;

    private XMLConfiguration xmlConfig = null;

    private List<Phase> works = new ArrayList<Phase>();
    private WorkloadState workloadState;

    public WorkloadState getWorkloadState() {
        return workloadState;
    }

    /**
     * Initiate a new benchmark and workload state
     */
    public WorkloadState initializeState(BenchmarkState benchmarkState) {
        assert (workloadState == null);
        workloadState = new WorkloadState(benchmarkState, works, terminals);
        return workloadState;
    }

    private int numberOfPhases = 0;
    private TransactionTypes transTypes = null;
    private int isolationMode = Connection.TRANSACTION_SERIALIZABLE;
    private boolean recordAbortMessages = false;

    public void addWork(int time, int rate, List<String> weights, boolean rateLimited, boolean disabled,
            int active_terminals, Phase.Arrival arrival) {
        works.add(new Phase(benchmarkName, numberOfPhases, time, rate, weights, rateLimited, disabled,
                active_terminals, arrival));
        numberOfPhases++;
    }

    public void setDBType(DatabaseType dbType) {
        db_type = dbType;
    }

    public DatabaseType getDBType() {
        return db_type;
    }

    public void setDBConnection(String database) {
        this.db_connection = database;
    }

    public String getDBConnection() {
        return db_connection;
    }

    public void setDBName(String dbname) {
        this.db_name = dbname;
    }

    public int getNumTxnTypes() {
        return numTxnTypes;
    }

    public void setNumTxnTypes(int numTxnTypes) {
        this.numTxnTypes = numTxnTypes;
    }

    public String getDBName() {
        return db_name;
    }

    public void setDBUsername(String username) {
        this.db_username = username;
    }

    public String getDBUsername() {
        return db_username;
    }

    public void setDBPassword(String password) {
        this.db_password = password;
    }

    public String getDBPassword() {
        return this.db_password;
    }

    public void setDBDriver(String driver) {
        this.db_driver = driver;
    }

    public String getDBDriver() {
        return this.db_driver;
    }

    public void setRecordAbortMessages(boolean recordAbortMessages) {
        this.recordAbortMessages = recordAbortMessages;
    }

    /**
     * Whether each worker should record the transaction's UserAbort messages
     * This primarily useful for debugging a benchmark
     */
    public boolean getRecordAbortMessages() {
        return (this.recordAbortMessages);
    }

    /**
     * Set the scale factor for the database
     * A value of 1 means the default size.
     * A value greater than 1 means the database is larger
     * A value less than 1 means the database is smaller 
     * @param scaleFactor
     */
    public void setScaleFactor(double scaleFactor) {
        this.scaleFactor = scaleFactor;
    }

    /**
     * Return the scale factor of the database size
     * @return
     */
    public double getScaleFactor() {
        return this.scaleFactor;
    }

    /**
     * Return the number of phases specified in the config file
     * @return
     */
    public int getNumberOfPhases() {
        return this.numberOfPhases;
    }

    /**
     * A utility method that init the phaseIterator and dialectMap
     */
    public void init() {
        try {
            Class.forName(this.db_driver);
        } catch (ClassNotFoundException ex) {
            throw new RuntimeException("Failed to initialize JDBC driver '" + this.db_driver + "'", ex);
        }
    }

    public void setTerminals(int terminals) {
        this.terminals = terminals;
    }

    public int getTerminals() {
        return terminals;
    }

    public TransactionTypes getTransTypes() {
        return transTypes;
    }

    public void setTransTypes(TransactionTypes transTypes) {
        this.transTypes = transTypes;
    }

    public List<Phase> getAllPhases() {
        return works;
    }

    public void setXmlConfig(XMLConfiguration xmlConfig) {
        this.xmlConfig = xmlConfig;
    }

    public XMLConfiguration getXmlConfig() {
        return xmlConfig;
    }

    public int getIsolationMode() {
        return isolationMode;
    }

    public void setIsolationMode(String mode) {
        if (mode.equals("TRANSACTION_SERIALIZABLE"))
            this.isolationMode = Connection.TRANSACTION_SERIALIZABLE;
        else if (mode.equals("TRANSACTION_READ_COMMITTED"))
            this.isolationMode = Connection.TRANSACTION_READ_COMMITTED;
        else if (mode.equals("TRANSACTION_REPEATABLE_READ"))
            this.isolationMode = Connection.TRANSACTION_REPEATABLE_READ;
        else if (mode.equals("TRANSACTION_READ_UNCOMMITTED"))
            this.isolationMode = Connection.TRANSACTION_READ_UNCOMMITTED;
        else if (!mode.isEmpty())
            System.out.println("Indefined isolation mode, set to default [TRANSACTION_SERIALIZABLE]");
    }

    @Override
    public String toString() {
        Class<?> confClass = this.getClass();
        Map<String, Object> m = new ListOrderedMap<String, Object>();
        for (Field f : confClass.getDeclaredFields()) {
            Object obj = null;
            try {
                obj = f.get(this);
            } catch (IllegalAccessException ex) {
                throw new RuntimeException(ex);
            }
            m.put(f.getName().toUpperCase(), obj);
        } // FOR
        return StringUtil.formatMaps(m);
    }
}