001/*
002// $Id: SymbolType.java 482 2012-01-05 23:27:27Z jhyde $
003//
004// Licensed to Julian Hyde under one or more contributor license
005// agreements. See the NOTICE file distributed with this work for
006// additional information regarding copyright ownership.
007//
008// Julian Hyde licenses this file to you under the Apache License,
009// Version 2.0 (the "License"); you may not use this file except in
010// compliance with the License. You may obtain a copy of the License at:
011//
012// http://www.apache.org/licenses/LICENSE-2.0
013//
014// Unless required by applicable law or agreed to in writing, software
015// distributed under the License is distributed on an "AS IS" BASIS,
016// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017// See the License for the specific language governing permissions and
018// limitations under the License.
019*/
020package org.olap4j.type;
021
022/**
023 * The type of a symbolic expression.
024 *
025 * <p>Symbols are identifiers which occur in particular function calls,
026 * generally to indicate an option for how the function should be executed.
027 * They are similar to an enumerated type in other
028 * languages.
029 *
030 * <p>For example, the optional 3rd argument to the <code>Order</code> function
031 * can be one of the symbols <code>ASC</code>, <code>DESC</code>,
032 * <code>BASC</code>, <code>BDESC</code>. The signature of the
033 * <code>Order</code> function is therefore
034 *
035 * <blockquote>
036 * <code>Order(&lt;Set&gt;, &lt;Scalar expression&gt; [, &lt;Symbol&gt;])</code>
037 * </blockquote>
038 *
039 * and
040 *
041 * <blockquote>
042 * <code>Order([Store].Members, [Measures].[Unit Sales], BDESC)</code>
043 * </blockquote>
044 *
045 * would be a valid call to the function.
046 *
047 * @author jhyde
048 * @since Feb 17, 2005
049 * @version $Id: SymbolType.java 482 2012-01-05 23:27:27Z jhyde $
050 */
051public class SymbolType extends ScalarType {
052
053    /**
054     * Creates a symbol type.
055     */
056    public SymbolType() {
057    }
058
059}
060
061// End SymbolType.java