001/*
002// $Id: Quoting.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.mdx;
021
022/**
023 * Enumeration of styles by which the component of an identifier can be
024 * quoted.
025 *
026 * @see org.olap4j.mdx.IdentifierSegment
027 *
028 * @version $Id: Quoting.java 482 2012-01-05 23:27:27Z jhyde $
029 * @author jhyde
030 */
031public enum Quoting {
032
033    /**
034     * Unquoted identifier, for example "Measures".
035     */
036    UNQUOTED,
037
038    /**
039     * Quoted identifier, for example "[Measures]".
040     */
041    QUOTED,
042
043    /**
044     * Identifier quoted with an ampersand and brackets to indicate a key
045     * value, for example the second segment in "[Employees].&[89]".
046     *
047     * <p>Such a segment has one or more sub-segments. Each segment is
048     * either quoted or unquoted. For example, the second segment in
049     * "[Employees].&[89]&[San Francisco]&CA&USA" has four sub-segments,
050     * two quoted and two unquoted.
051     */
052    KEY,
053}
054
055// End Quoting.java