001/*
002// This software is subject to the terms of the Eclipse Public License v1.0
003// Agreement, available at the following URL:
004// http://www.eclipse.org/legal/epl-v10.html.
005// You must accept the terms of that agreement to use this software.
006//
007// Copyright (C) 2006-2007 Pentaho
008// All Rights Reserved.
009*/
010package mondrian.calc;
011
012import mondrian.olap.Evaluator;
013
014/**
015 * Compiled expression whose result is a {@link String}.
016 *
017 * <p>When implementing this interface, it is convenient to extend
018 * {@link mondrian.calc.impl.AbstractStringCalc}, but it is not required.
019 *
020 * @author jhyde
021 * @since Sep 26, 2005
022 */
023public interface StringCalc extends Calc {
024    /**
025     * Evaluates this expression to yield a {@link String} value.
026     *
027     * @param evaluator Evaluation context
028     * @return evaluation result
029     */
030    String evaluateString(Evaluator evaluator);
031}
032
033// End StringCalc.java