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

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