001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.search.solr;
029
030/**
031 * Utilities for building and analyzing Solr queries.
032 */
033public class CmsSolrQueryUtil {
034
035    /** The prefix to distinguish a Geo filter query from other filter queries. */
036    public static final String GEO_FILTER_QUERY_PREFIX = "{!geofilt";
037
038    /**
039     * Composes a Geo filter query string for given parameters.
040     * @param fieldName the field name
041     * @param coordinates the coordinates
042     * @param radius the search radius
043     * @param units the units of the search radius
044     * @return the Geo filter query string
045     */
046    public static String composeGeoFilterQuery(String fieldName, String coordinates, String radius, String units) {
047
048        return GEO_FILTER_QUERY_PREFIX
049            + " sfield="
050            + fieldName
051            + " pt="
052            + coordinates
053            + " d="
054            + radius
055            + " units="
056            + units
057            + "}";
058    }
059}