Parameter searching documenation

[GoogleCodeExporter]

The ICAT API is in general not well documented (for users), but most of the 
time this is not a problem as the methods are obvious.

Parameter searching is more complicated and requires documentation on how to 
use it, including examples (ideally in Java + one other language)

Original issue reported on code.google.com by tom.grif...@stfc.ac.uk on 29 Sep 2010 at 10:25

[GoogleCodeExporter]

Good example is the comparisonOperator enum - what are the BETWEEN operators 
for?

Original comment by tom.grif...@stfc.ac.uk on 29 Sep 2010 at 10:35

[GoogleCodeExporter]

Hi,

The idea of BETWEEN operators was to allow a more detailed search (a < b < c, a 
<= b <c, a <= b <= c), but it's not implemented and thinking carefully, maybe 
it won't be so useful, because you can do same adding more comparison 
conditions.

I'll make a little document to describe how to use ParameterSearch and add 
serverals examples.

Here there is an example of how to construct a simple comparasion condition:

    // Get the parameter, manually or get from a service
    Parameter paramDatfile = new Parameter(new ParameterPK("deg", "datafile1"));

    // Create the parameter to compare with. Two argument: type of the parameter
    //  to compare and the parameter. (Try to find a better name to parameterValued)
    ParameterValued pamVal = new ParameterValued(ParameterType.DATAFILE, paramDatfile);

    // Create the comparasion
    ParameterComparisonCondition comp = new ParameterComparisonCondition();

    // Add the parameterValued
    comp.setParameterValued(pamVal);
    // Add the comparator
    comp.setComparator(ComparisonOperator.BETWEEN);
    // Add the value to compare
    comp.setDatetimeValue(new Date(0));
    // Add a second value if needed (only for BETWEEN)
    comp.setDatetimeValueRight("2010-10-10 00:00:00");

Original comment by cruzcruz...@gmail.com on 6 Oct 2010 at 1:05

[GoogleCodeExporter]

Kevin Phipps will be joining the CLF-ICAT project at RAL on Friday 15th April 
2011 and has been asked to look into this ticket.  We expect some progress by 
June 2011.

Original comment by crcami...@gmail.com on 13 Apr 2011 at 4:20

[GoogleCodeExporter]

Kevin Phipps will be joining the CLF-ICAT project at RAL on Friday 15th April 
2011 and has been asked to look into this ticket.  We expect some progress by 
June 2011.

Original comment by crcami...@gmail.com on 13 Apr 2011 at 4:21

[GoogleCodeExporter]

Assigning ticket to myself

Original comment by kevin.ph...@googlemail.com on 27 Apr 2011 at 2:42

[GoogleCodeExporter]

Parameter searching is now deprecated in favour of the new API. Detailed 
documentation is being prepared for 4.1. This will be marked as WontFix - 
however API doc is being done!

Original comment by dr.s.m.f...@gmail.com on 29 May 2012 at 3:34

• Changed state: WontFix