/*
 *  Copyright 2010 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.form;

import java.util.Arrays;
import java.util.Date;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Set;

import org.ametys.cms.repository.Content;
import org.ametys.core.user.UserIdentity;
import org.ametys.plugins.repository.metadata.MetadataComment;
import org.ametys.plugins.repository.metadata.MultilingualString;

/**
 * Abstraction of the form submitted by the client.
 */
public class Form
{
    private final Map<String, Object> _fields = new LinkedHashMap<>();
    private final Map<String, MetadataComment[]> _comments = new LinkedHashMap<>();

    /**
     * Returns an array containing field names.
     * @return an array containing field names.
     */
    public Set<String> getFieldNames()
    {
        return _fields.keySet();
    }
    
    /**
     * Returns the named field's value as {@link Form}.
     * @param fieldName the field name.
     * @return the field value as {@link Form}.
     */
    public Form getCompositeField(String fieldName)
    {
        Object value = _fields.get(fieldName);
        
        if (value == null)
        {
            return null;
        }
        
        return (Form) value;
    }
    
    /**
     * Set a composite field.
     * @param fieldName the field name.
     * @param compositeField the composite field.
     */
    public void setCompositeField(String fieldName, Form compositeField)
    {
        _fields.put(fieldName, compositeField);
    }
    
    /**
     * Returns the named field's value as {@link RepeaterField}.
     * @param fieldName the field name.
     * @return the field value as {@link RepeaterField}.
     */
    public RepeaterField getRepeaterField(String fieldName)
    {
        Object value = _fields.get(fieldName);
        
        if (value == null)
        {
            return null;
        }
        
        return (RepeaterField) value;
    }
    
    /**
     * Returns the named field's value as {@link RichTextField}.
     * @param fieldName the field name.
     * @return the field value as RichText.
     */
    public RichTextField getRichTextField(String fieldName)
    {
        Object value = _fields.get(fieldName);
        
        if (value == null)
        {
            return null;
        }
        
        if (value instanceof ExternalizableField)
        {
            return (RichTextField) ((ExternalizableField) value).getLocalField();
        }
        else
        {
            return (RichTextField) value;
        }
    }
    
    /**
     * Returns the named field's value as {@link BinaryField}.
     * @param fieldName the field name.
     * @return the field value as a BinaryField.
     */
    public BinaryField getBinaryField(String fieldName)
    {
        Object value = _fields.get(fieldName);
        
        if (value == null)
        {
            return null;
        }
        
        if (value instanceof ExternalizableField)
        {
            return (BinaryField) ((ExternalizableField) value).getLocalField();
        }
        else
        {
            return (BinaryField) value;
        }
    }
    
    /**
     * Returns the named field's value as {@link SubContentField}.
     * @param fieldName the field name.
     * @return the field value as a SubContentField.
     */
    public SubContentField getSubContentField(String fieldName)
    {
        Object value = _fields.get(fieldName);
        
        if (value == null)
        {
            return null;
        }
        
        if (value instanceof ExternalizableField)
        {
            return (SubContentField) ((ExternalizableField) value).getLocalField();
        }
        else
        {
            return (SubContentField) value;
        }
    }
    
    /**
     * Returns the named field's value as {@link ReferenceField}.
     * @param fieldName the field name.
     * @return the field value as a ReferenceField.
     */
    public ReferenceField getReferenceField(String fieldName)
    {
        Object value = _fields.get(fieldName);
        
        if (value == null)
        {
            return null;
        }
        
        if (value instanceof ExternalizableField)
        {
            return (ReferenceField) ((ExternalizableField) value).getLocalField();
        }
        else
        {
            return (ReferenceField) value;
        }
    }
    
    /**
     * Returns the named field's value as String array.
     * @param fieldName the field name.
     * @return field value as String array.
     */
    @SuppressWarnings("unchecked")
    public SimpleField<String> getStringArray(String fieldName)
    {
        Object value = _fields.get(fieldName);
        
        if (value == null)
        {
            return null;
        }
        
        if (value instanceof ExternalizableField)
        {
            return (SimpleField<String>) ((ExternalizableField) value).getLocalField();
        }
        else
        {
            return (SimpleField<String>) value;
        }
    }

    /**
     * Returns the named field's value as Date array.
     * @param fieldName the field name.
     * @return field value as Date array.
     */
    @SuppressWarnings("unchecked")
    public SimpleField<Date> getDateArray(String fieldName)
    {
        Object value = _fields.get(fieldName);
        
        if (value == null)
        {
            return null;
        }
        
        if (value instanceof ExternalizableField)
        {
            return (SimpleField<Date>) ((ExternalizableField) value).getLocalField();
        }
        else
        {
            return (SimpleField<Date>) value;
        }
    }

    /**
     * Returns the named field's value as long array.
     * @param fieldName the field name.
     * @return field value as long array.
     */
    @SuppressWarnings("unchecked")
    public SimpleField<Long> getLongArray(String fieldName)
    {
        Object value = _fields.get(fieldName);
        
        if (value == null)
        {
            return null;
        }
        
        if (value instanceof ExternalizableField)
        {
            return (SimpleField<Long>) ((ExternalizableField) value).getLocalField();
        }
        else
        {
            return (SimpleField<Long>) value;
        }
    }

    /**
     * Returns the named field's value as double array.
     * @param fieldName the field name.
     * @return field value as double array.
     */
    @SuppressWarnings("unchecked")
    public SimpleField<Double> getDoubleArray(String fieldName)
    {
        Object value = _fields.get(fieldName);
        
        if (value == null)
        {
            return null;
        }
        
        if (value instanceof ExternalizableField)
        {
            return (SimpleField<Double>) ((ExternalizableField) value).getLocalField();
        }
        else
        {
            return (SimpleField<Double>) value;
        }
    }

    /**
     * Returns the named field's value as boolean array.
     * @param fieldName the field name.
     * @return field value as boolean array.
     */
    @SuppressWarnings("unchecked")
    public SimpleField<Boolean> getBooleanArray(String fieldName)
    {
        Object value = _fields.get(fieldName);
        
        if (value == null)
        {
            return null;
        }
        
        if (value instanceof ExternalizableField)
        {
            return (SimpleField<Boolean>) ((ExternalizableField) value).getLocalField();
        }
        else
        {
            return (SimpleField<Boolean>) value;
        }
    }
    
    /**
     * Returns the named field's value as UserIdentity array.
     * @param fieldName the field name.
     * @return field value as UserIdentity array.
     */
    @SuppressWarnings("unchecked")
    public SimpleField<UserIdentity> getUserArray(String fieldName)
    {
        Object value = _fields.get(fieldName);
        
        if (value == null)
        {
            return null;
        }
        
        if (value instanceof ExternalizableField)
        {
            return (SimpleField<UserIdentity>) ((ExternalizableField) value).getLocalField();
        }
        else
        {
            return (SimpleField<UserIdentity>) value;
        }
    }
    
    /**
     * Returns the named field's value as MultilingualString array.
     * @param fieldName the field name.
     * @return field value as UserIdentity array.
     */
    @SuppressWarnings("unchecked")
    public SimpleField<MultilingualString> getMultilingualStringArray(String fieldName)
    {
        Object value = _fields.get(fieldName);
        
        if (value == null)
        {
            return null;
        }
        
        if (value instanceof ExternalizableField)
        {
            return (SimpleField<MultilingualString>) ((ExternalizableField) value).getLocalField();
        }
        else
        {
            return (SimpleField<MultilingualString>) value;
        }
    }

    /**
     * Returns the named field's value as a content array.
     * @param fieldName the field name.
     * @return the field value as a content array.
     */
    @SuppressWarnings("unchecked")
    public SimpleField<Content> getContentArray(String fieldName)
    {
        Object value = _fields.get(fieldName);
        
        if (value == null)
        {
            return null;
        }
        
        if (value instanceof ExternalizableField)
        {
            return (SimpleField<Content>) ((ExternalizableField) value).getLocalField();
        }
        else
        {
            return (SimpleField<Content>) value;
        }
    }
    
    /**
     * Returns the named field's value as a {@link ExternalizableField}
     * @param fieldName the field name.
     * @return the externalizable field
     */
    public ExternalizableField getExternalizableField(String fieldName)
    {
        Object value = _fields.get(fieldName);
        
        if (value == null)
        {
            return null;
        }
        
        return (ExternalizableField) value;
    }
    
    /**
     * Set a multi-valued date field.
     * @param fieldName the field name.
     * @param values the Date array containing values of this field.
     */
    public void setField(String fieldName, AbstractField values)
    {
        _fields.put(fieldName, values);
    }
    
    /**
     * Get a non-typed field.
     * @param fieldName The name of the field
     * @return The desired field or null
     */
    public AbstractField getField(String fieldName)
    {
        return (AbstractField) _fields.get(fieldName);
    }
        
    /**
     * Return the array of comments for the named field.
     * @param metadataName the field name.
     * @return the array of comments
     */
    public MetadataComment[] getCommentArray(String metadataName)
    {
        return _comments.get(metadataName);
    }
    
    /**
     * Set the comment of a field
     * @param fieldName The field name
     * @param comments The array of metadata comments
     */
    public void setCommentsField(String fieldName, MetadataComment[] comments)
    {
        _comments.put(fieldName, comments);
    }
    
    @Override
    public String toString()
    {
        StringBuilder fields = new StringBuilder();
        
        if (_fields.isEmpty())
        {
            fields.append("EMPTY");
            fields.append(System.getProperty("line.separator"));
        }
        
        for (Map.Entry<String, Object> entry : _fields.entrySet())
        {
            fields.append(entry.getKey());
            fields.append(": ");
            
            fields.append(entry.getValue());
            
            fields.append(System.getProperty("line.separator"));
        }
        
        for (Map.Entry<String, MetadataComment[]> entry : _comments.entrySet())
        {
            MetadataComment[] comments = entry.getValue();
            
            fields.append(entry.getKey() + " (comments)");
            fields.append(": ");
            fields.append(Arrays.asList(comments));
            fields.append(System.getProperty("line.separator"));
        }

        return fields.toString();
    }
}