bundles/org.eclipse.ui.ide/src/org/eclipse/ui/internal/views/markers/MarkerTypeFieldFilter.java

/*******************************************************************************
 * Copyright (c) 2007, 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.internal.views.markers;

import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.StringTokenizer;

import org.eclipse.core.resources.IMarker;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.ui.IMemento;
import org.eclipse.ui.views.markers.MarkerFieldFilter;
import org.eclipse.ui.views.markers.MarkerItem;
import org.eclipse.ui.views.markers.internal.MarkerFilter;
import org.eclipse.ui.views.markers.internal.MarkerType;
import org.eclipse.ui.views.markers.internal.MarkerTypesModel;
import org.eclipse.ui.views.markers.internal.ProblemFilter;

/**
 * MarkerTypeFieldFilter is the field filter for filtering on types.
 *
 * @since 3.4
 *
 */
public class MarkerTypeFieldFilter extends CompatibilityFieldFilter {

	private static final String TAG_TYPES_DELIMITER = ":"; //$NON-NLS-1$
	private static final String TAG_SELECTED_TYPES = "selectedTypes"; //$NON-NLS-1$
	Collection selectedTypes = new HashSet();
	private MarkerContentGenerator contentGenerator;

	/*
	 * (non-Javadoc)
	 *
	 * @see org.eclipse.ui.internal.provisional.views.markers.api.MarkerFieldFilter#select(org.eclipse.ui.internal.provisional.views.markers.api.MarkerItem)
	 */
	@Override
	public boolean select(MarkerItem item) {

		IMarker marker = item.getMarker();
		if (marker == null)// OK if all are selected
			return contentGenerator.allTypesSelected(selectedTypes);
		try {
			return selectedTypes.contains(MarkerTypesModel.getInstance()
					.getType(marker.getType()));
		} catch (CoreException e) {
			return false;
		}

	}

	/**
	 * Set the selected types in the receiver based on the values in
	 * contentGenerator.
	 *
	 * @param markerTypes
	 *            Collection of MarkerType
	 * @param generator
	 *            {@link MarkerContentGenerator}
	 */
	void setSelectedTypes(Collection markerTypes,
			MarkerContentGenerator generator) {
		setContentGenerator(generator);
		selectedTypes = markerTypes;

	}

	/**
	 * Return the selectedTypes.
	 *
	 * @return Collection of MarkerType
	 */
	Collection getSelectedTypes() {
		return selectedTypes;
	}

	/*
	 * (non-Javadoc)
	 *
	 * @see org.eclipse.ui.views.markers.MarkerFieldFilter#saveSettings(org.eclipse.ui.IMemento)
	 */
	@Override
	public void saveSettings(IMemento memento) {

		if (selectedTypes.containsAll(contentGenerator.getMarkerTypes()))
			return;

		Iterator selected = selectedTypes.iterator();

		StringBuffer settings = new StringBuffer();
		while (selected.hasNext()) {
			MarkerType markerType = (MarkerType) selected.next();
			settings.append(markerType.getId());
			settings.append(TAG_TYPES_DELIMITER);
		}

		memento.putString(TAG_SELECTED_TYPES, settings.toString());
	}

	/*
	 * (non-Javadoc)
	 *
	 * @see org.eclipse.ui.views.markers.MarkerFieldFilter#loadSettings(org.eclipse.ui.IMemento)
	 */
	@Override
	public void loadSettings(IMemento memento) {

		String types = memento.getString(TAG_SELECTED_TYPES);
		if (types == null)
			return;

		selectedTypes.clear();

		int start = 0;
		int nextSpace = types.indexOf(TAG_TYPES_DELIMITER, 0);
		while (nextSpace > 0) {
			String typeId = types.substring(start, nextSpace);
			start = nextSpace + 1;
			nextSpace = types.indexOf(TAG_TYPES_DELIMITER, start);

			MarkerType type = contentGenerator.getType(typeId);
			if (type != null)
				selectedTypes.add(type);
		}

	}

	/* (non-Javadoc)
	 * @see org.eclipse.ui.internal.views.markers.CompatibilityFieldFilter#loadLegacySettings(org.eclipse.ui.IMemento, org.eclipse.ui.internal.views.markers.MarkerContentGenerator)
	 */
	@Override
	void loadLegacySettings(IMemento memento, MarkerContentGenerator generator) {

		setContentGenerator(generator);
		// new selection list attribute
		// format is "id:(true|false):"
		String setting = memento.getString(MarkerFilter.TAG_SELECTION_STATUS);

		if (setting != null) {
			selectedTypes.clear();

			// get the complete list of types
			List newTypes = new ArrayList();

			StringTokenizer stringTokenizer = new StringTokenizer(setting);

			while (stringTokenizer.hasMoreTokens()) {
				String id = stringTokenizer.nextToken(TAG_TYPES_DELIMITER);
				String status = null;
				if (stringTokenizer.hasMoreTokens()) {
					status = stringTokenizer.nextToken(TAG_TYPES_DELIMITER);
				}

				MarkerType type = contentGenerator.getType(id);
				if (type != null) {

					newTypes.remove(type);

					// add the type to the selected list
					if (!MarkerFilter.SELECTED_FALSE.equals(status)
							&& !selectedTypes.contains(type)) {
						selectedTypes.add(type);
					}
				}
			}
		}



	}

	/*
	 * (non-Javadoc)
	 *
	 * @see org.eclipse.ui.internal.views.markers.CompatibilityFieldFilter#initialize(org.eclipse.ui.views.markers.internal.ProblemFilter)
	 */
	@Override
	public void initialize(ProblemFilter problemFilter) {
		selectedTypes.clear();
		selectedTypes.addAll(problemFilter.getSelectedTypes());

	}

	/**
	 * Set the content generator that is being configured.
	 *
	 * @param generator
	 */
	void setContentGenerator(MarkerContentGenerator generator) {
		contentGenerator = generator;

		// Set the initial selection to be everything
		selectedTypes = new HashSet();
		selectedTypes.addAll(generator.getMarkerTypes());
	}

	/*
	 * (non-Javadoc)
	 *
	 * @see org.eclipse.ui.views.markers.MarkerFieldFilter#populateWorkingCopy(org.eclipse.ui.views.markers.MarkerFieldFilter)
	 */
	@Override
	public void populateWorkingCopy(MarkerFieldFilter copy) {
		super.populateWorkingCopy(copy);

		((MarkerTypeFieldFilter) copy).selectedTypes = new HashSet(
				selectedTypes);
		((MarkerTypeFieldFilter) copy).contentGenerator = contentGenerator;
	}
}