| 1 | /********************************************************************** |
| 2 | * Copyright (c) 2005, 2012 IBM Corporation, Ericsson |
| 3 | * All rights reserved. This program and the accompanying materials |
| 4 | * are made available under the terms of the Eclipse Public License v1.0 |
| 5 | * which accompanies this distribution, and is available at |
| 6 | * http://www.eclipse.org/legal/epl-v10.html |
| 7 | * |
| 8 | * Contributors: |
| 9 | * IBM - Initial API and implementation |
| 10 | * Bernd Hufmann - Updated for TMF |
| 11 | **********************************************************************/ |
| 12 | |
| 13 | package org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider; |
| 14 | |
| 15 | import java.util.List; |
| 16 | |
| 17 | /** |
| 18 | * Interface for providing a filter provider. |
| 19 | * |
| 20 | * Sequence Diagram loaders which implement this class provide the actions filtering the sequence diagram.<br> |
| 21 | * This interface also allow the implementor to set which graph nodes are supporting filtering (thanks to |
| 22 | * ISDGraphNodeSupporter extension).<br> |
| 23 | * |
| 24 | * Action provider are associated to a Sequence Diagram view by calling <code>SDView.setSDFilterProvider</code><br> |
| 25 | * |
| 26 | * Filters to be applied to be managed by the loader in an ArrayList of FilterCriteria.<br> |
| 27 | * |
| 28 | * @version 1.0 |
| 29 | * @author sveyrier |
| 30 | */ |
| 31 | public interface ISDFilterProvider extends ISDGraphNodeSupporter { |
| 32 | |
| 33 | /** |
| 34 | * Called when the Filter dialog box OK button is pressed |
| 35 | * |
| 36 | * @param filters user selection made in the dialog box |
| 37 | * @return true if the filter applied |
| 38 | */ |
| 39 | public boolean filter(List<?> filters); |
| 40 | |
| 41 | } |