dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 21000
committer: Morten Olav Hansen <mortenoh@xxxxxxxxx>
branch nick: dhis2
timestamp: Tue 2015-11-10 09:29:55 +0700
message:
  minor javadoc update
modified:
  dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/query/QueryParser.java


--
lp:dhis2
https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk

Your team DHIS 2 developers is subscribed to branch lp:dhis2.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk/+edit-subscription

=== modified file 'dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/query/QueryParser.java'
--- dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/query/QueryParser.java	2015-11-06 08:31:07 +0000
+++ dhis-2/dhis-services/dhis-service-core/src/main/java/org/hisp/dhis/query/QueryParser.java	2015-11-10 02:29:55 +0000
@@ -31,9 +31,23 @@
 import java.util.List;
 
 /**
+ * TODO add support for Order
+ *
  * @author Morten Olav Hansen <mortenoh@xxxxxxxxx>
  */
 public interface QueryParser
 {
+    /**
+     * Parses filter expressions, need 2 or 3 components depending on operator.
+     * i.e. for null you can use "name:null" which checks to see if property name is null
+     * i.e. for eq you can use "name:eq:ANC" which check to see if property name is equal to ANC
+     * <p>
+     * The general syntax is "propertyName:operatorName:<Value to check against if needed>"
+     *
+     * @param klass   Class type to query for
+     * @param filters List of filters to add to Query
+     * @return Query instance based on Schema of klass and filters list
+     * @throws QueryParserException
+     */
     Query parse( Class<?> klass, List<String> filters ) throws QueryParserException;
 }