diff options
Diffstat (limited to 'container-search/src/main/java/com/yahoo/search/grouping/request/DivFunction.java')
-rw-r--r-- | container-search/src/main/java/com/yahoo/search/grouping/request/DivFunction.java | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/container-search/src/main/java/com/yahoo/search/grouping/request/DivFunction.java b/container-search/src/main/java/com/yahoo/search/grouping/request/DivFunction.java new file mode 100644 index 00000000000..9ed263362fa --- /dev/null +++ b/container-search/src/main/java/com/yahoo/search/grouping/request/DivFunction.java @@ -0,0 +1,43 @@ +// Copyright 2016 Yahoo Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. +package com.yahoo.search.grouping.request; + +import java.util.List; + +/** + * This class represents a div-function in a {@link GroupingExpression}. It evaluates to a number that equals the result + * of dividing the results of all arguments in the order they were given to the constructor (divide first argument by + * second, result by third, ...). + * + * @author <a href="mailto:simon@yahoo-inc.com">Simon Thoresen</a> + */ +public class DivFunction extends FunctionNode { + + /** + * Constructs a new instance of this class. + * + * @param arg1 The first compulsory argument, must evaluate to a number. + * @param arg2 The second compulsory argument, must evaluate to a number. + * @param argN The optional arguments, must evaluate to a number. + */ + public DivFunction(GroupingExpression arg1, GroupingExpression arg2, GroupingExpression... argN) { + this(asList(arg1, arg2, argN)); + } + + private DivFunction(List<GroupingExpression> args) { + super("div", args); + } + + /** + * Constructs a new instance of this class from a list of arguments. + * + * @param args The arguments to pass to the constructor. + * @return The created instance. + * @throws IllegalArgumentException Thrown if the number of arguments is less than 2. + */ + public static DivFunction newInstance(List<GroupingExpression> args) { + if (args.size() < 2) { + throw new IllegalArgumentException("Expected 2 or more arguments, got " + args.size() + "."); + } + return new DivFunction(args); + } +} |