Improve ACR search and edition

[lgpl/argeo-commons.git] / org.argeo.api.acr / src / org / argeo / api / acr / search / BasicSearch.java

diff --git a/org.argeo.api.acr/src/org/argeo/api/acr/search/BasicSearch.java b/org.argeo.api.acr/src/org/argeo/api/acr/search/BasicSearch.java
index 8028f5d2033e8d5138bf23aaca90a029b2e2f4ce..8cbdebf7e5d5c8e6614dea460a739e59328158d1 100644 (file)
--- a/org.argeo.api.acr/src/org/argeo/api/acr/search/BasicSearch.java
+++ b/org.argeo.api.acr/src/org/argeo/api/acr/search/BasicSearch.java
@@ -9,9 +9,13 @@ import java.util.function.Consumer;
 
 import javax.xml.namespace.QName;
 
-import org.argeo.api.acr.DName;
 import org.argeo.api.acr.QNamed;
 
+/**
+ * A basic search mechanism modelled on WebDav basicsearch.
+ * 
+ * @see http://www.webdav.org/specs/rfc5323.html
+ */
 public class BasicSearch {
 
        private List<QName> select = new ArrayList<>();
@@ -30,10 +34,20 @@ public class BasicSearch {
                return this;
        }
 
+       /**
+        * Convenience method, to search below this absolute path, with depth
+        * {@link Depth#INFINITTY}.
+        */
+       public BasicSearch from(String path) {
+               return from(URI.create(path), Depth.INFINITTY);
+       }
+
+       /** Search below this URI, with depth {@link Depth#INFINITTY}. */
        public BasicSearch from(URI uri) {
                return from(uri, Depth.INFINITTY);
        }
 
+       /** Search below this URI, with this {@link Depth}. */
        public BasicSearch from(URI uri, Depth depth) {
                Objects.requireNonNull(uri);
                Objects.requireNonNull(depth);
@@ -87,10 +101,10 @@ public class BasicSearch {
 
        }
 
-       static void main(String[] args) {
-               BasicSearch search = new BasicSearch();
-               search.select(DName.creationdate.qName()) //
-                               .from(URI.create("/test")) //
-                               .where((f) -> f.eq(DName.creationdate.qName(), ""));
-       }
+//     static void main(String[] args) {
+//             BasicSearch search = new BasicSearch();
+//             search.select(DName.creationdate.qName()) //
+//                             .from(URI.create("/test")) //
+//                             .where((f) -> f.eq(DName.creationdate.qName(), ""));
+//     }
 }