Class NamespaceFilter


  • class NamespaceFilter
    extends AbstractConfigurationFilter
    A filter for showing only variables of a given namespace (project name).
    Author:
    El-Sharkawy
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String namespace  
    • Constructor Summary

      Constructors 
      Constructor Description
      NamespaceFilter​(java.lang.String namespace)
      Sole constructor for this class.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected boolean checkVariable​(GUIVariable variable)
      Determines whether a given variable should be shown inside the editor or not.
      • Methods inherited from class org.eclipse.jface.viewers.ViewerFilter

        filter, filter, isFilterProperty
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • namespace

        private java.lang.String namespace
    • Constructor Detail

      • NamespaceFilter

        NamespaceFilter​(java.lang.String namespace)
        Sole constructor for this class.
        Parameters:
        namespace - A project name (namespace) only variables having exactly the same namespace will be returned.
    • Method Detail

      • checkVariable

        protected boolean checkVariable​(GUIVariable variable)
        Description copied from class: AbstractConfigurationFilter
        Determines whether a given variable should be shown inside the editor or not. Parents of variables which shall be shown should not be filtered. The AbstractConfigurationFilter ensures that.
        This method must also ensure that nested elements of a shown variable are also displayed. Therefore, this method should also be written in a recursive manner to check nested elements of displayed variables. This should be done in the following way:
        if(checkVariable(variable)) {
          for(GUIVariable nestedVariable : variable.getNestedVars()) {
            checkVariable(nestedVariable);
          }
        }
        Specified by:
        checkVariable in class AbstractConfigurationFilter
        Parameters:
        variable - The variable which should be tested whether it should be displayed inside the editor
        Returns:
        true if the variable should be displayed, false otherwise.