Package com.yahoo.search.grouping.request

Class StringPredefined

java.lang.Object

com.yahoo.search.grouping.request.GroupingNode

com.yahoo.search.grouping.request.GroupingExpression

com.yahoo.search.grouping.request.FunctionNode

com.yahoo.search.grouping.request.PredefinedFunction

com.yahoo.search.grouping.request.StringPredefined

All Implemented Interfaces:

java.lang.Iterable<GroupingExpression>

public class StringPredefined
extends PredefinedFunction

This class represents a predefined bucket-function in a GroupingExpression for expressions that evaluate to a string.

Author:

Simon Thoresen Hult

Constructor Summary

Constructors

Constructor	Description
StringPredefined(GroupingExpression exp, StringBucket arg1, StringBucket... argN)	Constructs a new instance of this class.

Method Summary

Modifier and Type	Method	Description
StringPredefined	copy()	Returns a deep copy of this
StringBucket	getBucket(int i)	Returns the bucket at the given index.
static StringPredefined	newInstance(GroupingExpression exp, java.util.List<StringBucket> args)	Constructs a new instance of this class from a list of arguments.

Methods inherited from class com.yahoo.search.grouping.request.PredefinedFunction

getNumBuckets

Methods inherited from class com.yahoo.search.grouping.request.FunctionNode

args, asList, asList, asList, getArg, getNumArgs, iterator, resolveLevel, visit

Methods inherited from class com.yahoo.search.grouping.request.GroupingExpression

asImage, asString, getLevel, getLevelOrNull, setLabel

Methods inherited from class com.yahoo.search.grouping.request.GroupingNode

getImage, getLabel, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

StringPredefined

public StringPredefined(GroupingExpression exp,
                        StringBucket arg1,
                        StringBucket... argN)

Constructs a new instance of this class.

Parameters:

exp - The expression to evaluate, must evaluate to a string.

arg1 - The compulsory bucket.

argN - The optional buckets.

Method Detail

copy

public StringPredefined copy()

Description copied from class: GroupingExpression

Returns a deep copy of this

Specified by:

copy in class GroupingExpression

getBucket

public StringBucket getBucket(int i)

Description copied from class: PredefinedFunction

Returns the bucket at the given index.

Overrides:

getBucket in class PredefinedFunction

Parameters:

i - The index of the bucket to return.

Returns:

The bucket at the given index.

newInstance

public static StringPredefined newInstance(GroupingExpression exp,
                                           java.util.List<StringBucket> args)

Constructs a new instance of this class from a list of arguments.

Parameters:

exp - The expression to evaluate, must evaluate to a string.

args - The buckets to pass to the constructor.

Returns:

The created instance.

Throws:

java.lang.IllegalArgumentException - Thrown if the list of buckets is empty.