- updating querybuild

- new links to main page
djessup · Jul 8, 2015 · 40740a3 · 40740a3
1 parent caaf68d
commit 40740a3
Show file tree

Hide file tree

Showing 2 changed files with 196 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,7 @@ Adobe Experience Manager Links
 =========
 
 #### Start Here
+* [Adobe Experience Manager Onboarding resources](https://helpx.adobe.com/experience-manager/using/onboardAEM.html)
 * [Experiencing Adobe Experience Manger - Day CQ](http://experience-aem.blogspot.com/2013/08/in-blog-experiencing-adobe-experience.html)
 * [My HUGE list of AEM bookmarks](http://aemtips.blogspot.com/2013/05/my-huge-list-of-aem-bookmarks.html)
 
@@ -112,6 +113,11 @@ This is more of a short cut for people who don't want to navigate through the AE
 * [DAM WebDav](http://localhost:4502/crx/repository/crx.default/content/dam/)
 * [CQ5 AntiSamy configuration XSS](http://localhost:4502/libs/cq/xssprotection/config.xml)
 
+### Servlets (in AEM)
+
+* [Query Builder JSON Servlet](http://localhost:4502/bin/querybuilder.json?path=/content)
+* [Security API](http://localhost:4502/.cqactions.tidy.json?anode=%2Fhome%2Fgroups%2Fsitesmart&path=%2Fhome%2Fgroups&predicate=useradmin&depth=1&authorizableId=admin)
+
 ----------------------------------------
 
 ### Helpful Specific Articles

diff --git a/querybuilder_cheatsheet.md b/querybuilder_cheatsheet.md
@@ -1,6 +1,10 @@
 Query Builder Queries 
 =========
 
+### Query Builder API
+* [5.6.1](https://docs.adobe.com/docs/en/cq/5-6-1/dam/customizing_and_extendingcq5dam/query_builder.html)
+* [6.1](https://docs.adobe.com/docs/en/aem/6-1/develop/search/querybuilder-api.html)
+
 ### References
 * [CQ Queries Demystified](http://itgumby.github.io/blog/2014/10/cq-queries-demystified/)
 * [Tuning your JCR Queries for the AEM & Jackrabbit OAK](http://tech.ethomasjoseph.com/2015/03/tuning-your-jcr-queries-for-aem.html)
@@ -10,11 +14,9 @@ Query Builder Queries
 * [Predicate](http://docs.adobe.com/docs/en/cq/5-6-1/javadoc/com/day/cq/search/Predicate.html)
 * [PredicateEvaluator](http://docs.adobe.com/docs/en/cq/5-6-1/javadoc/com/day/cq/search/eval/PredicateEvaluator.html)
 * [JcrPropertyPredicateEvaluator](http://docs.adobe.com/docs/en/cq/5-6-1/javadoc/com/day/cq/search/eval/JcrPropertyPredicateEvaluator.html)
-
-### Query Builder
-* [5.6.1](https://docs.adobe.com/docs/en/cq/5-6-1/dam/customizing_and_extendingcq5dam/query_builder.html)
-* [6.1](https://docs.adobe.com/docs/en/aem/6-1/develop/search/querybuilder-api.html)
-
+* [Implementing a Custom Predicate Evaluator for the Query Builder](https://docs.adobe.com/docs/en/aem/6-1/develop/search/implementing-custom-predicate-evaluator.html)
+* [Security CQ Actions](https://docs.adobe.com/docs/en/cq/5-6-1/javadoc/index.html?com/day/cq/security/util/CqActions.html)
+* [Creating Adobe CQ OSGi bundles that use the Query Builder API](https://helpx.adobe.com/experience-manager/using/using-query-builder-api.html)
 
 ### Query Builder Samples
 * [Operation Exists](http://localhost:4502/libs/cq/search/content/querydebug.html?_charset_=UTF-8&query=path%3D%2Fcontent%2Fgeometrixx%0D%0Atype%3Dcq%3APage%0D%0Aproperty%3Djcr%3Acontent%2Fcq%3Atoolbars%0D%0Aproperty.operation%3Dexists%0D%0A)
@@ -23,4 +25,186 @@ Query Builder Queries
 * [Operation UnEquals](http://localhost:4502/libs/cq/search/content/querydebug.html?_charset_=UTF-8&query=path%3D%2Fcontent%2Fgeometrixx%0D%0Atype%3Dcq%3APage%0D%0Aproperty%3Djcr%3Acontent%2Fjcr%3Atitle%0D%0Aproperty.operation%3Dunequals%0D%0Aproperty.value%3DContact)
 * [Operation Not Exist](http://localhost:4502/libs/cq/search/content/querydebug.html?_charset_=UTF-8&query=path%3D%2Fcontent%2Fgeometrixx%0D%0Atype%3Dcq%3APage%0D%0Aproperty%3Djcr%3Acontent%2Fcq%3Atoolbars%0D%0Aproperty.operation%3Dnot)
 
-* [Special Character Search](http://localhost:4502/libs/cq/search/content/querydebug.html?_charset_=UTF-8&query=path%3D%2Fcontent%2Fgeometrixx%0D%0Atype%3Dnt%3Aunstructured%0D%0Aproperty%3Dtext%0D%0Aproperty.operation%3Dlike%0D%0Aproperty.value%3D%25%3Cli%3EThe+whole+is+greater+than+the+part.%3C%2Fli%3E%25)
+* [Special Character Search](http://localhost:4502/libs/cq/search/content/querydebug.html?_charset_=UTF-8&query=path%3D%2Fcontent%2Fgeometrixx%0D%0Atype%3Dnt%3Aunstructured%0D%0Aproperty%3Dtext%0D%0Aproperty.operation%3Dlike%0D%0Aproperty.value%3D%25%3Cli%3EThe+whole+is+greater+than+the+part.%3C%2Fli%3E%25)
+
+
+### Samples 
+
+GET USER PATH
+```java
+ curl -s -u admin:admin -X GET "http://localhost:4502/bin/querybuilder.json?path=/home/users&1_property=rep:authorizableId&1_property.value=admin&p.limit=-1" | sed -e 's/^.*"path":"\([^"]*\)".*$/\1/'
+```
+
+
+### Query Builder API Docs
+
+* SOURCE: [Query Builder API](https://docs.adobe.com/docs/en/aem/6-1/develop/search/querybuilder-api.html)
+
+Returning all results
+
+The following query will return ten results (or to be precise a maximum of ten), but inform you of the Number of hits: that are actually available:
+
+http://localhost:4502/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=foundation/components/text&1_property.operation=like&orderby:path
+
+The same query (with the parameter p.limit=-1) will return all results (this might be a high number depending on your instance):
+
+http://localhost:4502/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=foundation/components/text&1_property.operation=like&p.limit=-1&orderby:path
+
+Find jar files and order them, newest first
+
+http://localhost:4502/bin/querybuilder.json?type=nt:file&nodename=*.jar&orderby=@jcr:content/jcr:lastModified&orderby.sort=desc
+
+Find all pages and order them by last modified
+
+http://localhost:4502/bin/querybuilder.json?type=cq:Page&orderby=@jcr:content/cq:lastModified
+
+Find all pages and order them by last modified, but descending
+
+http://localhost:4502/bin/querybuilder.json?type=cq:Page&orderby=@jcr:content/cq:lastModified&orderby.sort=desc
+
+Fulltext search, ordered by score
+
+http://localhost:4502/bin/querybuilder.json?fulltext=Management&orderby=@jcr:score&orderby.sort=desc
+
+Search for pages tagged with a certain tag
+
+http://localhost:4502/bin/querybuilder.json?type=cq:Page&tagid=marketing:interest/product&tagid.property=jcr:content/cq:tags
+
+Search under multiple paths (using groups)
+
+http://localhost:4502/bin/querybuilder.json?fulltext=Management&group.1_path=/content/geometrixx/en/company/management&group.2_path=/content/geometrixx/en/company/bod&group.p.or=true
+
+Search for properties
+
+Here you are searching for all pages of a given template, using the cq:template property:
+
+http://localhost:4502/bin/querybuilder.json?property=cq%3atemplate&property.value=%2fapps%2fgeometrixx%2ftemplates%2fhomepage&type=cq%3aPageContent
+
+This has the drawback that the jcr:content nodes of the pages, not the pages themselves, are returned. To solve this, you can search by relative path:
+
+http://localhost:4502/bin/querybuilder.json?property=jcr%3acontent%2fcq%3atemplate&property.value=%2fapps%2fgeometrixx%2ftemplates%2fhomepage&type=cq%3aPage
+
+Search for multiple properties
+
+When using the property predicate multiple times, you have to add the number prefixes again:
+
+http://localhost:4502/bin/querybuilder.json?1_property=jcr%3acontent%2fcq%3atemplate&1_property.value=%2fapps%2fgeometrixx%2ftemplates%2fhomepage&2_property=jcr%3acontent%2fjcr%3atitle&2_property.value=English&type=cq%3aPage
+
+Search for multiple property values
+
+To avoid big groups when you want to search for multiple values of a property ("A" or "B" or "C"), you can provide multiple values to the property predicate:
+
+http://localhost:4502/bin/querybuilder.json?property=jcr%3atitle&property.1_value=Products&property.2_value=Square&property.3_value=Events
+
+For multi-value properties, you can also require that multiple values match ("A" and "B" and "C"):
+
+http://localhost:4502/bin/querybuilder.json?property=jcr%3atitle&property.and=true&property.1_value=test&property.2_value=foo&property.3_value=bar
+
+
+REFINING WHAT IS RETURNED
+
+By default, the QueryBuilder JSON Servlet will return a default set of properties for each node in the search result (e.g. path, name, title, etc.). In order to gain control over which properties are returned, you can do one of the following:
+
+Specify p.hits=full, in which case all properties will be included for each node:
+http://localhost:4502/bin/querybuilder.json?p.hits=full&property=jcr%3atitle&property.value=Triangle
+
+Use p.hits=selective and specify the properties you want to get in p.properties, separated by a space:
+
+http://localhost:4502/bin/querybuilder.json?p.hits=selective&p.properties=sling%3aresourceType%20jcr%3aprimaryType&property=jcr%3atitle&property.value=Triangle
+
+Another thing you can do is include child nodes in the QueryBuilder response. In order to do this you need to specify p.nodedepth=n, where n is the number of levels you want the query to return. Note that, in order for a child node to be returned, it must be specified by the properties selector (p.hits=full). Example:
+
+http://localhost:4502/bin/querybuilder.json?p.hits=full&p.nodedepth=5&property=jcr%3atitle&property.value=Triangle
+
+MORE PREDICATES
+
+For more predicates, see the [Javadoc for the *PredicateEvaluator classes](https://docs.adobe.com/docs/en/aem/6-1/ref/javadoc/com/day/cq/search/eval/PredicateEvaluator.html). The Javadoc for these classes contains the list of properties that you can use.
+
+The prefix of the class name (for example, "similar" in [SimilarityPredicateEvaluator](https://docs.adobe.com/docs/en/aem/6-1/ref/javadoc/com/day/cq/search/eval/SimilarityPredicateEvaluator.html)) is the principal property of the class. This property is also the name of the predicate to use in the query (in lower case).
+
+For such principal properties, you can shorten the query and use "similar=/content/en" instead of the fully qualified variant "similar.similar=/content/en". The fully qualified form must be used for all non-principal properties of a class.
+
+EXAMPLE QUERY BUILDER API USAGE
+
+```java
+ String fulltextSearchTerm = "Geometrixx";
+
+ // create query description as hash map (simplest way, same as form post)
+ Map<String, String> map = new HashMap<String, String>();
+
+// create query description as hash map (simplest way, same as form post)
+ map.put("path", "/content");
+ map.put("type", "cq:Page");
+ map.put("group.p.or", "true"); // combine this group with OR
+ map.put("group.1_fulltext", fulltextSearchTerm);
+ map.put("group.1_fulltext.relPath", "jcr:content");
+ map.put("group.2_fulltext", fulltextSearchTerm);
+ map.put("group.2_fulltext.relPath", "jcr:content/@cq:tags");
+
+ // can be done in map or with Query methods
+ map.put("p.offset", "0"); // same as query.setStart(0) below
+ map.put("p.limit", "20"); // same as query.setHitsPerPage(20) below
+
+ Query query = builder.createQuery(PredicateGroup.create(map), session);
+ query.setStart(0);
+ query.setHitsPerPage(20);
+
+ SearchResult result = query.getResult();
+
+ // paging metadata
+ int hitsPerPage = result.getHits().size(); // 20 (set above) or lower
+ long totalMatches = result.getTotalMatches();
+ long offset = result.getStartIndex();
+ long numberOfPages = totalMatches / 20;
+
+ //Place the results in XML to return to client
+ DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
+ DocumentBuilder builder = factory.newDocumentBuilder();
+ Document doc = builder.newDocument();
+
+ //Start building the XML to pass back to the AEM client
+ Element root = doc.createElement( "results" );
+ doc.appendChild( root );
+
+ // iterating over the results
+ for (Hit hit : result.getHits()) {
+ String path = hit.getPath();
+
+ //Create a result element
+ Element resultel = doc.createElement( "result" );
+ root.appendChild( resultel );
+
+ Element pathel = doc.createElement( "path" );
+ pathel.appendChild( doc.createTextNode(path ) );
+ resultel.appendChild( pathel );
+ }
+```
+
+The same query executed over HTTP using the Query Builder (JSON) Servlet:
+
+http://localhost:4502/bin/querybuilder.json?path=/content&type=cq:Page&group.p.or=true&group.1_fulltext=Geometrixx&group.1_fulltext.relPath=jcr:content&group.2_fulltext=Geometrixx&group.2_fulltext.relPath=jcr:content/@cq:tags&p.offset=0&p.limit=20
+
+
+STORING AND LOADING QUERIES
+
+Queries can be stored to the repository so that you can use them later. The QueryBuilder provides the storeQuery method with the following signature:
+```java
+ void storeQuery(Query query, String path, boolean createFile, Session session) throws RepositoryException, IOException;
+```
+
+When using the QueryBuilder#storeQuery method, the given Query is stored into the repository as a file or as a property according to the createFile argument value. The following example shows how to save a Query to the path /mypath/getfiles as a file:
+```java
+ builder.storeQuery(query, "/mypath/getfiles", true, session);
+```
+
+Any previously stored queries can be loaded from the repository by using the QueryBuilder#loadQuery method:
+```java
+Query loadQuery(String path, Session session) throws RepositoryException, IOException
+```
+
+For example, a Query stored to the path /mypath/getfiles can be loaded by the following snippet:
+```java
+Query loadedQuery = builder.loadQuery("/mypath/getfiles", session);
+```
+
+