TaskFilter.java

/*******************************************************************************
 * Copyright (c) 2000, 2008 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.ui.views.markers.internal;

import org.eclipse.core.resources.IMarker;
import org.eclipse.jface.dialogs.IDialogSettings;
import org.eclipse.ui.IMemento;

public class TaskFilter extends MarkerFilter {

	private static final String TAG_CONTAINS = "contains"; //$NON-NLS-1$

	private static final String TAG_DESCRIPTION = "description"; //$NON-NLS-1$
	/**
	 * Tag for the done value.
	 */
	public static final String TAG_DONE = "done"; //$NON-NLS-1$

	/**
	 * Tag for the priority value.
	 */
	public static final String TAG_PRIORITY = "priority"; //$NON-NLS-1$

	/**
	 * Tag for the done value.
	 */
	public static final String TAG_SELECT_BY_DONE = "selectByDone"; //$NON-NLS-1$
	/**
	 * Tag for the priority value.
	 */
	public static final String TAG_SELECT_BY_PRIORITY = "selectByPriority"; //$NON-NLS-1$

	final static boolean DEFAULT_CONTAINS = true;

	final static String DEFAULT_DESCRIPTION = ""; //$NON-NLS-1$	

	final static boolean DEFAULT_DONE = false;

	final static int DEFAULT_PRIORITY = 0;

	final static boolean DEFAULT_SELECT_BY_DONE = false;

	final static boolean DEFAULT_SELECT_BY_PRIORITY = false;

	final static int PRIORITY_HIGH = 1 << 2;

	final static int PRIORITY_NORMAL = 1 << 1;

	final static int PRIORITY_LOW = 1 << 0;

	private boolean contains;

	private String description;

	private boolean done;

	private int priority;

	private boolean selectByPriority = false; 

	private boolean selectByDone = false;

	/**
	 * Create a new instance of the receiver with the default name.
	 * 
	 */
	public TaskFilter() {
		this(MarkerMessages.MarkerFilter_defaultFilterName);
	}

	/**
	 * Create a new instance of the receiver with the supplied name.
	 * 
	 * @param newName
	 */
	public TaskFilter(String newName) {
		super(newName, new String[] { IMarker.TASK });
	}

	public boolean selectMarker(ConcreteMarker marker) {
		if (!(marker instanceof TaskMarker)) {
			return false;
		}

		TaskMarker taskMarker = (TaskMarker) marker;

		return !isEnabled()
				|| (super.selectMarker(taskMarker)
						&& selectByDescription(taskMarker)
						&& selectByDone(taskMarker) && selectByPriority(taskMarker));
	}

	private boolean selectByDescription(ConcreteMarker marker) {
		if (description == null || description.equals("")) { //$NON-NLS-1$
			return true;
		}

		int index = marker.getDescription().indexOf(description);
		return contains ? (index >= 0) : (index < 0);
	}

	private boolean selectByDone(TaskMarker item) {
		if (selectByDone) {
			return done == (item.getDone() == 1);
		}

		return true;
	}

	private boolean selectByPriority(TaskMarker marker) {
		if (priority != 0 && selectByPriority) {
			int markerPriority = marker.getPriority();

			if (markerPriority == IMarker.PRIORITY_HIGH) {
				return (priority & PRIORITY_HIGH) > 0;
			} else if (markerPriority == IMarker.PRIORITY_NORMAL) {
				return (priority & PRIORITY_NORMAL) > 0;
			} else if (markerPriority == IMarker.PRIORITY_LOW) {
				return (priority & PRIORITY_LOW) > 0;
			}
		}

		return true;
	}

	public boolean getContains() {
		return contains;
	}

	public String getDescription() {
		return description;
	}

	public boolean getDone() {
		return done;
	}

	public int getPriority() {
		return priority;
	}

	public boolean getSelectByDone() {
		return selectByDone;
	}

	public boolean getSelectByPriority() {
		return selectByPriority;
	}

	public void setContains(boolean contains) {
		this.contains = contains;
	}

	public void setDescription(String description) {
		this.description = description;
	}

	public void setDone(boolean done) {
		this.done = done;
	}

	public void setPriority(int priority) {
		this.priority = priority;
	}

	public void setSelectByDone(boolean selectByDone) {
		this.selectByDone = selectByDone;
	}

	public void setSelectByPriority(boolean selectByPriority) {
		this.selectByPriority = selectByPriority;
	}

	/* (non-Javadoc)
	 * @see org.eclipse.ui.views.markers.internal.MarkerFilter#resetState()
	 */
	public void resetState() {
		super.resetState();
		contains = DEFAULT_CONTAINS;
		description = DEFAULT_DESCRIPTION;
		done = DEFAULT_DONE;
		priority = DEFAULT_PRIORITY;
		selectByDone = DEFAULT_SELECT_BY_DONE;
		selectByPriority = DEFAULT_SELECT_BY_PRIORITY;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.ui.views.markers.internal.MarkerFilter#restoreFilterSettings(org.eclipse.jface.dialogs.IDialogSettings)
	 */
	public void restoreFilterSettings(IDialogSettings settings) {
		super.restoreFilterSettings(settings);

		String setting = settings.get(TAG_CONTAINS);

		if (setting != null) {
			contains = Boolean.valueOf(setting).booleanValue();
		}

		setting = settings.get(TAG_DESCRIPTION);

		if (setting != null) {
			description = new String(setting);
		}

		setting = settings.get(TAG_DONE);

		if (setting != null) {
			done = Boolean.valueOf(setting).booleanValue();
		}

		setting = settings.get(TAG_PRIORITY);

		if (setting != null) {
			try {
				priority = Integer.parseInt(setting);
			} catch (NumberFormatException eNumberFormat) {
			}
		}

		setting = settings.get(TAG_SELECT_BY_DONE);

		if (setting != null) {
			selectByDone = Boolean.valueOf(setting).booleanValue();
		}

		setting = settings.get(TAG_SELECT_BY_PRIORITY);

		if (setting != null) {
			selectByPriority = Boolean.valueOf(setting).booleanValue();
		}

	}
	
	/* (non-Javadoc)
	 * @see org.eclipse.ui.views.markers.internal.MarkerFilter#restoreFilterSettings(org.eclipse.ui.IMemento)
	 */
	protected void restoreFilterSettings(IMemento settings) {
		super.restoreFilterSettings(settings);

		String setting = settings.getString(TAG_CONTAINS);

		if (setting != null) {
			contains = Boolean.valueOf(setting).booleanValue();
		}

		setting = settings.getString(TAG_DESCRIPTION);

		if (setting != null) {
			description = new String(setting);
		}

		setting = settings.getString(TAG_DONE);

		if (setting != null) {
			done = Boolean.valueOf(setting).booleanValue();
		}

		Integer priorityValue = settings.getInteger(TAG_PRIORITY);

		if (setting != null) {
			priority = priorityValue.intValue();
		}

		setting = settings.getString(TAG_SELECT_BY_DONE);

		if (setting != null) {
			selectByDone = Boolean.valueOf(setting).booleanValue();
		}

		setting = settings.getString(TAG_SELECT_BY_PRIORITY);

		if (setting != null) {
			selectByPriority = Boolean.valueOf(setting).booleanValue();
		}

	}

	
	/* (non-Javadoc)
	 * @see org.eclipse.ui.views.markers.internal.MarkerFilter#saveFilterSettings(org.eclipse.ui.IMemento)
	 */
	public void saveFilterSettings(IMemento settings) {
		super.saveFilterSettings(settings);
		settings.putString(TAG_CONTAINS, String.valueOf(contains));
		settings.putString(TAG_DESCRIPTION, description);
		settings.putString(TAG_DONE, String.valueOf(done));
		settings.putInteger(TAG_PRIORITY, priority);
		settings.putString(TAG_SELECT_BY_DONE, String.valueOf(selectByDone));
		settings.putString(TAG_SELECT_BY_PRIORITY, String.valueOf(selectByPriority));

	}

}