/*
 * SIP Communicator, the OpenSource Java VoIP and Instant Messaging client.
 *
 * Distributable under LGPL license.
 * See terms of license at gnu.org.
 */
package net.java.sip.communicator.impl.protocol.jabber;

import java.util.*;

import org.jivesoftware.smackx.*;

import net.java.sip.communicator.service.protocol.*;

/**
 * The Jabber protocol implementation of the
 * <tt>ChatRoomConfigurationFormField</tt>. This implementation is based on the
 * smack Form and FormField types.
 *  
 * @author Yana Stamcheva
 */
public class ChatRoomConfigurationFormFieldJabberImpl
    implements ChatRoomConfigurationFormField
{
    /**
     * The smack library for field.
     */
    private FormField smackFormField;
    
    /**
     * The smack library submit form field. It's the one that will care all
     * values set by user, before submitting the form.
     */
    private FormField smackSubmitFormField;
    
    /**
     * Creates an instance of <tt>ChatRoomConfigurationFormFieldJabberImpl</tt>
     * by passing to it the smack form field and the smack submit form, which
     * are the base of this implementation.
     * 
     * @param formField the smack form field
     * @param submitForm the smack submit form
     */
    public ChatRoomConfigurationFormFieldJabberImpl(
        FormField formField,
        Form submitForm)
    {
        this.smackFormField = formField;
        
        if(!formField.getType().equals(FormField.TYPE_FIXED))
            this.smackSubmitFormField
                = submitForm.getField(formField.getVariable());
    }
    
    /**
     * Returns the variable name of the corresponding smack property.
     * 
     * @return the variable name of the corresponding smack property
     */
    public String getName()
    {
        return smackFormField.getVariable();
    }

    /**
     * Returns the description of the corresponding smack property.
     * 
     * @return the description of the corresponding smack property
     */
    public String getDescription()
    {
        return smackFormField.getDescription();
    }

    /**
     * Returns the label of the corresponding smack property.
     * 
     * @return the label of the corresponding smack property
     */
    public String getLabel()
    {
        return smackFormField.getLabel();
    }

    /**
     * Returns the options of the corresponding smack property.
     * 
     * @return the options of the corresponding smack property
     */
    public Iterator<String> getOptions()
    {
        List<String> options = new ArrayList<String>();
        Iterator<FormField.Option> smackOptions = smackFormField.getOptions();
                
        while(smackOptions.hasNext())
        {
            FormField.Option smackOption
                = smackOptions.next();
            
            options.add(smackOption.getValue());
        }
        
        return Collections.unmodifiableList(options).iterator();
    }

    /**
     * Returns the isRequired property of the corresponding smack property.
     * 
     * @return the isRequired property of the corresponding smack property
     */
    public boolean isRequired()
    {
        return smackFormField.isRequired();
    }

    /**
     * For each of the smack form field types returns the corresponding
     * <tt>ChatRoomConfigurationFormField</tt> type.
     * 
     * @return the type of the property
     */
    public String getType()
    {
        String smackType = smackFormField.getType();
        
        if(smackType.equals(FormField.TYPE_BOOLEAN))
            return TYPE_BOOLEAN;
        if(smackType.equals(FormField.TYPE_FIXED))
            return TYPE_TEXT_FIXED;
        else if(smackType.equals(FormField.TYPE_TEXT_PRIVATE))
            return TYPE_TEXT_PRIVATE;
        else if(smackType.equals(FormField.TYPE_TEXT_SINGLE))
            return TYPE_TEXT_SINGLE;
        else if(smackType.equals(FormField.TYPE_TEXT_MULTI))
            return TYPE_TEXT_MULTI;
        else if(smackType.equals(FormField.TYPE_LIST_SINGLE))
            return TYPE_LIST_SINGLE;
        else if(smackType.equals(FormField.TYPE_LIST_MULTI))
            return TYPE_LIST_MULTI;        
        else
            return TYPE_UNDEFINED;
    }

    /**
     * Returns an Iterator over the list of values of this field.
     * 
     * @return an Iterator over the list of values of this field
     */
    public Iterator<Object> getValues()
    {
        Iterator<Object> valuesIter = null;
        List<Object> values = new ArrayList<Object>();
        Iterator<String> smackValues = smackFormField.getValues();
        
        if(smackFormField.getType().equals(FormField.TYPE_BOOLEAN))
        {
            while(smackValues.hasNext())
            {
                String smackValue = smackValues.next();
                
                if(smackValue.equals("1") || smackValue.equals("true"))
                    values.add(new Boolean(true));
                else
                    values.add(new Boolean(false));
            }
            
            valuesIter = values.iterator();
        }
        else
            valuesIter = (Iterator)smackValues;
        
        return valuesIter;
    }
    
    /**
     * Adds the given value to the list of values of this field.
     * 
     * @param value the value to add
     */
    public void addValue(Object value)
    {
        if(value instanceof Boolean)
        {
            if(((Boolean)value).booleanValue())
                value = "1";
            else
                value = "0";
        }
        
        smackSubmitFormField.addValue(value.toString());
    }

    /**
     * Sets the given list of values to this field.
     * 
     * @param newValues the list of values to set
     */
    public void setValues(Object[] newValues)
    {
        ArrayList list = new ArrayList();
        
        for(int i = 0; i < newValues.length; i ++)
        {
            Object value = newValues[i];
            
            if(value instanceof Boolean)
            {
                if(((Boolean)value).booleanValue())
                    value = "1";
                else
                    value = "0";
            }
            
            list.add(value);
        }
        
        smackSubmitFormField.addValues(list);
    }
}