/*
 *  Copyright 2014 Anyware Services
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package org.ametys.cms.search.query;

import org.ametys.cms.content.indexing.solr.SolrFieldNames;
import org.ametys.cms.search.QueryBuilder;

/**
 * A {@link Query} realizing a full-text search on contents (search on all properties).
 * Available operators:<ul>
 * <li>SEARCH (default)</li>
 * <li>SEARCH_STEMMED</li>
 * <li>LIKE</li>
 * <li>EQ</li>
 * </ul>
 */
public class FullTextQuery implements Query
{
    
    /** The value to test. */
    protected String _value;
    /** The language. */
    protected String _language;
    /** The operator. */
    protected Operator _operator;
    /** <code>true</code> if the value is already escaped and there is no need to escape again the value during {@link #build() the build of the query}. */
    protected boolean _valueAlreadyEscaped;
    
    /**
     * Build a FullTextQuery.
     * @param value the value.
     */
    public FullTextQuery(String value)
    {
        this(value, Operator.SEARCH);
    }
    
    /**
     * Build a FullTextQuery.
     * @param value the value.
     * @param operator The operator to use.
     */
    public FullTextQuery(String value, Operator operator)
    {
        this(value, null, operator);
    }
    
    /**
     * Build a FullTextQuery.
     * @param value the value.
     * @param language the language.
     */
    public FullTextQuery(String value, String language)
    {
        this(value, language, Operator.SEARCH);
    }
    
    /**
     * Build a FullTextQuery.
     * @param value the value.
     * @param language the language.
     * @param operator The operator to use.
     */
    public FullTextQuery(String value, String language, Operator operator)
    {
        this(value, language, operator, false);
    }
    
    /**
     * Build a FullTextQuery.
     * @param value the value.
     * @param language the language.
     * @param operator The operator to use.
     * @param alreadyEscaped true if the value is already escaped and there is no need to escape again the value during {@link #build() the build of the query}.
     */
    public FullTextQuery(String value, String language, Operator operator, boolean alreadyEscaped)
    {
        _value = value;
        _language = language;
        _operator = operator;
        _valueAlreadyEscaped = alreadyEscaped;
    }
    
    /**
     * Get the value.
     * @return the value.
     */
    public String getValue()
    {
        return _value;
    }
    
    /**
     * Get the language.
     * @return the language.
     */
    public String getLanguage()
    {
        return _language;
    }
    
    /**
     * Get the operator to use.
     * @return the operator.
     */
    public Operator getOperator()
    {
        return _operator;
    }
    
    @Override
    public String build() throws QuerySyntaxException
    {
        // TODO params?
        String language = _language != null ? _language : QueryBuilder.DEFAULT_LANGUAGE;
        
        StringQuery.checkStringValue(_value);
        
        String escapedValue = _valueAlreadyEscaped ? _value : StringQuery.escapeStringValue(_value, _operator);
        
        StringBuilder solrQuery = new StringBuilder();
        
        switch (_operator)
        {
            case EQ:
                solrQuery.append(SolrFieldNames.FULL_EXACT_WS)
                         .append(":\"").append(escapedValue).append('"');
                break;
            case LIKE:
                solrQuery.append(SolrFieldNames.FULL_GENERAL)
                         .append(":(").append(escapedValue).append(')');
                break;
            case SEARCH_STEMMED:
                solrQuery.append(SolrFieldNames.FULL_STEMMED_PREFIX).append(language)
                         .append(":(").append(escapedValue).append(')');
                break;
            case SEARCH:
            default:
                solrQuery.append(SolrFieldNames.FULL_PREFIX).append(language)
                         .append(":(").append(escapedValue).append(')');
                break;
        }
        
        return solrQuery.toString();
    }

    @Override
    public int hashCode()
    {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((_language == null) ? 0 : _language.hashCode());
        result = prime * result + ((_operator == null) ? 0 : _operator.hashCode());
        result = prime * result + ((_value == null) ? 0 : _value.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj)
    {
        if (this == obj)
        {
            return true;
        }
        if (obj == null)
        {
            return false;
        }
        if (getClass() != obj.getClass())
        {
            return false;
        }
        FullTextQuery other = (FullTextQuery) obj;
        if (_language == null)
        {
            if (other._language != null)
            {
                return false;
            }
        }
        else if (!_language.equals(other._language))
        {
            return false;
        }
        if (_operator != other._operator)
        {
            return false;
        }
        if (_value == null)
        {
            if (other._value != null)
            {
                return false;
            }
        }
        else if (!_value.equals(other._value))
        {
            return false;
        }
        return true;
    }
}