User Guide

-----Java based document search tool

About this guide.

The document is divided into following parts:
Chapter1. Chapter2. Chapter3. Chapter4. Introduction about our application Brief overview of user Interface Getting started, explanation of the application usage. Key functions

Chapter1. Introduction about our application 1. Intro

The advanced document searching tool is a convenient searching application (like Internet search engines or Google Search) which is able to find local documents (the only prerequisite is the documents are well indexed). Its efficiency and portability makes document management easier.

2. Why this application?

Support for different formats: doc, pdf, txt, mp3, jpg, rmvb, zip,rar. Support files corresponding metadata. Support indexation of multiple directories. Support multiple directories can be blacklisted and then circumvented by the indexer. User-friendly GUI interface with configuration of searching and indexing. Support fuzziness searching, can find word which is misspelled. Available to store queries and incremental. Support different searching combination (Conjunction, Disjunction, Negation) Portability (support searching and indexing on Windows, Linux, Mac)

Chapter2.

Brief overview of user Interface

Function Window as following (figure 2)

Figure 2. Function Window of Searching Tool 1. Must contain: search content must contain keyword(s). 2. May contain: search content may contain keyword(s). 3. Must not contain: search content must NOT contain keyword(s). 4. Only by name: to limit the search keyword(s) as a partial word which is included in the file name.

5. Initial date: search by initial date (search documents and files which are created or modified after this date). 6. Final date: search by final date(search documents and files which are created or modified before this date) 7. Exclude this date of range: to search file outside a range of date (from initial date to final date). 8. Last modified date: to search file by its last modified date. 9. Creation date: to search file by its creation date. 10. Exact match: search file with exactly correct spelling. 11. Accuracy: by setting 4 (0.7/0.8/0.9/1.0) levels of fuzziness to adjust searching accuracy. 12. Directories to Index: multiple directories to index is available. 13. Directories to Avoid: multiple directories to block is available. 14. Index: button for starting to index. 15. Search: button for starting to search. 16. Stop: force to stop searching. 17. Queries: store queries, support restart search, user could double click the query to get the result.

Chapter3. Getting started,explanation of the application usage.

1. Indexing. Open the application, input directories (Eg.C:/rika) which include the search target in the directories to index blank. Click Index button to start indexing. User window as following, figure3.1

Figure3.1 index directories

2.Searching. When it index ready, begin to search. a. search by content or name, support different search possibility, as following functional table2.1. (Assume insert keyword(s) A in must contain blank, B in may contain blank and C in must not contain blank) Must Must
Must contain keyword

May
Must contain keyword A and may contain keyword B.

Must Not
Must contain keyword A and must not contain keyword C May contain keyword B and must not contain keyword C

May

----------

May contain keyword

Must Not

----------

------------

------------

Table3.1 Function table for search by content or name

b. search by date a time point(specific date), a range of time, search by initial date, the last modified date, the creation date. Description as following functional table2.2. Specific Date Last Modified Date Creation Date
Search by the last modified date Search by the creation date

During Time period

Search by the last modified date within a time period Search by the creation date

Exclude Time Period

Search by the last modified date outside a time period Search by the creation date

within a time period

outside a time period

Table3.2 Function table for search by date

c. The search support application of wildcard. When user input a partial keyword with a symbol *, its automatically default as a function of wild card, to substitute for any possible characters in the string. For example, the user wants to search a file verified software system through a indexed directory, but he just remember parts of the name is verifi, then its possible to use wild card to search, as the figure3.2 shows.

Figure3.2 wildcard functionality

d. Adjust accuracy level while searching. Its common to have misspelling, to avoid the searching results are influence by this kind of mistake, user can adjust the accuracy to modify the search matching degree. For example, the user want to search by name rika, but misspell it into riki, in the accuracy 0.8 or higher level, the corresponding results will not be shown, while if the accuracy level is decreased as 0.7, there will be the results for rika. as the figure3.3 figure3.4 shows.

figure3.3 higher accuracy will filter the misspelling

figure3.4 reduce accuracy, misspelling available

e. blacklist directories. Sometimes, to avoid some specific files among the indexed folders is one of the requirements of user. The application supports to exclude multiple directories. While searching, the files which under the directories in Directories to avoid blank will not be shown in the result.

f. stop function to force quit While searching/indexing, by clicking stop to end the current task.

g. search recalling To some extent, It is necessary to recall the search result to avoid redundancy. Every time after searching, the information will be stored in the query. And by double click the query, user could recall the search result again. For example, user wants to get the previous result to search file rika, double click the stored query as figure3.5 shows. Then the corresponding search result will be recalled and shown, as figure3.6 shows.

Figure3.5 double click query to restart search

Figure3.6 recall the search result

Chapter4. Key functions 1. Index.

a. Indexing of directories is configurable and incremental. b. Support to index txt , pdf, rar, mp3, doc, jpg, rmvb, jar.

2. Search
a. Support search by name and content (logic combinations available). b. Support search by date (specific date, range of date, exclude a range of date). c. Name, location, type, date of last modification and date of creation date are shown in the result blank. d. Files can be opened directly from the result list. e. Able to store query and recall search result. f. Access root, unlocked and unknown file can be searched. g. Support to blacklist multiple directories. h. Support wild-card and fuzzy search (adjust accuracy level). i. Support force quit from index or search process.

3. Portability
Possible running on 3 operation systems---Windows, Linux, MAC OS.