[infinispan-dev] Which QueryBuilder ?

[Martin Gencur]

Right Sanne,
it's already starting to be a documentation problem for the product. 
It's really confusing unless you developed one of these APIs and 
precisely know the differences :) Any time there's a code snippet, it 
must contain the package (usually this is not needed), but even then 
it's easy to get confused.

Martin


On 3.10.2013 16:48, Sanne Grinovero wrote:
> On 3 October 2013 14:10, Adrian Nistor <anistor at redhat.com> wrote:
>> I know, was just joking. Anyway, I don't see any confusion having two
>> classes with the same name.
> It's going to be hard enough to explain to people why we are providing
> two different approaches, if we can't even think of a different name
> to properly highlight the different usage then we have a problem.
>
> Try figuring the forum / support question "I'm using QueryBuilder on
> Infinispan 7.3 and this happens... "
>
> The javadoc index will have it listed twice -> annoying.
>
> Google for "QueryBuilder Infinispan" -> annoying
>
> Or try figuring out the documentation:
>
> # Chapter 5: Queries.
> There are two approaches to run Queries in Infinispan. Either you use
> the QueryBuilder, which provides simple domain oriented properties and
> can work both in embedded and remote mode, or you use the more
> powerfull QueryBuilder.
>
> # 5.1 QueryBuilder
> blah blah
>
> # 5.2 QueryBuilder
> blah blah
>
>
> If they are different, the should really have different names, even
> just to avoid confusion among ourselves when talking about hem. If you
> feel they're the same, the interesting alternative is to literally
> merge them in one single interface, potentially exposing multiple
> methods.
>
> Sanne
>
>> On 10/03/2013 02:29 PM, Emmanuel Bernard wrote:
>>> It's already productized code.
>>>
>>> On Thu 2013-10-03 14:16, Adrian Nistor wrote:
>>>> I would suggest renaming the old one :))
>>>>
>>>> On 10/02/2013 11:13 PM, Sanne Grinovero wrote:
>>>>> It seems we have now 2 different interfaces both names "QueryBuilder"
>>>>> when using Infinispan Query.
>>>>> One is coming from Hibernate Search, and represents the "classic" way
>>>>> to build queries for Infinispan Query in embedded mode.
>>>>>
>>>>> The other one is new, and represents the simplified approach, also
>>>>> implemented for remote queries.
>>>>>
>>>>> Could we find an alternative name for the new API?
>>>>>
>>>>> It's certainly going to be confusing, even more when we'll have to
>>>>> document the differences, and which one is more suited for one use
>>>>> cases vs. another.
>>>>>
>>>>> Cheers,
>>>>> Sanne
>>>>> _______________________________________________
>>>>> infinispan-dev mailing list
>>>>> infinispan-dev at lists.jboss.org
>>>>> https://lists.jboss.org/mailman/listinfo/infinispan-dev
>>>> _______________________________________________
>>>> infinispan-dev mailing list
>>>> infinispan-dev at lists.jboss.org
>>>> https://lists.jboss.org/mailman/listinfo/infinispan-dev
>>> _______________________________________________
>>> infinispan-dev mailing list
>>> infinispan-dev at lists.jboss.org
>>> https://lists.jboss.org/mailman/listinfo/infinispan-dev
>> _______________________________________________
>> infinispan-dev mailing list
>> infinispan-dev at lists.jboss.org
>> https://lists.jboss.org/mailman/listinfo/infinispan-dev
> _______________________________________________
> infinispan-dev mailing list
> infinispan-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/infinispan-dev