Dictionary/src/java/org/thdl/lex/DisplayHelper.java

package org.thdl.lex;

import java.text.DateFormat;
import java.util.Collection;
import java.util.Date;
import java.util.List;
import java.util.Map;

import org.apache.commons.beanutils.BeanUtils;
import org.thdl.lex.component.ILexComponent;
import org.thdl.lex.component.Translatable;
import org.thdl.tib.text.TibetanHTML;

/**
 * Description of the Class
 * 
 * @author travis
 * @created October 14, 2003
 */
public class DisplayHelper {
	private Collection collection;

	private ILexComponent component;

	private ILexComponent note;

	private Date date;

	private final static DateFormat DATE_FORMAT = DateFormat
			.getDateInstance(DateFormat.LONG);

	private boolean showNotes;

	private boolean showMeta;

	private boolean showEditOptions;

	private boolean showTranslations;

	private String wylie;

	/**
	 * Sets the wylie attribute of the DisplayHelper object
	 * 
	 * @param wylie
	 *            The new wylie value
	 */
	public void setWylie(String wylie) {
		this.wylie = wylie;
	}

	/**
	 * Gets the wylie attribute of the DisplayHelper object
	 * 
	 * @return The wylie value
	 */
	public String getWylie() {
		return wylie;
	}

	/**
	 * Sets the date attribute of the DisplayHelper object
	 * 
	 * @param date
	 *            The new date value
	 */
	public void setDate(Date date) {
		this.date = date;
	}

	/**
	 * Gets the date attribute of the DisplayHelper object
	 * 
	 * @return The date value
	 */
	public Date getDate() {
		return date;
	}

	/**
	 * Sets the note attribute of the DisplayHelper object
	 * 
	 * @param note
	 *            The new note value
	 */
	public void setNote(ILexComponent note) {
		this.note = note;
	}

	/**
	 * Gets the note attribute of the DisplayHelper object
	 * 
	 * @return The note value
	 */
	public ILexComponent getNote() {
		return note;
	}

	/**
	 * Sets the component attribute of the DisplayHelper object
	 * 
	 * @param component
	 *            The new component value
	 */
	public void setComponent(ILexComponent component) {
		this.component = component;
	}

	/**
	 * Gets the component attribute of the DisplayHelper object
	 * 
	 * @return The component value
	 */
	public ILexComponent getComponent() {
		return component;
	}

	/**
	 * Sets the showEditOptions attribute of the DisplayHelper object
	 * 
	 * @param showEditOptions
	 *            The new showEditOptions value
	 */
	public void setShowEditOptions(boolean showEditOptions) {
		this.showEditOptions = showEditOptions;
	}

	/**
	 * Gets the showEditOptions attribute of the DisplayHelper object
	 * 
	 * @return The showEditOptions value
	 */
	public boolean getShowEditOptions() {
		return showEditOptions;
	}

	/**
	 * Sets the showTranslations attribute of the DisplayHelper object
	 * 
	 * @param showTranslations
	 *            The new showTranslations value
	 */
	public void setShowTranslations(boolean showTranslations) {
		this.showTranslations = showTranslations;
	}

	/**
	 * Gets the showTranslations attribute of the DisplayHelper object
	 * 
	 * @return The showTranslations value
	 */
	public boolean getShowTranslations() {
		return showTranslations;
	}

	/**
	 * Sets the showNotes attribute of the DisplayHelper object
	 * 
	 * @param showNotes
	 *            The new showNotes value
	 */
	public void setShowNotes(boolean showNotes) {
		this.showNotes = showNotes;
	}

	/**
	 * Sets the showMeta attribute of the DisplayHelper object
	 * 
	 * @param showMeta
	 *            The new showMeta value
	 */
	public void setShowMeta(boolean showMeta) {
		this.showMeta = showMeta;
	}

	/**
	 * Gets the showNotes attribute of the DisplayHelper object
	 * 
	 * @return The showNotes value
	 */
	public boolean getShowNotes() {
		return showNotes;
	}

	/**
	 * Gets the showMeta attribute of the DisplayHelper object
	 * 
	 * @return The showMeta value
	 */
	public boolean getShowMeta() {
		return showMeta;
	}

	/**
	 * Sets the collection attribute of the DisplayHelper object
	 * 
	 * @param collection
	 *            The new collection value
	 */
	public void setCollection(Collection collection) {
		this.collection = collection;
	}

	/**
	 * Gets the collection attribute of the DisplayHelper object
	 * 
	 * @return The collection value
	 */
	public Collection getCollection() {
		return collection;
	}

	//composite properties
	/**
	 * Gets the collectionSize attribute of the DisplayHelper object
	 * 
	 * @return The collectionSize value
	 */
	public int getCollectionSize() {
		int size = 0;
		if (null != getCollection()) {
			size = getCollection().size();
		}
		return size;
	}

	/**
	 * Gets the componentIsTranslation attribute of the DisplayHelper object
	 * 
	 * @return The componentIsTranslation value
	 */
	public boolean getComponentIsTranslation() {

		boolean b = false;
		if (null != getComponent() && getComponent() instanceof Translatable) {
			Translatable t = (Translatable) getComponent();
			b = t.getTranslationOf() != null ? true : false;
		}
		return b;
	}

	/**
	 * Gets the tibetan attribute of the DisplayHelper object
	 * 
	 * @return The tibetan value
	 */
	public String getTibetan() {
		return TibetanHTML.getHTML(getWylie());
	}

	/**
	 * Gets the formattedDate attribute of the DisplayHelper object
	 * 
	 * @return The formattedDate value
	 */
	public String getFormattedDate() {
		String date = null;
		if (null != getDate()) {
			date = DATE_FORMAT.format(getDate());
		}
		return date;
	}

	// helpers
	/**
	 * Description of the Method
	 */
	public void clear() {
		setShowEditOptions(false);
		setShowMeta(false);
		setShowTranslations(false);
		setShowNotes(false);
	}

	/**
	 * Description of the Method
	 * 
	 * @param map
	 *            Description of the Parameter
	 * @exception Exception
	 *                Description of the Exception
	 */
	public void populate(Map map) throws Exception {
		clear();
		BeanUtils.populate(this, map);
	}

	/**
	 * Gets the hashCode attribute of the DisplayHelper object
	 * 
	 * @return The hashCode value
	 */
	public int getHashCodeForComponent() {
		return getComponent().hashCode();
	}

	/**
	 * Gets the hashCodeForCollection attribute of the DisplayHelper object
	 * 
	 * @return The hashCodeForCollection value
	 */
	public int getHashCodeForCollection() {
		return getCollection().hashCode();
	}

	public String getIndexOfComponent() {
		int i = ((List) getCollection()).indexOf(getComponent()) + 1;
		return "" + i;
	}

	/**
	 * Constructor for the DisplayHelper object
	 */
	public DisplayHelper() {
	}
}