/*
* RapidMiner
*
* Copyright (C) 2001-2011 by Rapid-I and the contributors
*
* Complete list of developers available at our web site:
*
* http://rapid-i.com
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see http://www.gnu.org/licenses/.
*/
package com.rapidminer.operator.tools;
import java.util.LinkedList;
import java.util.List;
import com.rapidminer.operator.Operator;
import com.rapidminer.operator.OperatorDescription;
import com.rapidminer.operator.OperatorException;
import com.rapidminer.operator.ports.DummyPortPairExtender;
import com.rapidminer.operator.ports.PortPairExtender;
import com.rapidminer.parameter.ParameterHandler;
import com.rapidminer.parameter.ParameterType;
import com.rapidminer.parameter.ParameterTypeCategory;
import com.rapidminer.parameter.ParameterTypeInt;
import com.rapidminer.parameter.UndefinedParameterError;
import com.rapidminer.parameter.conditions.EqualTypeCondition;
import com.rapidminer.tools.RandomGenerator;
/**
* Delays the process execution (in non-parallel processing).
*
* @author Tobias Malbrecht
*/
public class DelayOperator extends Operator {
public static class DelayProvider {
public static final String PARAMETER_DELAY = "delay";
public static final String[] DELAY_MODES = { "none" , "fixed" , "random" };
public static final int DELAY_NONE = 0;
public static final int DELAY_FIXED = 1;
public static final int DELAY_RANDOM = 2;
public static final String PARAMETER_DELAY_AMOUNT = "delay_amount";
public static final String PARAMETER_DELAY_MIN_AMOUNT = "min_delay_amount";
public static final String PARAMETER_DELAY_MAX_AMOUNT = "max_delay_amount";
private int minAmount = 0;
private int maxAmount = 1000;
private RandomGenerator randomGenerator = null;
private DelayProvider(int mode, int amount, int minAmount, int maxAmount) {
switch (mode) {
case DELAY_NONE:
this.minAmount = 0;
this.maxAmount = 0;
break;
case DELAY_FIXED:
this.minAmount = amount;
this.maxAmount = amount;
break;
case DELAY_RANDOM:
this.minAmount = minAmount;
this.maxAmount = maxAmount;
this.randomGenerator = RandomGenerator.getGlobalRandomGenerator();
break;
}
}
public void delay() {
try {
if (minAmount == maxAmount) {
Thread.sleep(maxAmount);
} else {
Thread.sleep(randomGenerator.nextIntInRange(minAmount, maxAmount));
}
} catch (InterruptedException e) {
}
}
public static DelayProvider createDelayProvider(ParameterHandler handler) throws UndefinedParameterError {
return new DelayProvider(handler.getParameterAsInt(PARAMETER_DELAY), handler.getParameterAsInt(PARAMETER_DELAY_AMOUNT), handler.getParameterAsInt(PARAMETER_DELAY_MIN_AMOUNT), handler.getParameterAsInt(PARAMETER_DELAY_MAX_AMOUNT));
}
public static List<ParameterType> getParameterTypes(ParameterHandler handler) {
List<ParameterType> types = new LinkedList<ParameterType>();
types.add(new ParameterTypeCategory(PARAMETER_DELAY, "Specifies whether execution should not be delayed, delayed by a fixed or random amount of time.", DELAY_MODES, DELAY_NONE, false));
ParameterType type = new ParameterTypeInt(PARAMETER_DELAY_AMOUNT, "The delay amount in ms.", 0, Integer.MAX_VALUE, 1000, false);
type.registerDependencyCondition(new EqualTypeCondition(handler, PARAMETER_DELAY, DELAY_MODES, true, DELAY_FIXED));
types.add(type);
type = new ParameterTypeInt(PARAMETER_DELAY_MIN_AMOUNT, "The minimum delay amount in ms.", 0, Integer.MAX_VALUE, 0, false);
type.registerDependencyCondition(new EqualTypeCondition(handler, PARAMETER_DELAY, DELAY_MODES, true, DELAY_RANDOM));
types.add(type);
type = new ParameterTypeInt(PARAMETER_DELAY_MAX_AMOUNT, "The maximum delay amount in ms.", 0, Integer.MAX_VALUE, 1000, false);
type.registerDependencyCondition(new EqualTypeCondition(handler, PARAMETER_DELAY, DELAY_MODES, true, DELAY_RANDOM));
types.add(type);
return types;
}
}
private PortPairExtender dummyPorts = new DummyPortPairExtender("through", getInputPorts(), getOutputPorts());
public DelayOperator(OperatorDescription description) {
super(description);
dummyPorts.start();
getTransformer().addRule(dummyPorts.makePassThroughRule());
}
@Override
public void doWork() throws OperatorException {
DelayProvider.createDelayProvider(this).delay();
dummyPorts.passDataThrough();
}
@Override
public List<ParameterType> getParameterTypes() {
return DelayProvider.getParameterTypes(this);
}
}