org.openmdx.base.query.Quantifier Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openmdx-dalvik Show documentation
openMDX/Dalvik Library
There is a newer version: 2.18.10
/*
 * ====================================================================
 * Project:     openMDX/Core, http://www.openmdx.org/
 * Description: Quantifier 
 * Owner:       OMEX AG, Switzerland, http://www.omex.ch
 * ====================================================================
 *
 * This software is published under the BSD license as listed below.
 * 
 * Copyright (c) 2009, OMEX AG, Switzerland
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 * 
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * 
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in
 *   the documentation and/or other materials provided with the
 *   distribution.
 * 
 * * Neither the name of the openMDX team nor the names of its
 *   contributors may be used to endorse or promote products derived
 *   from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * 
 * ------------------
 * 
 * This product includes software developed by other organizations as
 * listed in the NOTICE file.
 */
package org.openmdx.base.query;


/**
 * Quantifier
 */
public enum Quantifier implements Code {
    
    /**
     * Universal Quantifier (∀) 
     */
    FOR_ALL(
        (short)1, // code
        '\u2200' // symbol
    ),
    
    /**
     * Existential Quantifier (∃)
     */
    THERE_EXISTS(
        (short)2, // code
        '\u2203' // symbol
    );

    /**
     * Constructor 
     *
     * @param code
     * @param symbol
     */
    private Quantifier(
        short code,
        char symbol
    ){
        this.code = code;
        this.symbol = symbol;
    }
    
    /**
     * The Quantifier's legacy code
     */
    private final short code;
    
    /**
     * The Quantifier's UNICODE symbol
     */
    private final char symbol;

    /**
     * Converts FOR_ALL to THERE_EXISTS and vice versa by leaving null
     */
    public static short invert(short code) {
        switch(code) {
            case 0: return 0;
            case 1: return 2;
            case 2: return 1;
            default: throw new IllegalArgumentException(
                "Invalid quantifier code: " + code
            );
        }
    }
    
    /**
     * Retrieve the Quantifier's code
     * 
     * @return the Quantifier's code
     */
    public short code(){
        return this.code;
    }

    /**
     * Retrieve the Quantifier's UNICODE symbol
     * 
     * @return the Quantifier's UNICODE symbol
     */
    public char symbol() {
        return this.symbol;
    }

    /**
     * Retrieve the Quantifier's code
     * 
     * @param quantifier
     * 
     * @return the Quantifier's code
     */
    public static short codeOf(
        Quantifier quantifier
    ){
        return quantifier == null ? 0 : quantifier.code;
    }
    
    /**
     * Retrieve the Quantifier represented by the given code
     * 
     * @param code
     * 
     * @return the Quantifier represented by the given code
     * 
     * @exception IllegalArgumentException if the code does not represent a Quantifier
     */
    public static Quantifier valueOf(
        short code
    ){
        switch(code){
            case 0: return null;
            case 1: return FOR_ALL;
            case 2: return THERE_EXISTS;
            default: throw new IllegalArgumentException(
                "Invalid quantifier code: " + code
            );
        }
    }

    /**
     * Retrieve the Quantifier represented by the given symbol
     * 
     * @param code
     * 
     * @return the Quantifier represented by the given symbol
     * 
     * @exception IllegalArgumentException if the symbol does not represent a Quantifier
     */
    public static Quantifier valueOf(
        char symbol
    ){
        switch(symbol){
            case ' ': return null;
            case '\u2200': return FOR_ALL;
            case '\u2203': return THERE_EXISTS;
            default: throw new IllegalArgumentException(
                "Invalid quantifier symbol: u" + Integer.toHexString(symbol)
            );
        }
    }
    
}