GPOperator.java

/**
 *
 *    geo-platform
 *    Rich webgis framework
 *    http://geo-platform.org
 *   ====================================================================
 *
 *   Copyright (C) 2008-2017 geoSDI Group (CNR IMAA - Potenza - ITALY).
 *
 *   This program is free software: you can redistribute it and/or modify it
 *   under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version. This program is distributed in the
 *   hope that it will be useful, but WITHOUT ANY WARRANTY; without
 *   even the implied warranty of MERCHANTABILITY or FITNESS FOR
 *   A PARTICULAR PURPOSE. See the GNU General Public License
 *   for more details. You should have received a copy of the GNU General
 *   Public License along with this program. If not, see http://www.gnu.org/licenses/
 *
 *   ====================================================================
 *
 *   Linking this library statically or dynamically with other modules is
 *   making a combined work based on this library. Thus, the terms and
 *   conditions of the GNU General Public License cover the whole combination.
 *
 *   As a special exception, the copyright holders of this library give you permission
 *   to link this library with independent modules to produce an executable, regardless
 *   of the license terms of these independent modules, and to copy and distribute
 *   the resulting executable under terms of your choice, provided that you also meet,
 *   for each linked independent module, the terms and conditions of the license of
 *   that module. An independent module is a module which is not derived from or
 *   based on this library. If you modify this library, you may extend this exception
 *   to your version of the library, but you are not obligated to do so. If you do not
 *   wish to do so, delete this exception statement from your version.
 */
package org.geosdi.geoplatform.support.primitive.operator;

import java.util.Collection;

/**
 * @author Giuseppe La Scaleia - CNR IMAA geoSDI Group
 * @email giuseppe.lascaleia@geosdi.org
 */
public interface GPOperator {

    /**
     * @return {@link String}
     */
    String getSymbol();

    /**
     * @param <Type>
     * @return {@link OperatorType}
     */
    <Type extends IOperatorType> Type getOperatorType();

    /**
     *
     */
    @FunctionalInterface
    interface GPOperatorLoader {

        /**
         * @return {@link Collection<GPOperator>}
         */
        Collection<GPOperator> load();
    }

    /**
     *
     */
    interface IOperatorType {

        /**
         * @return {@link String}
         */
        String getType();
    }

    /**
     *
     */
    enum OperatorType implements IOperatorType {

        EQUALS_TO("Equals To"),
        NOT_EQUALS_TO("Not Equals To"),
        GREATER_THAN("Greater Than"),
        GREATER_THAN_OR_EQUAL_TO("Greater Than Or Equal To"),
        LESS_THAN("Less Than"),
        LESS_THAN_OR_EQUAL_TO("Less Than Or Equal To"),
        CONTAINS("Contains"),
        ENDS_WITH("Ends With"),
        STARTS_WITH("Starts With");

        private final String type;

        OperatorType(String theType) {
            this.type = theType;
        }

        /**
         * @return {@link String}
         */
        public String getType() {
            return this.type;
        }

        @Override
        public String toString() {
            return this.type;
        }
    }
}