Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/search.html')
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/search.html6
1 files changed, 0 insertions, 6 deletions
diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/search.html b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/search.html
deleted file mode 100644
index 978df0a3cd5..00000000000
--- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/search.html
+++ /dev/null
@@ -1,6 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/></head><body><p>In this documentation, we will use this UML model to illustrate the search features. </p><p><img border="0" src="search-model1.png"/></p><h1 id="Search_elements">Search elements</h1><p>The search feature of Papyrus helps the user to find elements in the models. The user can choose between a text search and an OCL search.</p><p>As it is shown in the following image the user chooses the query kind he wants to use: </p><p><img border="0" src="query_kind.png"/> </p><h1 id="Text_search">Text search</h1><p>The user can do a simple search or an advanced search.
-The user makes his choice in the A area of the following image which represents the text search dialog.</p><p><img border="0" src="search_kind.png"/> </p><h2 id="Simple_search">Simple search</h2><p>The following image illustrates a simple text search dialog:</p><p><img border="0" src="simple_search.png"/> </p><ul><li>The user can specify the string pattern he/she is looking for in the A area. <ul><li>Check the "Case sensitive" if case must be considered. </li><li>The user may also want to use regular expression to express the query. Then check "Regular expression" button. The regular expression must respect Java Regex.</li></ul></li><li>The user chooses whether he wants to search only in the name attribute of instances of UML::NamedElement or in all string attributes of instances of UML metaClasses, in B area.</li></ul><p>For instance, the following search: </p><p><img border="0" src="C-search.png"/></p><p>will provide the following results: </p><p><img border="0" src="C-result.png"/></p><p>The comment is not returned because we were note looking for all string attributes. </p><p>However, this search:</p><p><img border="0" src="comment-search.png"/></p><p>will return : </p><p><img border="0" src="comment-result.png"/></p><h2 id="Advanced_search">Advanced search</h2><p>The following image shows the advanced text search dialog.</p><p><img border="0" src="advanced_search.png"/></p><ul><li>As in the simple search the user can specify the string pattern he/she is looking for, and may indicate if he uses regular expression or if he wants to consider case, in the A area. </li><li>The user can filter the types of elements to search the string pattern in by selecting the UML metaClasses or applied stereotypes in area B . He can also choose in which attributes he wants to do the research. The stereotypes displayed in the B area are the stereotypes which can be applied on elements from the model(s) corresponding to the selected scope, for example if the selected scope is "Selected resources" only the stereotypes defined in the profiles applied on the current model will be displayed, but if the selected scope is "Workspace" the stereotypes defined in all the profiles applied on models from the current workspace will be displayed.</li><li>In the C area, the user can select all subelements of the actual selected element. For example, if the user selects "NamedElement" and clicks on "Select subelements",all metaClasses which inherit of UML::NamedElement will be checked. If the name attribute of "NamedElement" is checked and the user selects "NamedElement" and then clicks on "Select subelements",all instances of UML::NamedElement and their name attribute will be checked. If the user changes the selected scope he should click on the refresh types button, this will update the list of stereotypes displayed.</li><li>The user can specify, in the D area, if he wants to search for model elements with all the specified stereotype (the ones checked in the B area).</li></ul><p>In the following image we search the pattern "my" in the attribute body of the metaClass "Comment". The research will give us all the instances of "Comment" having an attribute body matching with the string pattern. </p><p><img border="0" src="body_search.png"/></p><p>The result will be</p><p><img border="0" src="body_result.png"/></p><p>If the user select a stereotype or an UML metaClass without indicating a string pattern, the research will give him all the instances of the metaClasses he checked and all the elements having the applied stereotypes he checked.</p><p>For example the result of this research:</p><pre><img border="0" src="requirement_search.png"/>
-</pre><p>will be</p><pre><img border="0" src="requirement_result.png"/>
-</pre><h1 id="OCL_search">OCL search</h1><p>The following image shows an OCL search dialog</p><p><img border="0" src="OCL.png"/></p><p>The user writes his OCL query in the A area.
-The scope must be "Selected resources" if the user wants to do this kind of query.</p><h1 id="Replace_String">Replace String</h1><p>Should the user want to replace the matches of your search with another string, he/she may click on the "Replace" button in the search dialog. A new dialog will popup:</p><p><img border="0" src="replace.png"/></p><p>More details about the refactoring tool in the Model Refactor Wizard page.</p><h1 id="Filter">Filter</h1><p>The user can filter the results of the search by selecting the types of the elements he/she wants to show.</p><p>For instance, on the following search (we use the model 1): </p><p><img border="0" src="a-search.png"/></p><p>the user may filter the results by clicking on the icon identified in a red rectangle in the following picture: </p><p><img border="0" src="a-results.png"/></p><p>this will open a new dialog where the user can select the metaclasses he/she want to show: </p><p><img border="0" src="filter.png"/></p><p>then, the result page will show only the matches of the selected type: </p><p><img border="0" src="my-filtered.png"/></p><p>If the user wants to remove this filtering, he/she may click on the Filters button as illustrated in previous picture. This will open the following dialog: </p><p><img border="0" src="select-filters.png"/></p><p><hr/>
-This work is developed by <a href="http://www-list.cea.fr">CEA LIST</a> and sponsored by <a href="http://www.ericsson.com">Ericsson</a> in the context of Polarsys <a href="http://wiki.eclipse.org/Polarsys">http://wiki.eclipse.org/Polarsys</a></p></body></html> \ No newline at end of file

Back to the top