/*
 *  Copyright 2015 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.content.indexing.solr;

import org.ametys.cms.contenttype.MetadataType;

/**
 * Helper for getting Solr field names.
 */
public final class SolrFieldHelper
{
    
    private static final int __SORT_MAX_CHARS = 50;
    
    private SolrFieldHelper()
    {
        // Hide the default constructor.
    }
    
    /**
     * Get the Solr field name (without analyzing)
     * @param fieldPath The path to metadata
     * @param language The query language.
     * @param fullText <code>true</code> for a full-text query, false otherwise.
     * @return the Solr field name
     */
    public static String getStringIndexingFieldName(String fieldPath, String language, boolean fullText)
    {
        return getIndexingFieldName(MetadataType.STRING, fieldPath, language, fullText);
    }
    
    /**
     * Get the Solr field name (without analyzing)
     * @param type The type
     * @param fieldPath The path to metadata
     * @return the Solr field name
     */
    public static String getIndexingFieldName(MetadataType type, String fieldPath)
    {
        return getIndexingFieldName(type, fieldPath, null, false);
    }
    
    /**
     * Get the Solr field's name (without analyzing)
     * @param type The type
     * @param fieldPath The path to metadata
     * @param language The query language.
     * @return the Solr field's name
     */
    public static String getIndexingFieldName(MetadataType type, String fieldPath, String language)
    {
        return getIndexingFieldName(type, fieldPath, language, false);
    }
    
    /**
     * Get the Solr field name
     * @param type The type
     * @param fieldPath The path to metadata
     * @param language The query language.
     * @param fullText true if field should be analyzed.
     * @return the Solr field name
     */
    public static String getIndexingFieldName(MetadataType type, String fieldPath, String language, boolean fullText)
    {
        return fieldPath + getFieldSuffix(type, language, fullText);
    }
    
    /**
     * Get a field suffix from its type.
     * @param language The query language.
     * @param fullText <code>true</code> for a full-text query, false otherwise.
     * @return the field name suffix.
     */
    public static String getStringFieldSuffix(String language, boolean fullText)
    {
        return getFieldSuffix(MetadataType.STRING, language, fullText);
    }
    
    /**
     * Get the wildcard field suffix
     * @return the field name suffix.
     */
    public static String getWildcardFieldSuffix()
    {
        return "_s_lower";
    }
    
    /**
     * Get the wildcard field suffix
     * @param language The query language.
     * @return the field name suffix.
     */
    public static String getFulltextFieldSuffix(String language)
    {
        return "_txt_" + language;
    }
    
    /**
     * Get a field suffix from its type.
     * @param type the field type.
     * @return the field name suffix.
     */
    public static String getFieldSuffix(MetadataType type)
    {
        return getFieldSuffix(type, null, false);
    }
    
    /**
     * Get a field suffix from its type.
     * @param type the field type.
     * @param language The search language.
     * @param fullText true if the field is indexed full-text, false otherwise.
     * @return the field name suffix.
     */
    public static String getFieldSuffix(MetadataType type, String language, boolean fullText)
    {
        switch (type)
        {
            case STRING:
            case CONTENT:
            case SUB_CONTENT:
            case USER:
                return fullText ? ("_txt_stemmed_" + language) : "_s";
            case RICH_TEXT:
                return "_txt_stemmed_" + language;
            case LONG:
                return "_l";
            case DOUBLE:
                return "_d";
            case BOOLEAN:
                return "_b";
            case DATE:
            case DATETIME:
                return "_dt";
            case GEOCODE:
                return "_geo";
            case REFERENCE:
                // TODO reference -> to be indexed?
            default:
                // TODO
                break;
        }
        
        return "";
    }
    
    /**
     * Get the Solr field name for sorting
     * @param type The type
     * @param metadataPath The path to metadata
     * @return the Solr field name
     */
    public static String getMetadataSortFieldName(MetadataType type, String metadataPath)
    {
        return metadataPath + getSortFieldSuffix(type);
    }
    
    
    /**
     * Get the suffix for sorting
     * @param metaType The type
     * @return The sort field suffix.
     */
    public static String getSortFieldSuffix(MetadataType metaType)
    {
        switch (metaType)
        {
            case STRING:
            case CONTENT:
            case SUB_CONTENT:
            case USER:
                return "_s_sort";
            case LONG:
                return "_l_sort";
            case DOUBLE:
                return "_d_sort";
            case BOOLEAN:
                return "_b_sort";
            case DATE:
            case DATETIME:
                return "_dt_sort";
            case GEOCODE:
                // TODO?
                break;
            case REFERENCE:
                // TODO reference ?
                break;
            default:
                // TODO
                break;
        }
        
        return "";
    }
    
    /**
     * Get the field name for join
     * @param metadataPath The metadata path, separated by '/'
     * @return the join field name
     */
    public static String getJoinFieldName(String metadataPath)
    {
        return metadataPath;
    }
    
    /**
     * Get the sort value for a string.
     * @param string the string to index in a sort field.
     * @return the sort value.
     */
    public static String getSortValue(String string)
    {
        if (string != null)
        {
            int endIndex = Math.min(string.length(), __SORT_MAX_CHARS);
            return string.substring(0, endIndex);
        }
        else
        {
            return "";
        }
    }
    
}