Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expose sort and custom queries (instead of using QueryParser) #20

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Expose sort and custom queries (instead of using QueryParser) #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 39 additions & 18 deletions src/clucy/core.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
(org.apache.lucene.search.highlight Highlighter QueryScorer
SimpleHTMLFormatter)
(org.apache.lucene.util Version AttributeSource)
(org.apache.lucene.store NIOFSDirectory RAMDirectory Directory)))
(org.apache.lucene.store NIOFSDirectory RAMDirectory Directory)
(org.apache.lucene.search Sort SortField SortField$Type)))

(def ^{:dynamic true} *version* Version/LUCENE_CURRENT)
(def ^{:dynamic true} *analyzer* (StandardAnalyzer. *version*))
Expand Down Expand Up @@ -169,24 +170,42 @@ fragments."
^String separator))))
(constantly nil)))

(defn create-sort
"Utility function for creating a Sort instance for sorting search results.
Accepts the following field types: :int, :long, :score, :double, :float, :string, defaults to :string"
[field & {:keys [type reverse?]}]
(let [field-type (case type
:int SortField$Type/INT
:long SortField$Type/LONG
:score SortField$Type/SCORE
:double SortField$Type/DOUBLE
:float SortField$Type/FLOAT
:string SortField$Type/STRING
SortField$Type/STRING)]
(Sort. (SortField. field field-type (or reverse? false)))))

(defn search
"Search the supplied index with a query string."
"Search the supplied index with a query string or instantiated lucene query extending the Query class, e.g. TermQuery or BooleanQuery."
[index query max-results
& {:keys [highlight default-field default-operator page results-per-page]
& {:keys [highlight default-field default-operator page results-per-page sort]
:or {page 0 results-per-page max-results}}]
(if (every? false? [default-field *content*])
(throw (Exception. "No default search field specified"))
(with-open [reader (index-reader index)]
(when (not (or (string? query) (instance? Query query))) (throw (Exception. "Unsupported query type.")))
(when (every? false? [default-field *content*]) (throw (Exception. "No default search field specified")))
(with-open [reader (index-reader index)]
(let [default-field (or default-field :_content)
searcher (IndexSearcher. reader)
parser (doto (QueryParser. *version*
(as-str default-field)
*analyzer*)
(.setDefaultOperator (case (or default-operator :or)
:and QueryParser/AND_OPERATOR
:or QueryParser/OR_OPERATOR)))
query (.parse parser query)
hits (.search searcher query (int max-results))
parse-query? (not (instance? Query query))
parser (when parse-query?
(doto (QueryParser. *version*
(as-str default-field)
*analyzer*)
(.setDefaultOperator (case (or default-operator :or)
:and QueryParser/AND_OPERATOR
:or QueryParser/OR_OPERATOR))))
query (if parse-query? (.parse parser query) query)
hits (if sort
(.search searcher query (int max-results) sort)
(.search searcher query (int max-results)))
highlighter (make-highlighter query searcher highlight)
start (* page results-per-page)
end (min (+ start results-per-page) (.totalHits hits))]
Expand All @@ -199,17 +218,19 @@ fragments."

highlighter))
{:_total-hits (.totalHits hits)
:_max-score (.getMaxScore hits)}))))))
:_max-score (.getMaxScore hits)})))))

(defn search-and-delete
"Search the supplied index with a query string and then delete all
"Search the supplied index with a query string or instantiated lucene query and then delete all
of the results."
([index query]
(if *content*
(search-and-delete index query :_content)
(throw (Exception. "No default search field specified"))))
([index query default-field]
(when (not (or (string? query) (instance? Query query))) (throw (Exception. "Unsupported query type.")))
(with-open [writer (index-writer index)]
(let [parser (QueryParser. *version* (as-str default-field) *analyzer*)
query (.parse parser query)]
(let [parse-query? (not (instance? Query query))
parser (when parse-query? (QueryParser. *version* (as-str default-field) *analyzer*))
query (if parse-query? (.parse parser query) query)]
(.deleteDocuments writer query)))))
21 changes: 20 additions & 1 deletion test/clucy/test/core.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,23 @@
(is (== 1 (count (search index "m*" 10 :page 1 :results-per-page 3))))
(is (empty? (intersection
(set (search index "m*" 10 :page 0 :results-per-page 3))
(set (search index "m*" 10 :page 1 :results-per-page 3))))))))
(set (search index "m*" 10 :page 1 :results-per-page 3)))))))

(testing "sorting by name"
(let [index (memory-index)
_ (doseq [person people] (add index person))
results (search index "m*" 10 :sort (create-sort "name"))]
(is (= "Mary" (:name (first results))))
(is (= "Miles" (:name (last results))))))

(testing "sorting by age"
(let [index (memory-index)]
(doseq [person people] (add index person))
(is (= "Melinda" (:name (first (search index "m*" 10 :sort (create-sort "age" :type :float))))))
(is (= "Mary" (:name (last (search index "m*" 10 :sort (create-sort "age" :type :float))))))))

(testing "reverse sorting by age"
(let [index (memory-index)]
(doseq [person people] (add index person))
(is (= "Mary" (:name (first (search index "m*" 10 :sort (create-sort "age" :type :float :reverse? true))))))
(is (= "Melinda" (:name (last (search index "m*" 10 :sort (create-sort "age" :type :float :reverse? true)))))))))