/*
 *  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.search.model;

import java.util.Collection;
import java.util.Collections;
import java.util.Map;

import org.apache.avalon.framework.configuration.Configuration;
import org.apache.solr.common.SolrInputDocument;

import org.ametys.cms.contenttype.MetadataType;
import org.ametys.cms.repository.Content;
import org.ametys.cms.search.SearchField;
import org.ametys.cms.search.query.Query;
import org.ametys.cms.search.query.Query.Operator;
import org.ametys.cms.search.solr.schema.SchemaDefinition;
import org.ametys.runtime.i18n.I18nizableText;
import org.ametys.runtime.parameter.Enumerator;

/**
 * Represents a universal property of a {@link Content} (content types, language, current workflow step, ...)
 */
public interface SystemProperty
{
    
    /**
     * Get the system property ID.
     * @return The property ID.
     */
    String getId();
    
    /**
     * Get the system property label.
     * @return The property label.
     */
    I18nizableText getLabel();
    
    /**
     * Get the system property description.
     * @return The property description.
     */
    I18nizableText getDescription();
    
    /**
     * Get the property type.
     * @return the property type.
     */
    MetadataType getType();
    
    /**
     * Get the multiple status of the property.
     * @return <code>true</code> if the property can have multiple values, <code>false</code> otherwise.
     */
    boolean isMultiple();
    
    /**
     * Get the definition of an enumerator.
     * @param contentTypes The model's content types.
     * @param configuration The enumerator configuration.
     * @return The enumerator definition or null if the property is not enumerated.
     */
    EnumeratorDefinition getEnumeratorDefinition(Collection<String> contentTypes, Configuration configuration);
    
    /**
     * In case of a Content reference field, the content type ID.
     * @return the content type ID.
     */
    String getContentTypeId();
    
    /**
     * Get if the property can be searched on (i.e. used in a SearchCriterion).
     * @return <code>true</code> if the property can be searched on, <code>false</code> otherwise.
     */
    boolean isSearchable();
    
    /**
     * Get if the property can be displayed (i.e. used in a ResultField).
     * @return <code>true</code> if the property can be displayed, <code>false</code> otherwise.
     */
    boolean isDisplayable();
    
    /**
     * Get if the property can be sorted on.
     * @return <code>true</code> if the property can be sorted on, <code>false</code> otherwise.
     */
    boolean isSortable();
    
    /**
     * Get the {@link Query} associated to the given value.
     * @param value the user-submitted value for this property.
     * @param operator In advanced search mode, the operator chosen by the user. <code>null</code> to use the criterion-defined operator (simple search mode).
     * @param language The current search language.
     * @param contextualParameters the search contextual parameters.
     * @return The {@link Query} associated to the given value.
     */
    Query getQuery(Object value, Operator operator, String language, Map<String, Object> contextualParameters);
    
    /**
     * Get the default widget to use when rendering this property as a criterion.
     * @return The default widget to use, or <code>null</code> if no specific widget is necessary.
     */
    String getWidget();
    
    /**
     * Get the widget parameters.
     * @return The widget parameters as a Map.
     */
    Map<String, I18nizableText> getWidgetParameters();
    
    /**
     * Get the renderer.
     * @return The column renderer.
     */
    String getRenderer();
    
    /**
     * Get the property column converter.
     * @return The property column converter.
     */
    String getConverter();
    
    /**
     * Get the column width.
     * @return the default column width, can be null.
     */
    Integer getColumnWidth();
    
    /**
     * Index the system property in a solr document.
     * @param content The content to index.
     * @param document The solr document to index into.
     */
    void index(Content content, SolrInputDocument document);
    
//    /**
//     * Get the name of the field to use when indexing this property.
//     * @return The field name.
//     */
//    String getField();
    
    /**
     * Get the {@link SearchField} representing this system property.
     * @return The search field representing this system property.
     */
    SearchField getSearchField();
    
    /**
     * Get the value represented by this field in the given result content.
     * @param content the result content.
     * @return the content field value (cast to the appropriate object).
     */
    Object getValue(Content content);
    
    /**
     * Get the value represented by this field in the given result content.
     * @param content the result content.
     * @return the content field value (cast to the appropriate object).
     */
    Object getFullValue(Content content);
    
    /**
     * Get the sort value represented by this field in the given result content.
     * @param content the result content.
     * @return the content sort value, must be scalar (String, long, double, Date).
     */
    Object getSortValue(Content content);
    
    /**
     * Get the schema definitions brought by this property.
     * @return The schema definitions used by this property.
     */
    Collection<SchemaDefinition> getSchemaDefinitions();
    
    /**
     * Representation of an Enumerator, used to generate an Enumerator on the fly.
     */
    class EnumeratorDefinition
    {
        
        private boolean _isStatic;
        
        private Class<? extends Enumerator> _enumeratorClass;
        
        private Configuration _configuration;
        
        private Map<String, I18nizableText> _staticEntries;
        
        /**
         * Build a definition representing a dynamic Enumerator.
         * @param enumeratorClass The enumerator class.
         * @param configuration The enumerator configuration.
         */
        public EnumeratorDefinition(Class<? extends Enumerator> enumeratorClass, Configuration configuration)
        {
            this._enumeratorClass = enumeratorClass;
            this._configuration = configuration;
            this._isStatic = false;
        }
        
        /**
         * Build a definition representing a static Enumerator.
         * @param staticEntries the enumerator entries.
         */
        public EnumeratorDefinition(Map<String, I18nizableText> staticEntries)
        {
            this._staticEntries = staticEntries;
            this._isStatic = true;
        }
        
        public boolean isStatic()
        {
            return _isStatic;
        }
        
        public Class<? extends Enumerator> getEnumeratorClass()
        {
            return _enumeratorClass;
        }
        
        public Configuration getConfiguration()
        {
            return _configuration;
        }
        
        public Map<String, I18nizableText> getStaticEntries()
        {
            return Collections.unmodifiableMap(_staticEntries);
        }
        
    }
    
}