<html><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; ">There are several steps to the query DSL:<div>&nbsp;1. implement the initial ideas and see what problems we face and how well that fits</div><div>&nbsp;2. add analyzers into the mix to transparently use the right one</div><div>&nbsp;3. add parameters that use the conversion bridge (not sure how well that could fly but an interesting idea</div><div>&nbsp;4. build up the stack of operators integrated into the DSL</div><div>&nbsp;5. string based QL using this API (not convinced yet but why not).</div><div><br></div><div><br></div><div>Navin will start working on 1 and if things go well 2 (we will have a fantastic tool already we do just that).</div><div><br></div><div>Here are my notes based on the initial idea + &nbsp;the feedback received.</div><div><br></div><div><br></div><div><span class="Apple-style-span" style="font-family: Arial; "><div><b><div><span class="Apple-style-span" style="font-weight: normal;">A few remarks:</span></div><div><span class="Apple-style-span" style="font-weight: normal;">&nbsp;- it asks the analyzer so that we correctly apply the analyzer on terms</span></div><div><span class="Apple-style-span" style="font-weight: normal;">&nbsp;- it has a few query factory methods</span></div><div><span class="Apple-style-span" style="font-weight: normal;">&nbsp;- it contains a few orthogonal operations</span></div><div><span class="Apple-style-span" style="font-weight: normal;">&nbsp;- I am not quite satisfied with how boolean is handled, any idea?</span></div><div><span class="Apple-style-span" style="font-weight: normal;"><br></span></div><div><span class="Apple-style-span" style="font-weight: normal;">Design remarks:</span></div><div><span class="Apple-style-span" style="font-weight: normal;">&nbsp;- should we use interfaces or plain implementations? I would start with plain implementations to make things easier</span></div><div><span class="Apple-style-span" style="font-weight: normal;">&nbsp;- let's put it in org.hibernate.search.query.dsl for now</span></div><div><span class="Apple-style-span" style="font-weight: normal;"><br></span></div><div>Examples</div><div><br></div><div><span class="Apple-style-span" style="font-weight: normal;"><div>SealedQueryBuilder qb = searchFactory.withEntityAnalyzer(Address.class);</div><div><br></div><div>Query luceneQuery = qb.must()</div><div>&nbsp;&nbsp;&nbsp; .add(</div><div>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; qb.should()</div><div>&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;.add( qb.term("city", "Atlanta").boostedTo(4).createQuery() )</div><div>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; .add( qb.term("address1", "Peachtree").fuzzy().createQuery() )</div><div>&nbsp;&nbsp;&nbsp; )</div><div>&nbsp;&nbsp;&nbsp; .add(</div><div>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; qb.range("movingDate").from("200604").to("201201").exclusive().createQuery()</div><div>&nbsp;&nbsp; &nbsp;)</div><div>&nbsp;&nbsp; &nbsp;.createQuery();</div><div>&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp;</div></span></div></b></div><div><b><br></b></div><div><b>Analyzer choice</b></div><div>queryBuilder.withAnalyzer(Analyzer)</div><div>queryBuilder.withEntityAnalyzer(Class&lt;?&gt;)</div><div>queryBuilder.basedOnEntityAnalyzer(Class&lt;?&gt;)</div><div>&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;.overridesForField(String field, Analyzer)</div><div>&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;.overridesForField(String field, Analyzer)</div><div>&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;.build() //sucky name</div><div>returns a SealedQueryBuilder //sucky name</div><div><br></div><div>SealedQueryBuilder contains the factory methods</div><div><br></div><div><b><br></b></div><div><b>Factory methods</b></div><div>Hosted onSealedQueryBuilder</div><div><br></div><div>//Alternative</div><div>.term().on(String field).matches(String text)</div><div>.on(String field).matches(String text)</div><div><br></div><div><br></div><div>.term(String field, String text) //define a new query</div><div>.term(String field, String text) //define a new query</div><div>&nbsp;&nbsp; .ignoreAnalyzer() //ignore the analyzer, optional</div><div>&nbsp;&nbsp;&nbsp;.fuzzy()&nbsp;//API prevent wildcard calls, optional</div><div>&nbsp;&nbsp; &nbsp; .threshold()&nbsp;//optional</div><div>&nbsp;&nbsp; &nbsp; .prefixLengh() //optional</div><div>.term(String field, String value)</div><div>&nbsp;&nbsp; .wildcard()&nbsp;//API prevent fuzzy calls, optional</div><div><br></div><div>//range query</div><div>.rangeQuery(String field)</div><div>&nbsp;&nbsp; &nbsp;.from(String text)</div><div>&nbsp;&nbsp; &nbsp;.to(String text)</div><div>&nbsp;&nbsp; &nbsp;.exclusive() //optional</div><div>&nbsp;&nbsp; &nbsp;.constantScore() //optional, due to constantScoreRangeQuery but in practice inherited from the common operations</div><div><br></div><div>//match all docs</div><div>.all()&nbsp;</div><div><br></div><div>//phrase query</div><div>.phrase(String field)</div><div>&nbsp;&nbsp; &nbsp;.ignoreAnalyzer() //ignore the analyzer, optional</div><div>&nbsp;&nbsp; &nbsp;.addWord(String text) //at least one</div><div>&nbsp;&nbsp; &nbsp;.addWord(String text)</div><div>&nbsp;&nbsp; &nbsp;.sentence(String text) //do we need that?</div><div>&nbsp;&nbsp; &nbsp;.slop() //optional</div><div><br></div><div>//search multiple fields for same value</div><div>.searchInMultipleFields()</div><div>&nbsp;&nbsp;.onField(String field)</div><div>&nbsp;&nbsp; &nbsp; &nbsp;.boostedTo(float) //optional</div><div>&nbsp;&nbsp; &nbsp; &nbsp;.ignoreAnalyzer()&nbsp;//optional</div><div>&nbsp;&nbsp;.onField(String field)</div><div>&nbsp;&nbsp;.forWords(String) //do we need that?</div><div>&nbsp;&nbsp;.forWord(String)</div><div><br></div><div><br></div><div><b>Boolean operations</b></div><div>SealedQueryBuilder contains the boolean methods</div><div><div><br></div><div>.must()<br></div><div>&nbsp;&nbsp;.add( qb.from().to() )</div><div>&nbsp;&nbsp;.add( ... )</div><div>.must().not()</div><div>.should()</div><div><br></div></div><div><br></div><div><b>Works on all queries</b></div><div>&nbsp;&nbsp; &nbsp;.boostedTo()</div><div>&nbsp;&nbsp; &nbsp;.constantScore()&nbsp;</div><div>&nbsp;&nbsp; &nbsp;.filter(Filter) //filter the current query</div><div>&nbsp;&nbsp; &nbsp;.scoreMultipliedByField(field) //FieldScoreQuery + FunctionQuery?? //Not backed</div><div>&nbsp;&nbsp; &nbsp;.createQuery()</div><div><br></div><div><br></div><div><b>Todo</b></div><div>Span*Queries</div><div>&nbsp;&nbsp;</div><div>MultiPhraseQuery - needs to fillup all accepted terms</div><div>FieldScoreQuery</div><div>ValueSourceQuery</div><div>FuzzyLikeThis</div><div>MoreLikeThis</div><div><br></div></span></div></body></html>