IGPElasticSearchQueryTemplate.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.experimental.el.query.template;

import com.google.common.base.Preconditions;
import net.jcip.annotations.Immutable;

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

    IGPElasticSearchQueryTemplate DEFAULT_QUERY_TEMPLATE = new GPElasticSearchQueryTemplate("${", "}");

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

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

    /**
     *
     */
    @Immutable
    class GPElasticSearchQueryTemplate implements IGPElasticSearchQueryTemplate {

        private final String prefix;
        private final String suffix;

        public GPElasticSearchQueryTemplate(String thePrefix, String theSuffix) {
            Preconditions.checkArgument((thePrefix != null) && !(thePrefix.isEmpty()),
                    "The Parameter Prefix must not be null or an Empty String.");
            Preconditions.checkArgument((theSuffix != null) && !(theSuffix.isEmpty()),
                    "The Parameter Suffix must not be null or an Empty String.");
            this.prefix = thePrefix;
            this.suffix = theSuffix;
        }

        /**
         * @return {@link String}
         */
        @Override
        public String getPrefix() {
            return this.prefix;
        }

        /**
         * @return {@link String}
         */
        @Override
        public String getSuffix() {
            return this.suffix;
        }


        @Override
        public String toString() {
            return getClass().getSimpleName() + "{" +
                    " prefix = '" + prefix + '\'' +
                    ", suffix = '" + suffix + '\'' +
                    '}';
        }
    }
}