Filtering Impacted Elements / Impacted Diagrams and the Tree Browser

General

LemonTree provides the possibility to filter and sort the Impacted Elements / Impacted Diagrams List and the Tree Browser. The diagrams in the Diagram Viewer are not filtered. The representation of the diagram is not changed by LemonTree, except for an overlay which highlights the kind of changes (added, modified, removed, etc.).
A filter expression can be built from logical expressions and can be saved for later use. A suggestion list provides keywords and predefined filters.

Basically, a filter is used to reduce the Impacted Elements / Impacted Diagrams List and the Tree Browser to a specfic set of elements or diagrams. Every element or diagram which matches a given filter expression is shown. If an element or diagram is not matched by the filter but is required for (hierarchical) visualization, the element or diagram is grayed out but visible.

In the filter text box the following keys can be used:

• Arrow down, Arrow up to navigate in the dropdown list
• Tab to select the highlighted element
• Enter to apply the filter query

It is also possible to select the suggested keywords via click from the dropdown list.

Filter Keywords

The following keywords are used to build filter expressions:

Predefined Filters

Some filters are predefined, which can be used as shortcuts. The following predefined filters are available:

Filter Flags

Filter flags are used to apply additional settings for the filtering mechanism. They are marked with "$" and are also provided in the suggestion list. A flag can be added at the end of a filter expression and it can not be combined using logical operands.

Filtering of Diagram Representations

A filter expression is always applied to the Diagram Representation in combination with the element.
For example, the note element "double click to open diagram of the called activity" was not modified, but its Diagram Representation was.

Both the Element and its Diagram Representation are displayed if the filter matches either one of these.

Managing Filters

When clicking on the filter symbol  a dropdown is opened where you can save the current filter and select saved filters.

With thebutton you can save the current filter and define a name for it:

To edit the name of a filter, select the  icon.
To delete a filter, select the icon.

Private and Public Filters

You can define, edit and delete private filters.

Public filters are defined in a CSV file which can be placed f.e. on a network share. The path to this shared filter definition is configured in the directory %AppData%\LieberLieber\LemonTree\Configuration.xml:

<?xml version="1.0" encoding="utf-8"?>
<UserConfiguration xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi:"http://www.w3.org/2001/XMLSchema-instance">
  <PublicFiltersCsvFilePath>C:\\Users\\Username\\Roaming\\LieberLieber\\LemonTree\\Filters\\PublicFiltersDemo.csv</PublicFiltersCsvFilePath>
</UserConfiguration>

LemonTree creates an example filter file called PublicFiltersDemo.csv in the directory %AppData%\LieberLieber\LemonTree\Filters\.

This demo file can be used as a template for creating a public filter definition.

Structure of the filter definition

"Impacted Elements" and "Impacted Diagrams" are the headers which then contain a number of filters that are available for the Impacted Elements or Impacted Diagrams list.

The name is displayed in the filter box, the query is placed in the textbox and executed when clicked on the filters name.

Impacted Elements

%Name%;%Query%
%Name%;%Query%

Impacted Diagrams

%Name%;%Query%
%Name%;%Query%

The example file is automatically created at startup if it does not exist.

How to use filters in LemonTree

In this basic example we want to find all elements containing "Display" in the name and sort it by name.

1. We type "Na" - LemonTree suggests the keyword "Name:"
   

2. The "Tab" key selects "Name: "

3. When typing "Disp" LemonTree suggests elements that contain the string
   

4. We can select a suggested element, but we want all elements which contain "Display" so we type "Display" and "Space". LemonTree suggests other keywords.
   

5. We navigate via "Arrow down" to "SORT BY" and press "Tab" to select it. (Alternatively, you can also click the suggestion list entry)

6. LemonTree suggests the possible keywords for sorting. We select "Name" via "Tab" and hit "Enter" or click the  button to execute the search.
7. Result
   

Note: Also the grouping element "MainState" and "Signals" are shown (grayed out) because they have at least one child element with "Display" in its name.

Advanced Examples

Show all diagrams with elements that are directly changed (not only ChildModified)

1. Before using a filter:
   

2. The filter NOT #ChildModified is applied.
   
   The Activity "main" is no longer matched by the filter. Since its grouping element is matching the filter, it is still displayed but grayed out.

3. The term "AND NOT #Unmodified" is added to exclude unmodified elements, in this case the diagram "Main" but also the Diagram Representation of the activity "main".
   

Final filter: NOT #ChildModified AND NOT #Unmodified

Hide elements which were already reviewed

1. Before the filter:
   

2. Enter the filter "NOT #Reviewed".
   
   The child element of the CallOperation "WriteLL" is grayed out, because it was already reviewed.

3. If you want to reduce the list to elements which were not reviewed, the flag $OnlyMatchingChildElements can be added.
   
   The reviewed connector is now hidden.

Final filter: NOT #Reviewed $OnlyMatchingChildElements 

Hide elements where only the DiagramRepresentation was modified

1. The filter #Modified is already set:
   

2. However, there are elements which are only modified in their Diagram Representation.
   To hide them, add the flag $HideGraphicalChanges at the end of the filter expression.
   
   The elements with only graphical modifications are now hidden.

Final filter: #Modified $OnlyMatchingChildElements $HideGraphicalChanges 

Ignore certain changes

Sometimes you may want to ignore certain changes from elements, but not exclude these elements altogether. In this case, you can use the IGNORING operator.

1. Let us assume that you want to ignore changes in Documentation but examine all other changes to elements. You filter by ChangeIn: Documentation and get these elements respectively their sub-elements:
   
   Worthy of note is the fact that SYSTICKS_PER_SECOND has changes in Documentation as well as DefaultValue.

2. Applying the filter "NOT ChangeIn: Documentation" hides the property SYSTICKS_PER_SECOND even though it has changes in DefaultValue which you want to examine:
   

3. To ignore all changes to Documentation, but still include elements if they have any other changes, you can use the ANYCHANGE keyword combined with the IGNORING operator:
   

Final filter: ANYCHANGE IGNORING ChangeIn: Documentation