dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 14828
committer: Morten Olav Hansen <mortenoh@xxxxxxxxx>
branch nick: dhis2
timestamp: Mon 2014-04-14 13:43:16 +0700
message:
  javadoc updates
modified:
  dhis-2/dhis-api/src/main/java/org/hisp/dhis/schema/PropertyIntrospectorService.java
  dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/filter/DefaultFilterService.java
  dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/filter/DefaultParserService.java
  dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/filter/FilterService.java
  dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/filter/ParserService.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-api/src/main/java/org/hisp/dhis/schema/PropertyIntrospectorService.java'
--- dhis-2/dhis-api/src/main/java/org/hisp/dhis/schema/PropertyIntrospectorService.java	2014-03-26 15:02:47 +0000
+++ dhis-2/dhis-api/src/main/java/org/hisp/dhis/schema/PropertyIntrospectorService.java	2014-04-14 06:43:16 +0000
@@ -36,7 +36,19 @@
  */
 public interface PropertyIntrospectorService
 {
+    /**
+     * Returns all exposed properties on wanted class.
+     *
+     * @param klass Class to get properties for
+     * @return List of properties for Class
+     */
     List<Property> getProperties( Class<?> klass );
 
+    /**
+     * Returns properties as a map property-name => Property class
+     *
+     * @param klass Class to get properties for
+     * @return Map with key property-name and value Property
+     */
     Map<String, Property> getPropertiesMap( Class<?> klass );
 }

=== modified file 'dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/filter/DefaultFilterService.java'
--- dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/filter/DefaultFilterService.java	2014-04-13 03:59:46 +0000
+++ dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/filter/DefaultFilterService.java	2014-04-14 06:43:16 +0000
@@ -60,7 +60,7 @@
             return Lists.newArrayList();
         }
 
-        Filters parsed = parserService.parserObjectFilter( filters );
+        Filters parsed = parserService.parseObjectFilter( filters );
 
         List<T> list = Lists.newArrayList();
 

=== modified file 'dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/filter/DefaultParserService.java'
--- dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/filter/DefaultParserService.java	2014-03-18 08:10:10 +0000
+++ dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/filter/DefaultParserService.java	2014-04-14 06:43:16 +0000
@@ -41,7 +41,7 @@
 public class DefaultParserService implements ParserService
 {
     @Override
-    public Filters parserObjectFilter( List<String> filters )
+    public Filters parseObjectFilter( List<String> filters )
     {
         Filters parsed = new Filters();
 

=== modified file 'dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/filter/FilterService.java'
--- dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/filter/FilterService.java	2014-03-18 08:10:10 +0000
+++ dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/filter/FilterService.java	2014-04-14 06:43:16 +0000
@@ -37,7 +37,22 @@
  */
 public interface FilterService
 {
+    /**
+     * Filter a list of objects based on un-parsed filter string.
+     *
+     * @param objects List to filter
+     * @param filters Filter string
+     * @return Filtered object list
+     */
     <T extends IdentifiableObject> List<T> filterObjects( List<T> objects, List<String> filters );
 
+    /**
+     * Perform inclusion/exclusion on a list of objects.
+     *
+     * @param objects List to filter
+     * @param include Inclusion filter
+     * @param exclude Exclusion filter
+     * @return List of objects with only wanted properties
+     */
     <T extends IdentifiableObject> List<Object> filterProperties( List<T> objects, String include, String exclude );
 }

=== modified file 'dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/filter/ParserService.java'
--- dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/filter/ParserService.java	2014-03-18 08:10:10 +0000
+++ dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/filter/ParserService.java	2014-04-14 06:43:16 +0000
@@ -36,7 +36,19 @@
  */
 public interface ParserService
 {
-    Filters parserObjectFilter( List<String> filters );
+    /**
+     * Parses and generates Ops based on filter string, used for object filtering.
+     *
+     * @param filters One or more filter strings to parse
+     * @return Filters object
+     */
+    Filters parseObjectFilter( List<String> filters );
 
-    Map<String,Map> parsePropertyFilter( String filter );
+    /**
+     * Parses and writes out map with included/excluded properties.
+     *
+     * @param filter String to parse, can be used for both inclusion/exclusion
+     * @return Map with property name as key, and another map as value (recursive)
+     */
+    Map<String, Map> parsePropertyFilter( String filter );
 }