org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDFilterProvider.java

   1 /**********************************************************************
   2  * Copyright (c) 2005, 2006, 2011 IBM Corporation and others.
   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  * $Id: ISDFilterProvider.java,v 1.2 2006/09/20 20:56:26 ewchan Exp $
   8  *
   9  * Contributors:
  10  * IBM - Initial API and implementation
  11  * Bernd Hufmann - Updated for TMF
  12  **********************************************************************/
  13 package org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider;
  14
  15 import java.util.List;
  16
  17 /**
  18  * Sequence Diagram loaders which implement this class provide the actions filtering the sequence diagram.<br>
  19  * This interface also allow the implementor to set which graph nodes are supporting filtering (thanks to
  20  * ISDGraphNodeSupporter extension).<br>
  21  *
  22  * Action provider are associated to a Sequence Diagram SDWidget calling <code>SDViewer.setSDFilterProvider</code><br>
  23  *
  24  * Filters to be applied to be managed by the loader in an ArrayList of FilterCriteria.<br>
  25  */
  26 public interface ISDFilterProvider extends ISDGraphNodeSupporter {
  27
  28     /**
  29      * Called when the Filter dialog box OK button is pressed
  30      *
  31      * @param filters user selection made in the dialog box
  32      * @return true if the filter applied
  33      */
  34     public boolean filter(List<?> filters);
  35
  36 }