/*
 *  Copyright 2013 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.ui.model.impl;

import org.apache.avalon.framework.configuration.Configuration;

import org.ametys.cms.contenttype.MetadataType;
import org.ametys.cms.search.SearchField;
import org.ametys.cms.search.ui.model.SearchUIColumn;
import org.ametys.runtime.i18n.I18nizableText;
import org.ametys.runtime.parameter.Parameter;

/**
 * This class represents a result column
 */
public abstract class AbstractSearchUIColumn extends Parameter<MetadataType> implements SearchUIColumn
{
    private int _width;
    private String _renderer;
    private String _converter;
    private boolean _hidden;
    private boolean _editable;
    private boolean _sortable;
    private boolean _multiple;
    private String _contentTypeId;
    private String _defaultSorter;
    
//    /**
//     * Get the value represented by this column in the given result content.
//     * @param content the result content.
//     * @return the content value (cast to the appropriate object).
//     */
//    public abstract Object getValue(Content content);
    
    @Override
    public int getWidth()
    {
        return _width;
    }
    
    /**
     * Set the column's width
     * @param width The width to set
     */
    public void setWidth (int width)
    {
        this._width = width;
    }
    
    @Override
    public boolean isHidden()
    {
        return this._hidden;
    }
    
    /**
     * Set the hidden property
     * @param hidden <code>true</code> to hidden the columns by default
     */
    public void setHidden (boolean hidden)
    {
        this._hidden = hidden;
    }
    
    @Override
    public boolean isEditable()
    {
        return this._editable;
    }
    
    /**
     * Set the sortable property
     * @param sortable <code>true</code> to authorized sort
     */
    public void setSortable (boolean sortable)
    {
        this._sortable = sortable;
    }
    
    @Override
    public boolean isSortable()
    {
        return this._sortable;
    }
    
    /**
     * Set the default sorter propery
     * @param defaultSorter If the column should be a default sorter, 'ASC' for ascending 'DESC' for descending. Null otherwise.
     */
    public void setDefaultSorter(String defaultSorter)
    {
        this._defaultSorter = defaultSorter;
    }
    
    public String getDefaultSorter()
    {
        return this._defaultSorter;
    }
    
    /**
     * Set the editable property
     * @param editable <code>true</code> to authorized edition
     */
    public void setEditable (boolean editable)
    {
        this._editable = editable;
    }
    
    @Override
    public String getRenderer()
    {
        return _renderer;
    }
    
    /**
     * Set the JS class name for renderer
     * @param renderer The renderer
     */
    public void setRenderer(String renderer)
    {
        this._renderer = renderer;
    }
    
    @Override
    public String getConverter()
    {
        return _converter;
    }
    
    /**
     * Set the JS class name for converting field's value
     * @param converter The convert JS class name
     */
    public void setConverter(String converter)
    {
        this._converter = converter;
    }
    
    @Override
    public boolean isMultiple()
    {
        return this._multiple;
    }
    
    /**
     * Set the multiple property
     * @param multiple the multiple property
     */
    public void setMultiple (boolean multiple)
    {
        this._multiple = multiple;
    }
    
    /**
     * Get the content type ID (only when the search criteria is of type CONTENT).
     * @return the content type ID.
     */
    public String getContentTypeId()
    {
        return this._contentTypeId;
    }
    
    /**
     * Set the content type ID (only when the search criteria is of type CONTENT).
     * @param contentTypeId the content type ID. 
     */
    public void setContentTypeId(String contentTypeId)
    {
        this._contentTypeId = contentTypeId;
    }
    
    @Override
    public SearchField getSearchField()
    {
        // Override to provide a specific implementation.
        return null;
    }
    
    
    /**
     * Configure an i18nizable text
     * @param config The Configuration.
     * @param defaultValue The default value as an I18nizableText.
     * @return The i18nizable text
     */
    protected I18nizableText _configureI18nizableText(Configuration config, I18nizableText defaultValue)
    {
        if (config != null)
        {
            return I18nizableText.parseI18nizableText(config, null, "");
        }
        else
        {
            return defaultValue;
        }
    }
    
}