eu.verdelhan.ta4j.trading.rules.OverIndicatorRule Maven / Gradle / Ivy
Show all versions of ta4j Show documentation
/**
* The MIT License (MIT)
*
* Copyright (c) 2014-2015 Marc de Verdelhan & respective authors (see AUTHORS)
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package eu.verdelhan.ta4j.trading.rules;
import eu.verdelhan.ta4j.Decimal;
import eu.verdelhan.ta4j.Indicator;
import eu.verdelhan.ta4j.TradingRecord;
import eu.verdelhan.ta4j.indicators.simple.ConstantIndicator;
/**
* Indicator-over-indicator rule.
*
* Satisfied when the value of the first {@link Indicator indicator} is strictly greater than the value of the second one.
*/
public class OverIndicatorRule extends AbstractRule {
/** The first indicator */
private Indicator first;
/** The second indicator */
private Indicator second;
/**
* Constructor.
* @param indicator the indicator
* @param threshold a threshold
*/
public OverIndicatorRule(Indicator indicator, Decimal threshold) {
this(indicator, new ConstantIndicator(threshold));
}
/**
* Constructor.
* @param first the first indicator
* @param second the second indicator
*/
public OverIndicatorRule(Indicator first, Indicator second) {
this.first = first;
this.second = second;
}
@Override
public boolean isSatisfied(int index, TradingRecord tradingRecord) {
final boolean satisfied = first.getValue(index).isGreaterThan(second.getValue(index));
traceIsSatisfied(index, satisfied);
return satisfied;
}
}