Form.java

package net.frontlinesms.plugins.forms.data.domain;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.OrderBy;

import net.frontlinesms.data.domain.Group;

/**
 * A form for filling in with data.
 * @author Alex Anderson <alex@frontlinesms.com>
 * @author Morgan Belkadi <morgan@frontlinesms.com>
 * @author Dieterich Lawson <dieterich@medic.frontlinesms.com>
 */
@SuppressWarnings("serial")
@Entity
public class Form implements Serializable {
//> FIELD NAMES
	/** Column name for {@link #mobileId} */
	public static final String FIELD_ID = "id";
	/** Column name for {@link #permittedGroup} */
	public static final String FIELD_PERMITTED = "permittedGroup";
	/** Column name for {@link #finalised} */
	public static final String FIELD_FINALISED = "finalised";
	
//> INSTANCE PROPERTIES
	/** Unique id for this entity.  This is for hibernate usage. */
	@Id @GeneratedValue(strategy=GenerationType.IDENTITY)
	@Column(unique=true,nullable=false,updatable=false)
	private long id;
	
	/** The name of this form */
	private String name;
	/** Fields attached to this form */
	@OneToMany(fetch=FetchType.EAGER, targetEntity=FormField.class, cascade=CascadeType.ALL, mappedBy="form")
	@OrderBy(value="positionIndex asc")
	private List<FormField> fields = new ArrayList<FormField>();
	
	/** To know if the form has been finalised yet */
	private boolean finalised;
	
	/** Phone numbers which are allowed to download this form. */
	@ManyToOne
	private Group permittedGroup;
	
//> CONSTRUCTORS
	/** Empty constructor for hibernate */
	Form() {}
	
	/**
	 * Creates a new form with the supplied name.
	 * @param name name of the form
	 */
	public Form(String name) {
		this.name = name;
		this.finalised = false;
	}

//> ACCESSOR METHODS
	/**
	 * Check whether this form is finalised
	 * @return <code>true</code> if this form has had its {@link #finalised} flag set to true; <code>false</code> otherwise.
	 */
	public boolean isFinalised() {
		return this.finalised;
	}

	/** @return {@link #fields} */
	public List<FormField> getFields() {
		return Collections.unmodifiableList(this.fields);
	}
	
	/** @return {@link #permittedGroup} */
	public Group getPermittedGroup() {
		return permittedGroup;
	}

	/** @param group new value for {@link #permittedGroup} */
	public void setPermittedGroup(Group group) {
		this.permittedGroup = group;
	}

	/** @return {@link #name} */
	public String getName() {
		return this.name;
	}

	/** @param name the new value for {@link #name} */
	public void setName(String name) {
		this.name = name;
	}

	/**
	 * Adds a new field at the end of the form
	 * @param newField the field to add
	 */
	public void addField(FormField newField) {
		this.addField(newField, this.fields.size());
	}

	/**
	 * Removes a field from this form.
	 * @param formField the field to remove
	 */
	public void removeField(FormField formField) {
		this.fields.remove(formField);
	}

	/**
	 * Adds a new field at the specified position.
	 * @param newField the {@link FormField} to add
	 * @param position the position on the form to add the new field at
	 */
	public void addField(FormField newField, int position) {
		newField.setPositionIndex(position);
		newField.setForm(this);
		this.fields.add(position, newField);
	}
	
	/** @return the mobileId of this form in the data source 
	 * This id actually is the database id of the form, but we keep using this function to prevent errors with previous versions 
	 * */
	public int getFormMobileId() {
		return (int)id;
	}

	/** @return number of fields that are editable */
	public int getEditableFieldCount() {
		int count = 0;
		for(FormField field : this.fields) {
			if(field.getType().hasValue()) {
				++count;
			}
		}
		return count;
	}
	
	/**
	 * Set the form as finalised
	 */
	public void finalise() {
		this.finalised = true;
	}

//> GENERATED CODE
//	/** @see java.lang.Object#hashCode() */
//	@Override
//	public int hashCode() {
//		final int prime = 31;
//		int result = 1;
//		result = prime * result + ((fields == null) ? 0 : fields.hashCode());
//		result = prime * result + os;
//		result = prime * result + ((name == null) ? 0 : name.hashCode());
//		return result;
//	}
	

	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + ((fields == null) ? 0 : fields.hashCode());
		result = prime * result + (finalised ? 1231 : 1237);
		result = prime * result + ((name == null) ? 0 : name.hashCode());
		return result;
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj)
			return true;
		if (obj == null)
			return false;
		if (getClass() != obj.getClass())
			return false;
		Form other = (Form) obj;
		if (fields == null) {
			if (other.fields != null)
				return false;
		} else if (!fields.equals(other.fields))
			return false;
		if (finalised != other.finalised)
			return false;
		if (name == null) {
			if (other.name != null)
				return false;
		} else if (!name.equals(other.name))
			return false;
		return true;
	}
}