EDIT

// $Id$

/**

* Copyright (C) 2007 EDIT

* European Distributed Institute of Taxonomy 

* http://www.e-taxonomy.eu

* 

* The contents of this file are subject to the Mozilla Public License Version 1.1

* See LICENSE.TXT at the top of this package for the full license terms.

*/

package eu.etaxonomy.taxeditor.bulkeditor;

import org.eclipse.jface.action.IStatusLineManager;

import org.eclipse.swt.graphics.Font;

import org.eclipse.swt.graphics.Image;

import org.eclipse.swt.widgets.Display;

import org.eclipse.ui.IEditorPart;

import eu.etaxonomy.cdm.hibernate.HibernateProxyHelper;

import eu.etaxonomy.cdm.model.agent.AgentBase;

import eu.etaxonomy.cdm.model.common.CdmBase;

import eu.etaxonomy.cdm.model.common.IdentifiableEntity;

import eu.etaxonomy.cdm.model.common.Marker;

import eu.etaxonomy.cdm.model.name.TaxonNameBase;

import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationBase;

import eu.etaxonomy.cdm.model.reference.ReferenceBase;

import eu.etaxonomy.taxeditor.annotatedlineeditor.EntityListener;

import eu.etaxonomy.taxeditor.annotatedlineeditor.ILineDisplayStrategy;

import eu.etaxonomy.taxeditor.preference.PreferencesUtil;

/**

 * <p>BulkEditorLineDisplay class.</p>

 *

 * @author p.ciardelli

 * @created 07.07.2009

 * @version 1.0

 */

public class BulkEditorLineDisplay implements ILineDisplayStrategy {

	private IEditorPart editor;

	/**

	 * <p>Constructor for BulkEditorLineDisplay.</p>

	 *

	 * @param editor a {@link org.eclipse.ui.IEditorPart} object.

	 */

	public BulkEditorLineDisplay(IEditorPart editor) {

		this.editor = editor;

	}

	/* (non-Javadoc)

	 * @see eu.etaxonomy.taxeditor.bulkeditor.ILineDisplayStrategy#getIcon(java.lang.Object)

	 */

	/** {@inheritDoc} */

	public Image getIcon(Object entity) {

		return null;

	}

	/* (non-Javadoc)

	 * @see eu.etaxonomy.taxeditor.bulkeditor.ILineDisplayStrategy#getIndent(java.lang.Object)

	 */

	/** {@inheritDoc} */

	public int getIndent(Object entity) {

		return 0;

	}

	/* (non-Javadoc)

	 * @see eu.etaxonomy.taxeditor.bulkeditor.ILineDisplayStrategy#getText(java.lang.Object)

	 */

	/** {@inheritDoc} */

	public String getText(Object entity) {		

		String text = null;

		if(entity instanceof IdentifiableEntity){

			IdentifiableEntity identifiableEntity = (IdentifiableEntity) HibernateProxyHelper.deproxy(entity);

			if(identifiableEntity instanceof TaxonNameBase){

				// TODO it is not very nice to do this here. Please refactor

				text = ((TaxonNameBase) identifiableEntity).getFullTitleCache();

			}else{

				text = identifiableEntity.getTitleCache();

			}

		}

		return text == null ? "" : text;

	}

	/* (non-Javadoc)

	 * @see eu.etaxonomy.taxeditor.annotatedlineeditor.ILineDisplayStrategy#getSupplementalText(java.lang.Object)

	 */

	/** {@inheritDoc} */

	public String getSupplementalText(Object entity) {

		if (entity instanceof ReferenceBase) {

			ReferenceBase reference = (ReferenceBase) HibernateProxyHelper.deproxy(entity);

			// Nobody seems to like displaying the date

//			TimePeriod datePublished = ((StrictReferenceBase) reference).getDatePublished();

//						

//			String date = datePublished == null ? null : datePublished.toString();

//			if (date != null) {

//				text += " [" + date + "]";

//			}

			String markerText = null;

			for (Marker marker : reference.getMarkers()) {

				if (PreferencesUtil.getEditMarkerTypePreference(editor.getEditorInput(), marker.getMarkerType())) {

					if (markerText == null) {

						markerText = " [";

					} else {

						markerText += ", ";

					}

					markerText += marker.getMarkerType().getLabel() + " = " + marker.getFlag();

				}

			}

			if (markerText != null) {

				markerText += "]";

			} else {

				markerText = "";

			}

			return markerText;

		}

		if (entity instanceof TaxonNameBase) { 

			return "";

		}

		if (entity instanceof AgentBase) {

			return "[" + entity.getClass().getSimpleName() + "]";

		}

		if (entity instanceof SpecimenOrObservationBase) {

			return "[" + entity.getClass().getSimpleName() + "]";

		}

		return "";

	}

	/* (non-Javadoc)

	 * @see eu.etaxonomy.taxeditor.bulkeditor.ILineDisplayStrategy#setText(java.lang.String, java.lang.Object)

	 */

	/** {@inheritDoc} */

	public void setText(String text, Object entity) {

		if (entity instanceof ReferenceBase) {

			((ReferenceBase) entity).setTitleCache(text);			

		}

	}

	/* (non-Javadoc)

	 * @see eu.etaxonomy.taxeditor.bulkeditor.ILineDisplayStrategy#getHoverText(java.lang.Object)

	 */

	/** {@inheritDoc} */

	public String getHoverText(Object entity) {

		return null;

	}

	/* (non-Javadoc)

	 * @see eu.etaxonomy.taxeditor.bulkeditor.ILineDisplayStrategy#setStatusMessage(java.lang.String, java.lang.Object)

	 */

	/** {@inheritDoc} */

	public void setStatusMessage(final String text, Object entity) {

		// Calling from the synchronized method ListEditorReconcilingStrategy#doReconcile

		// without its own thread causes an invalid thread access exception

		// see http://wiki.eclipse.org/FAQ_Why_do_I_get_an_invalid_thread_access_exception%3F

		new Thread(new Runnable() {

			public void run() {

				Display.getDefault().asyncExec(new Runnable() {

					public void run() {

						IStatusLineManager statusLineManager = editor.getEditorSite().getActionBars().getStatusLineManager();

						statusLineManager.setMessage(text);

					}

				});

			}

		}).start();

	}

	/* (non-Javadoc)

	 * @see eu.etaxonomy.taxeditor.annotatedlineeditor.ILineDisplayStrategy#getEmptyText(java.lang.Object)

	 */

	/** {@inheritDoc} */

	public String getEmptyCacheMessage(Object entity) {

		if (entity instanceof ReferenceBase) {

			return "No reference title cache";

		}

		if (entity instanceof TaxonNameBase) {

			return "No name title cache";

		}

		if (entity instanceof AgentBase) {

			return "No title cache";

		}

		return "";

	}

	/* (non-Javadoc)

	 * @see eu.etaxonomy.taxeditor.annotatedlineeditor.ILineDisplayStrategy#isEntityCacheEmpty(java.lang.Object)

	 */

	/** {@inheritDoc} */

	public boolean isEntityCacheEmpty(Object entity) {

		if (entity instanceof ReferenceBase) {

			String text = ((ReferenceBase) entity).getTitleCache();

			return (text == null || text.equals(""));

		}

		if (entity instanceof TaxonNameBase) {

			String text = ((TaxonNameBase) entity).getTitleCache(); 

			return (text == null || text.equals(""));

		}

		if (entity instanceof AgentBase) {

			String text = ((AgentBase) entity).getTitleCache(); 

			return (text == null || text.equals(""));

		}

		return false;

	}

	/* (non-Javadoc)

	 * @see eu.etaxonomy.taxeditor.annotatedlineeditor.ILineDisplayStrategy#addDisplayListener(java.lang.Object)

	 */

	/** {@inheritDoc} */

	public void addDisplayListener(Object entity, EntityListener listener) {

		/* Note: all non-field specific listeners require that corresponding property sheets 

		 * contain the following:

		 * 

		 * 

		 * 		public void setPropertyValue(Object id, Object value) {

		 * 		...

		 * 			reference.firePropertyChange(new PropertyChangeEvent(reference, "", null, null));

		 * 		}

		 * 

		 */

		if (entity instanceof CdmBase) {

			((CdmBase) entity).addPropertyChangeListener(listener);

		}

	}

	/* (non-Javadoc)

	 * @see eu.etaxonomy.taxeditor.annotatedlineeditor.ILineDisplayStrategy#getFont(java.lang.Object)

	 */

	/** {@inheritDoc} */

	public Font getFont(Object entity) {

		return null;

	}

}