Query Builder API

すべての結果を返す

以下のクエリは 10 件の結果を返します（正確には最大 10 件）が、通知されるのは表示可能な​ ヒット数 ​です。

http://localhost:4502/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=foundation/components/text&1_property.operation=like&orderby=path

同じクエリで、パラメーター p.limit=-1 を使用すると、すべての結果が返されます（インスタンスによっては返される結果の数が非常に多くなることがあります）。

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

p.guessTotal を使用して結果を返す

p.guessTotal パラメーターの目的は、実用最小限の p.offset 値と p.limit 値を組み合わせることによって、表示できる適切な結果数を返すことです。このパラメーターを使用するメリットは、結果セットが大きい場合にパフォーマンスが向上することです。これにより、総合計の計算（例：result.getSize() の呼び出し）と結果セット全体の読み込みが回避され、OAK エンジンおよびインデックスに至るまですべてが最適化されます。結果が 10 万件ある場合、実行時間とメモリ使用量の両方で大きな変化が見られる可能性があります。

このパラメーターのデメリットは、ユーザーには正確な合計が表示されないことです。ただし、p.guessTotal=1000 のように最小値を設定し、1000 件までは必ず読み込まれるようにすることができます。その結果、1000 件より小さな結果セットについては正確な合計を取得できますが、1000 件を超えた場合は「それ以上」ということしかわかりません。

以下のクエリに p.guessTotal=true を追加して、どのように機能するかを見てみましょう。

http://localhost:4502/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=foundation/components/text&1_property.operation=like&p.guessTotal=true&orderby=path

このクエリは、p.limit のデフォルトである 10 件の結果をオフセット 0 で返します。

AEM 6.0 SP2 の時点では、数値を使用してカスタムの最大結果数までカウントアップすることもできます。上述と同じクエリを使用して、p.guessTotal の値を 50 に変更してみます。

http://localhost:4502/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=foundation/components/text&1_property.operation=like&p.guessTotal=50&orderby=path

このクエリは、同じデフォルトの制限である 10 件の結果をオフセット 0 で返しますが、表示されるのは最大 50 件までです。

プロパティの検索

cq:template プロパティを使用して、特定のテンプレートのすべてのページを検索できます。

http://localhost:4502/bin/querybuilder.json?property=cq%3atemplate&property.value=%2fapps%2fgeometrixx%2ftemplates%2fhomepage&type=cq%3aPageContent

これには、ページ自身ではなく、ページの jcr:content ノードが返されるという欠点があります。この問題を解決するには、相対パスで検索します。

http://localhost:4502/bin/querybuilder.json?property=jcr%3acontent%2fcq%3atemplate&property.value=%2fapps%2fgeometrixx%2ftemplates%2fhomepage&type=cq%3aPage

複数のプロパティの検索

property 述語を複数回使用する場合、ここでも、数字のプレフィックスを付加する必要があります。

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

プロパティの複数の値の検索

1 つのプロパティに対して複数の値を検索する場合（"A" or "B" or "C"）に、グループが大きくならないようにするには、property 述語に複数の値を指定します。

http://localhost:4502/bin/querybuilder.json?property=jcr%3atitle&property.1_value=Products&property.2_value=Square&property.3_value=Events

複数値を持つプロパティの場合、複数の値が一致することを必須にできます（"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

返されるプロパティの絞り込み

デフォルトでは、QueryBuilder JSON サーブレットは検索結果内の各ノードに関するデフォルトのプロパティのセット（path、name、title など）を返します。返されるプロパティを制御するために、次のいずれかの操作を実行できます。

以下のように指定します

すると、各ノードのすべてのプロパティが含まれるようになります。

http://localhost:4502/bin/querybuilder.json?p.hits=full&property=jcr%3atitle&property.value=Triangle

以下を使用し、

取得するプロパティを次のように指定して

スペースで区切ります。

http://localhost:4502/bin/querybuilder.json?p.hits=selective&property=jcr%3atitle&property.value=Triangle

http://localhost:4502/bin/querybuilder.json? p.hits=selective&p.properties=sling%3aresourceType%20jcr%3aprimaryType&property=jcr%3atitle&property.value=Triangle

他に実行可能な方法として、QueryBuilder 応答に子ノードを含めることができます。これを行うには、次を指定する必要があります。

ここで、n は、クエリが返すレベルの数です。子ノードが返されるようにするには、プロパティセレクターでそのように指定する必要があります。

例：

http://localhost:4502/bin/querybuilder.json?p.hits=full&p.nodedepth=5&property=jcr%3atitle&property.value=Triangle

述語の詳細

述語の詳細については、Query Builder の述語リファレンスのページを参照してください。

PredicateEvaluator クラスの Javadoc も参照してください。これらのクラスの Javadoc ドキュメントには、使用できるプロパティのリストが含まれています。

クラス名のプレフィックス（例えば SimilarityPredicateEvaluator の "similar" など）は、クラスの​ プリンシパルプロパティ ​です。このプロパティは、クエリ内で使用する述語の名前（小文字で使用）でもあります。

このようなプリンシパルプロパティの場合は、クエリを短縮して、完全修飾したバリアント similar.similar=/content/en の代わりに similar=/content/en を使用できます。完全修飾形式は、クラスのプリンシパルプロパティではないすべてのプロパティに対して使用する必要があります。