Technical Documentation and Prototype

CHANGELOG.md

@@ -13,6 +13,7 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
 
 - We added confirmation dialog when user wants to close a library where any empty entires are detected. [#8096](https://github.com/JabRef/jabref/issues/8096)
 - We added import support for CFF files. [#7945](https://github.com/JabRef/jabref/issues/7945)
+- We added support to use Lucence search syntax also for the searchin the library or in dynamic groups.
 - We added the option to copy the DOI of an entry directly from the context menu copy submenu. [#7826](https://github.com/JabRef/jabref/issues/7826)
 - We added a fulltext search feature. [#2838](https://github.com/JabRef/jabref/pull/2838)
 - We improved the deduction of bib-entries from imported fulltext pdfs. [#7947](https://github.com/JabRef/jabref/pull/7947)

docs/sweng/diagrams.pu

@@ -0,0 +1,265 @@
+' +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+@startuml class-diagram
+mainframe **Class Diagram: "Better Search" Implementation  **
+' package LEGEND {
+'     class Existing as " Existing Classes " #White
+'     hide  Existing circle
+'     hide  Existing methods
+'     hide  Existing members
+
+'     class New as " New Classes "
+'     hide  New circle
+'     hide  New methods
+'     hide  New members
+
+'     ' Workaround to prevent PlantUML from positioning the legend blocks randomly.
+'     Existing -[hidden]- New
+' }
+
+' =======================================================
+' Grouping
+' =======================================================
+together {
+    class DropDownMenu
+    class SearchFieldSynchronizer
+}
+
+' =======================================================
+' Relations
+' =======================================================
+CustomTextField - GlobalSearchbar
+SearchItem *- itemType
+RecentSearch <- SearchFieldSynchronizer
+GlobalSearchbar -- Highlighting
+GlobalSearchbar <-- Autocomplete
+DropDownMenu <-- RecentSearch
+
+SearchFieldSynchronizer -- LuceneBasedSearchRule
+SearchItem "0...*" -> "1 " SearchFieldSynchronizer
+JFXChipView -- SearchFieldSynchronizer
+DropDownMenu --> SearchFieldSynchronizer
+CustomTextField <-- TextInputControl
+Autocomplete <-- TextInputControl
+TextInputControl <-- SearchFieldSynchronizer
+RecentSearch "1 " <-- "0...*" SearchItem
+
+' =======================================================
+' Classes
+' =======================================================
+class GlobalSearchbar #TECHNOLOGY {
+    searchField: CustomTextField
+    updateSearchResultsForQuery()
+    ' initSearchModifierButtons()
+    ' initSearchModifierButton()
+    ' focus()
+    performSearch()
+    ' validRegex()
+    ' informUserAboutInvalidSearchQuery()
+    updateResults()
+    ' setSearchFieldHintTooltip()
+    ' updateHintVisibility()
+    ' registerEventListener()
+    ' onSuggestionChosen()
+}
+
+class Highlighting #TECHNOLOGY {
+
+}
+
+class RecentSearch #PeachPuff {
+    pastSearchItemList: ArrayList<SearchItem>
+    ListView<String> authors
+    ListView<String> titles
+    show()
+    hide()
+    add()
+    checkSearchItemExists()
+
+}
+
+class DropDownMenu #PeachPuff {
+    authorBtn: Button
+    journalBtn: Button
+    titleBtn: Button
+    yearBtn: Button
+    andBtn: Button
+    orBtn: Button
+    andMinusBtn: Button
+    orMinusBtn: Button
+    isPrevAttribute: boolean
+    checkAndAddSpace()
+    isPrevAttribute()
+}
+
+class LuceneBasedSearchRule #TECHNOLOGY {
+    validateSearchStrings()
+}
+
+class Autocomplete #TECHNOLOGY {
+    AutoCompletionTextFieldBinding<T> String
+    AutoCompletePopup<T> autoCompletionPopup
+    bindAutoCompletion()
+}
+
+class SearchFieldSynchronizer #PeachPuff {
+    searchItemList: ArrayList<SearchItem>
+    searchString: String 
+    compare()
+    updateList()
+    addSearchItemToList()
+    removeSearchItemToList()
+    insertSearchItemToList()
+    SearchStringBuilder()
+    validateButton()
+}
+
+class SearchItem #PeachPuff {
+    itemType: enum 
+    item: String
+    getType()
+    get()
+    setType()
+    set()
+}
+
+enum itemType #PeachPuff {
+    logicalOperator
+    attribute
+    bracket
+}
+
+class CustomTextField #TECHNOLOGY {
+    get()
+    get(int start, int end)
+    length()
+    addListener()
+}
+
+class TextInputControl #TECHNOLOGY {
+    getText()
+    insertText()
+    deleteText()
+    replaceText()
+    positionCaret()
+    getCarretPosition()
+    getLength()
+}
+
+class JFXChipView #TECHNOLOGY {
+    chips
+    StringConverter()
+}
+@enduml
+
+' +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+' Julian: Recent Search
+@startuml recent-search
+mainframe **Sequence Diagram: Recent Search  **
+actor User
+User -> GlobalSearchBar: performSearch()
+GlobalSearchBar -> RecentSearch: addQueryToRecentSearches
+User -> RecentSearch: clickOnRecentSearchEntry
+RecentSearch -> GlobalSearchBar: performSearch()
+@enduml
+
+' +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+' Mark: User Search Input
+@startuml user-search-input
+mainframe **Sequence Diagram: User Search Input  **
+actor User
+User -> DropDownMenu: Button Input
+box **SearchFieldSynchronizer**
+DropDownMenu -> SearchFieldSynchronizer: <font color=green>                ActionEvent
+entity searchItemList
+SearchFieldSynchronizer -> searchItemList: addSearchItemToList()
+searchItemList --> SearchFieldSynchronizer: SearchStringBuilder()
+end box
+box **CustomTextField** #White
+entity searchField
+SearchFieldSynchronizer -> searchField: replaceText()
+end box
+
+User -> searchField: Text Input
+searchField --> SearchFieldSynchronizer: <font color=green>EventListener
+SearchFieldSynchronizer -> searchItemList: updateList()
+searchItemList --> SearchFieldSynchronizer: SearchStringBuilder()
+SearchFieldSynchronizer -> searchField: replaceText()
+@enduml
+
+' +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+' Albert: Autocomplete
+@startuml
+mainframe **Sequence Diagram: Autocomplete  **
+actor User
+User -> AutoCompletePopup: bindAutoCompletion()
+AutoCompletePopup -> AutoCompletionTextInputBinding: convertSuggestionsToStrings
+AutoCompletionTextInputBinding -> GlobalSearchBar: provideSuggestionsInGlobalSearch
+GlobalSearchBar -> AutoCompletePopup: bindAutoCompletion()
+@enduml
+
+' +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+' Dani: ChipView
+@startuml
+mainframe Sequence Diagram: ChipView 
+actor User
+User->GlobalSearchBar: performSearch()
+GlobalSearchBar->ChipView: addChipViewToSearchField()
+User->ChipView: clickOnChipInSearchField
+ChipView->GlobalSearchBar:deleteChosenSearchkey()
+@enduml
+
+' +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+' Mark: Logical Operators
+@startuml logic-operators
+mainframe **Activity Diagram: Logic Operators  **
+start
+switch ( Button Press )
+case (  )
+    :Attribute;
+    if (leftSideExists?) then
+        if (isLeftAttribute?) then
+            if (isLeftAttributeWithoutSearchString?) then
+                #pink:do nothing;
+                kill
+            endif
+        #palegreen:Add OR;
+        endif
+    endif
+    #palegreen:Add attribute;
+    stop
+case (  ) 
+    switch ( Logic Operator )
+        case ( )
+        :1;
+            if (leftSideExists?) then
+                if (isLeftAttribute?) then
+                    if (isLeftAttributeWithSearchString?) then
+                        #palegreen:Add logic operator;
+                        kill
+                    endif
+                endif
+            endif
+        #pink:do nothing;
+        stop
+        case (  )
+        :-1;
+        if (!MinusOneExists?) then
+            if (leftSideExists?) then
+                if (isLeftAttribute?) then
+                    if (isLeftAttributeWithSearchString?) then
+                        #palegreen:Add right bracket;
+                        #palegreen:Add logic operator;
+                        #palegreen:Add left bracket;
+                        :positionCarret to start;
+                        #palegreen:Add left bracket;
+                        :positionCarret to end;
+                        #palegreen:Add right bracket;
+                        :positionCarret to end - 1;
+                        kill
+                    endif
+                endif
+            endif
+        endif
+        #pink:do nothing;
+    stop
+@enduml

docs/sweng/legend.pu

@@ -0,0 +1,6 @@
+@startuml legend #White
+legend right 
+    |<#TECHNOLOGY>     | <#White> Existing class |
+    |<#PeachPuff>      | <#White> New class |
+endlegend
+@enduml