You are viewing a plain text version of this content. The canonical link for it is here.
Posted to torque-dev@db.apache.org by "Wenderdel, Carsten (LNG-MUE)" <Ca...@lexisnexis.de> on 2006/02/01 10:44:27 UTC

Mistakes in JavaDoc of Criteria

Hi,

I'm not sure whether this is the proper place or it is an unknown issue - if
not I apologize.

I just read the API
http://db.apache.org/torque/runtime/apidocs/org/apache/torque/util/Criteria.
html and have found some mistakes.

For example the method
    public Criteria add(java.lang.String column,
                        java.lang.Object value,
                        SqlEnum comparison)
is commented:

    If is used as follow:
    Criteria crit = new Criteria().add("column", "value",
        "Criterion.GREATER_THAN");

This should be wrong as comparison is an object of SQLEnum and not of
String. Furthermore Criterion has not a static field "GREATER_THAN", so imo
it should be:

    This is used as follows:
    Criteria crit = new Criteria().add("column", "value",
        Criteria.GREATER_THAN);


This applies also to following methods:

public Criteria add(java.lang.String table,
                    java.lang.String column,
                    java.lang.Object value,
                    SqlEnum comparison)

public Criteria and(java.lang.String column,
                    java.lang.Object value,
                    SqlEnum comparison)

public Criteria and(java.lang.String table,
                    java.lang.String column,
                    java.lang.Object value,
                    SqlEnum comparison)

public Criteria or(java.lang.String column,
                   java.lang.Object value,
                   SqlEnum comparison)

public Criteria or(java.lang.String table,
                   java.lang.String column,
                   java.lang.Object value,
                   SqlEnum comparison)

Regards, Carsten

---------------------------------------------------------------------
To unsubscribe, e-mail: torque-dev-unsubscribe@db.apache.org
For additional commands, e-mail: torque-dev-help@db.apache.org


Re: Mistakes in JavaDoc of Criteria

Posted by Thomas Fischer <tf...@apache.org>.
I have fixed this in svn.

    Thomas

On Sun, 5 Feb 2006, Thomas Fischer wrote:

> Thanks a lot for noting that. I'll correct it.
>
>  Thomas
>
> On Wed, 1 Feb 2006, Wenderdel, Carsten (LNG-MUE) wrote:
>
>> Hi,
>> 
>> I'm not sure whether this is the proper place or it is an unknown issue - 
>> if
>> not I apologize.
>> 
>> I just read the API
>> http://db.apache.org/torque/runtime/apidocs/org/apache/torque/util/Criteria.
>> html and have found some mistakes.
>> 
>> For example the method
>>    public Criteria add(java.lang.String column,
>>                        java.lang.Object value,
>>                        SqlEnum comparison)
>> is commented:
>>
>>    If is used as follow:
>>    Criteria crit = new Criteria().add("column", "value",
>>        "Criterion.GREATER_THAN");
>> 
>> This should be wrong as comparison is an object of SQLEnum and not of
>> String. Furthermore Criterion has not a static field "GREATER_THAN", so imo
>> it should be:
>>
>>    This is used as follows:
>>    Criteria crit = new Criteria().add("column", "value",
>>        Criteria.GREATER_THAN);
>> 
>> 
>> This applies also to following methods:
>> 
>> public Criteria add(java.lang.String table,
>>                    java.lang.String column,
>>                    java.lang.Object value,
>>                    SqlEnum comparison)
>> 
>> public Criteria and(java.lang.String column,
>>                    java.lang.Object value,
>>                    SqlEnum comparison)
>> 
>> public Criteria and(java.lang.String table,
>>                    java.lang.String column,
>>                    java.lang.Object value,
>>                    SqlEnum comparison)
>> 
>> public Criteria or(java.lang.String column,
>>                   java.lang.Object value,
>>                   SqlEnum comparison)
>> 
>> public Criteria or(java.lang.String table,
>>                   java.lang.String column,
>>                   java.lang.Object value,
>>                   SqlEnum comparison)
>> 
>> Regards, Carsten
>> 
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: torque-dev-unsubscribe@db.apache.org
>> For additional commands, e-mail: torque-dev-help@db.apache.org
>> 
>> 
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: torque-dev-unsubscribe@db.apache.org
> For additional commands, e-mail: torque-dev-help@db.apache.org
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: torque-dev-unsubscribe@db.apache.org
For additional commands, e-mail: torque-dev-help@db.apache.org


Re: Mistakes in JavaDoc of Criteria

Posted by Thomas Fischer <tf...@apache.org>.
Thanks a lot for noting that. I'll correct it.

   Thomas

On Wed, 1 Feb 2006, Wenderdel, Carsten (LNG-MUE) wrote:

> Hi,
>
> I'm not sure whether this is the proper place or it is an unknown issue - if
> not I apologize.
>
> I just read the API
> http://db.apache.org/torque/runtime/apidocs/org/apache/torque/util/Criteria.
> html and have found some mistakes.
>
> For example the method
>    public Criteria add(java.lang.String column,
>                        java.lang.Object value,
>                        SqlEnum comparison)
> is commented:
>
>    If is used as follow:
>    Criteria crit = new Criteria().add("column", "value",
>        "Criterion.GREATER_THAN");
>
> This should be wrong as comparison is an object of SQLEnum and not of
> String. Furthermore Criterion has not a static field "GREATER_THAN", so imo
> it should be:
>
>    This is used as follows:
>    Criteria crit = new Criteria().add("column", "value",
>        Criteria.GREATER_THAN);
>
>
> This applies also to following methods:
>
> public Criteria add(java.lang.String table,
>                    java.lang.String column,
>                    java.lang.Object value,
>                    SqlEnum comparison)
>
> public Criteria and(java.lang.String column,
>                    java.lang.Object value,
>                    SqlEnum comparison)
>
> public Criteria and(java.lang.String table,
>                    java.lang.String column,
>                    java.lang.Object value,
>                    SqlEnum comparison)
>
> public Criteria or(java.lang.String column,
>                   java.lang.Object value,
>                   SqlEnum comparison)
>
> public Criteria or(java.lang.String table,
>                   java.lang.String column,
>                   java.lang.Object value,
>                   SqlEnum comparison)
>
> Regards, Carsten
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: torque-dev-unsubscribe@db.apache.org
> For additional commands, e-mail: torque-dev-help@db.apache.org
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: torque-dev-unsubscribe@db.apache.org
For additional commands, e-mail: torque-dev-help@db.apache.org