// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.search.grouping.request;

/**
 * This class represents a document attribute value in a {@link GroupingExpression}. It evaluates to the value of the
 * named attribute in the input {@link com.yahoo.search.result.Hit}.
 *
 * @author <a href="mailto:simon@yahoo-inc.com">Simon Thoresen</a>
 */
public class AttributeValue extends DocumentValue {

    private final String name;

    /**
     * Constructs a new instance of this class.
     *
     * @param attributeName The attribute name to assign to this.
     */
    public AttributeValue(String attributeName) {
        super(attributeName);
        name = attributeName;
    }

    /**
     * Returns the name of the attribute to retrieve from the input hit.
     *
     * @return The attribute name.
     */
    public String getAttributeName() {
        return name;
    }
}