Package com.yahoo.search.grouping.request

Class AttributeFunction

java.lang.Object

com.yahoo.search.grouping.request.GroupingNode

com.yahoo.search.grouping.request.GroupingExpression

com.yahoo.search.grouping.request.DocumentValue

com.yahoo.search.grouping.request.AttributeFunction

public class AttributeFunction
extends DocumentValue

This class represents a document attribute function in a GroupingExpression. It evaluates to the value of the named attribute in the input Hit.

Author:

Simon Thoresen Hult, bratseth

Constructor Summary

Constructors

Constructor	Description
AttributeFunction(String attributeName)	Constructs a new instance of this class.

Method Summary

Modifier and Type	Method	Description
AttributeFunction	copy()	Returns a deep copy of this
String	getAttributeName()	Returns the name of the attribute to retrieve from the input hit.

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

resolveLevel

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

asImage, asString, getLevel, getLevelOrNull, setLabel, visit

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

Constructor Details

AttributeFunction

public AttributeFunction(String attributeName)

Constructs a new instance of this class.

Parameters:

attributeName - the attribute name to assign to this.

Method Details

copy

public AttributeFunction copy()

Description copied from class: GroupingExpression

Returns a deep copy of this

Specified by:

copy in class GroupingExpression

getAttributeName

public String getAttributeName()

Returns the name of the attribute to retrieve from the input hit.

Returns:

the attribute name.