Query Builder-Prädikatsreferenz

Letzte Aktualisierung: 30. April 2024

Gilt für:
Experience Manager 6.5

Themen:

Erstellt für:

Entwickler

VORSICHT

Die Informationen auf dieser Seite erheben keinen Anspruch auf Vollständigkeit.

Umfassende Informationen finden Sie in der Liste unter Verfügbare Eigenschaften in der Debugger-Konsole von Query Builder, zum Beispiel unter:

http://localhost:4502/libs/cq/search/content/querydebug.html

Ein Beispiel finden Sie unter:

http://localhost:4502/system/console/services?filter=%28component.factory%3Dcom.day.cq.search.eval.PredicateEvaluator%2F*%29

Prädikate

boolproperty

Übereinstimmung mit JCR BOOLEAN-Eigenschaften. Akzeptiert nur die Werte „true“ und „false“. Wenn der Wert „false“ ist, besteht eine Übereinstimmung, wenn die Eigenschaft den Wert „false“ hat oder wenn sie überhaupt nicht existiert. Dies kann für die Prüfung auf boolesche Flags nützlich sein, die nur festgelegt werden, wenn sie aktiviert sind.

Der übernommene Parameter „operation“ hat keine Bedeutung.

Unterstützt die Facettenextraktion. Erstellt für jeden Wert (true oder false) einen Bucket, allerdings nur für vorhandene Eigenschaften.

Eigenschaften

boolproperty
Relativer Pfad der Eigenschaft, z. B. myFeatureEnabled oder jcr:content/myFeatureEnabled.
Wert
Wert, auf den die Eigenschaft geprüft werden soll, „true“ oder „false“.

contentfragment

Beschränkt das Ergebnis auf Inhaltsfragmente.

Filtern wird nicht unterstützt.

Facettenextraktion wird nicht unterstützt.

Eigenschaften

contentfragment Kann mit jedem Wert verwendet werden, um auf Inhaltsfragmente zu prüfen.

dateComparison

Vergleicht zwei JCR DATE-Eigenschaften miteinander. Sie können testen, ob sie gleich, ungleich, größer oder größer-oder-gleich sind.

Dies ist ein reines Filterprädikat und kann keine Suchindizes nutzen.

Eigenschaften

property1

Pfad zur Eigenschaft mit dem ersten Datum.
property2

Pfad zur Eigenschaft mit dem zweiten Datum.
operation

„equals“ für genaue Übereinstimmung, „!=“ für unterschiedliche Werte, „greater“, wenn property1 größer ist als property2, „>=“, wenn property1 größer oder gleich property2 ist. Der Standardwert lautet „equals“.

daterange

Dieses Prädikat gleicht JCR-Datumseigenschaften mit einem Datums-/Zeitintervall ab. Hierbei wird das ISO8601-Format für Daten und Uhrzeiten (YYYY-MM-DDTHH:mm:ss.SSSZ) verwendet, wobei auch Teildarstellungen möglich sind, z. B. YYYY-MM-DD. Alternativ kann der Zeitstempel als Anzahl von Millisekunden seit 1970 in der UTC-Zeitzone, dem UNIX®-Zeitformat, angegeben werden.

Sie können nach allen Elementen zwischen zwei Zeitstempeln suchen, nach allem, was neuer oder älter als ein jeweiliges Datum ist, und aus inklusiven oder offenen Intervallen auswählen.

Unterstützt die Facettenextraktion. Stellt die Behälter „heute“, „diese Woche“, „diesen Monat“, „letzte 3 Monate“, „dieses Jahr“, „letztes Jahr“ und „vor dem letzten Jahr“ bereit.

Filtern wird nicht unterstützt.

Eigenschaften

property

Relativer Pfad zu einer DATE-Eigenschaft, z. B. jcr:lastModified.
lowerBound

Untere Datumsgrenze, auf welche die Eigenschaft überprüft werden soll, z. B. 2014-10-01
lowerOperation

„>“ (neuer) oder „>=“ (gleich alt oder neuer), gilt für lowerBound. Der Standardwert lautet „>“.
upperBound

Obere Datumsgrenze, auf welche die Eigenschaft überprüft werden soll, z. B. 2014-10-01T12:15:00.
upperOperation

„<“ (älter) oder „<=“ (gleich alt oder älter), gilt für upperBound. Der Standardwert lautet „<“.
timeZone

Kennung der Zeitzone, die verwendet werden soll, wenn keine ISO-8601-Datumszeichenfolge angegeben wird. Der Standardwert ist die standardmäßige Zeitzone des Systems.

excludepaths

Schließt Knoten aus dem Ergebnis aus, wenn ihr Pfad mit einem regulären Ausdruck übereinstimmt.

Dies ist ein reines Filterprädikat und kann keine Suchindizes nutzen.

Facettenextraktion wird nicht unterstützt.

Eigenschaften

excludepaths

Regulärer Ausdruck, der anhand von Ergebnispfaden ausgewertet wird, wobei übereinstimmende Vorkommen aus dem Ergebnis ausgeschlossen werden.

fulltext

Sucht nach Ausdrücken im Volltextindex.

Filtern wird nicht unterstützt.

Facettenextraktion wird nicht unterstützt.

Eigenschaften

fulltext

Die Volltext-Suchbegriffe.
relPath

Der relative Pfad, der in der Eigenschaft oder dem Unterknoten durchsucht werden soll. Diese Eigenschaft ist optional.

group

Ermöglicht die Erstellung verschachtelter Bedingungen. Gruppen können verschachtelte Gruppen enthalten. Alles in einer Query Builder-Abfrage gehört implizit zu einer Stammgruppe, die auch die Parameter p.or und p.not aufweisen kann.

Beispiel für die Zuordnung einer von zwei Eigenschaften anhand eines Werts:

group.p.or=true
group.1_property=jcr:title
group.1_property.value=My Page
group.2_property=navTitle
group.2_property.value=My Page

Dies ist konzeptionell (1_property ODER 2_property).

Beispiel für verschachtelte Gruppen:

fulltext=Management
group.p.or=true
group.1_group.path=/content/geometrixx/en
group.1_group.type=cq:Page
group.2_group.path=/content/dam/geometrixx
group.2_group.type=dam:Asset

Hierbei wird nach dem Begriff „Management“ innerhalb von Seiten in /content/geometrixx/en oder in Assets in /content/dam/geometrixx gesucht.

Dies ist konzeptionell fulltext AND ( (path AND type) OR (path AND type) ). Solche ODER-Verknüpfungen sind aus Leistungsgründen auf gute Indizes angewiesen.

Eigenschaften

p.or

Ist hierfür „true“ festgelegt, muss nur ein Prädikat in der Gruppe übereinstimmen. Standardmäßig ist „false“ festgelegt, was bedeutet, dass alle übereinstimmen müssen.
p.not

Ist hierfür „true“ festgelegt, wird die Gruppe nicht beachtet (standardmäßig „false“).
<predicate>

Fügt verschachtelte Prädikate hinzu.
N_<predicate>

Fügt mehrere verschachtelte Prädikate gleichzeitig hinzu, z. B. 1_property, 2_property, ....

hasPermission

Beschränkt das Ergebnis auf Elemente, bei denen die aktuelle Sitzung die angegebenen JCR-Privilegien aufweist.

Dies ist ein reines Filterprädikat und kann keine Suchindizes nutzen. Facettenextraktion wird nicht unterstützt.

Eigenschaften

hasPermission

Kommagetrennte JCR-Berechtigungen, die die aktuelle Benutzersitzung für den jeweiligen Knoten ALLE aufweisen muss. Zum Beispiel, jcr:write, jcr:modifyAccessControl.

language

Findet CQ-Seiten in einer bestimmten Sprache. Hierbei wird sowohl die Spracheigenschaft der Seite als auch der Seitenpfad betrachtet, der häufig die Sprache oder das Gebietsschema in einer Site-Struktur der obersten Ebene enthält.

Dies ist ein reines Filterprädikat und kann keine Suchindizes nutzen.

Unterstützt die Facettenextraktion. Stellt Buckets für jeden eindeutigen Sprach-Code zur Verfügung.

Eigenschaften

language

ISO-Sprach-Code, z. B. „de“

mainasset

Prüft, ob ein Knoten ein DAM-Haupt-Asset und kein Unter-Asset ist. Dies ist im Allgemeinen jeder Knoten, der sich nicht in einem „Unter-Asset“-Knoten befindet. Hierbei wird nicht auf den Knotentyp dam:Asset geprüft. Legen Sie einfach „mainasset=true“ oder „mainasset=false“ fest, um dieses Prädikat zu verwenden. Es gibt keine weiteren Eigenschaften.

Dies ist ein reines Filterprädikat und kann keine Suchindizes nutzen.

Es unterstützt die Facettenextraktion und bietet zwei Buckets für Haupt- und Unter-Assets.

Eigenschaften

mainasset

Boolean, „true“ für Haupt-Assets, „false“ für Unter-Assets.

memberOf

Sucht Objekte, die Mitglieder einer bestimmten Sling-Ressourcensammlung sind.

Dies ist ein reines Filterprädikat und kann keine Suchindizes nutzen. Facettenextraktion wird nicht unterstützt.

Eigenschaften

memberOf

Pfad der Sling-Ressourcensammlung.

nodename

Sucht nach Namen von JCR-Knoten.

Unterstützt die Facettenextraktion. Stellt Buckets für alle eindeutigen Knotennamen (Dateinamen) zur Verfügung.

Eigenschaften

nodename

Knotennamenmuster, das Platzhalter ermöglicht: * = beliebiges oder kein Zeichen, ? = beliebiges Zeichen, [abc] = nur Zeichen in eckigen Klammern.

notexpired

Wertet Elemente aus, indem überprüft wird, ob eine JCR DATE-Eigenschaft größer oder gleich der aktuellen Server-Zeit ist. Dies kann verwendet werden, um eine Datumseigenschaft wie „expiresAt“ zu überprüfen und das Ergebnis auf diejenigen zu beschränken, die noch nicht abgelaufen sind (notexpired=true) bzw. bereits abgelaufen sind ( notexpired=false).

Filtern wird nicht unterstützt.

Unterstützt die Facettenextraktion auf die gleiche Weise wie das Prädikat „daterange“.

Eigenschaften

notexpired

Boolescher Wert, „true“ für noch nicht abgelaufen (Datum in der Zukunft oder gleich), „false“ für abgelaufen (Datum in der Vergangenheit) (erforderlich).
property

Relativer Pfad zur zu überprüfenden DATE-Eigenschaft (erforderlich).

orderby

Ermöglicht die Sortierung der Ergebnisse. Wenn nach mehreren Eigenschaften sortiert werden muss, muss dieses Prädikat unter Verwendung des numerischen Präfixes mehrfach hinzugefügt werden, z. B. 1_orderby=first, 2_oderby=second.

Eigenschaften

orderby

Entweder der JCR-Eigenschaftsname, angezeigt durch ein vorangestelltes „@“, z. B. @jcr:lastModified bzw. @jcr:content/jcr:title, oder ein anderes Prädikat in der Abfrage, z. B. 2_property, nach dem sortiert werden soll.
sort

Sortierrichtung, entweder „desc“ für absteigend oder „asc“ für aufsteigend (Standard).
case

Wird hierfür ignore festgelegt, wird die Groß-/Kleinschreibung nicht beachtet, „a“ kommt also vor „B“. Wird dies leer- oder ausgelassen, wird bei der Sortierung die Groß-/Kleinschreibung beachtet, „B“ kommt also vor „a“

path

Sucht innerhalb eines angegebenen Pfads.

Facettenextraktion wird nicht unterstützt.

Eigenschaften

path

Pfadmuster. Dies hängt von „exact“ ab, entweder stimmt eine gesamte Teilbaumstruktur überein (wie wenn in xpath //* angehängt wird, wobei der Basispfad nicht mit eingeschlossen wird) (exact=false, Standardwert) oder nur ein exakter Pfad stimmt überein, der Platzhalter (*) enthalten kann. Ist „self“ festgelegt, wird die gesamte Teilbaumstruktur einschließlich des Basisknotens durchsucht.
exact

Wenn für exact „true/on“ aktiviert ist, muss der exakte Pfad übereinstimmen; er darf bestimmte einfache Platzhalter (*) enthalten, die Namen entsprechen, aber nicht /. Wenn die Option „false“ ist (Standard), werden alle untergeordneten Elemente berücksichtigt (optional).
flat

Durchsucht nur die direkt untergeordneten Elemente (wie wenn in xpath „/*“ angehängt wird). Wird nur verwendet, wenn „exact“ nicht „true“ ist (optional).
self

Durchsucht die Unterstruktur, aber bezieht den als Pfad angegebenen Basisknoten mit ein (keine Platzhalter).

property

Führt einen Abgleich von JCR-Eigenschaften und ihren Werten durch.

Unterstützt die Facettenextraktion. Stellt für jeden eindeutigen Eigenschaftswert in den Ergebnissen Buckets zur Verfügung.

Eigenschaften

property

Relativer Pfad zur Eigenschaft, z. B. jcr:title.
value

Wert, auf den die Eigenschaft geprüft werden soll. Folgt dem JCR-Eigenschaftstyp bei der Konvertierung von Zeichenfolgen.
N_value

Verwenden Sie 1_value, 2_value, …, um auf mehrere Werte zu prüfen (standardmäßig kombiniert mit OR, mit AND, wenn „and=true“) (seit 5.3).
and

Legen Sie hierfür „true“ fest, um mehrere Werte (N_value) mit AND zu kombinieren (seit 5.3).
operation

equals für eine exakte Übereinstimmung (Standard), unequals für unterschiedliche Werte, like zur Verwendung der xpath-Funktion jcr:like (optional), not, wenn keine Übereinstimmung vorliegt (z. B. not(@prop) in xpath, Wertparameter wird ignoriert), oder exists zur Überprüfung auf Vorhandensein (Wert kann „true“ sein – Eigenschaft muss vorhanden sein, Standard – oder „false“ – genau wie not).
depth

Anzahl der Platzhalterebenen, unter denen die Eigenschaft/der relative Pfad vorhanden sein kann (z. B. wird mit property=size depth=2 Knoten/Größe, Knoten//Größe und Knoten//*/Größe überprüft).

rangeproperty

Ordnet eine JCR-Eigenschaft einem Intervall zu. Dies gilt für Eigenschaften mit linearen Typen wie LONG, DOUBLE und DECIMAL. Details zu DATE finden Sie im Abschnitt zum Prädikat „daterange“, das für Eingaben im Datumsformat optimiert wurde.

Sie können eine untere Grenze und eine obere Grenze oder nur eine von beiden definieren. Die Operation (z. B. „lesser than“ oder „lesser or equals“) kann auch einzeln für die untere und obere Grenze festgelegt werden.

Facettenextraktion wird nicht unterstützt.

Eigenschaften

property

Relativer Pfad zur Eigenschaft.
lowerBound

Untere Grenze, auf die „property“ geprüft werden soll.
lowerOperation

„>“ (Standard) oder „>=“, gilt für den lowerValue
upperBound

Obere Grenze, auf die „property“ geprüft werden soll.
upperOperation

„<“ (Standard) oder „<=“, gilt für den lowerValue
decimal

„true“, wenn die aktivierte Eigenschaft vom Typ „Decimal“ ist.

relativedaterange

Gleicht JCR DATE-Eigenschaften anhand von Zeit-Offsets, die relativ zur aktuellen Serverzeit sind, mit einem Datums-/Zeitintervall ab. Sie können lowerBound und upperBound entweder anhand eines Millisekundenwerts oder der bugzilla-Syntax 1s 2m 3h 4d 5w 6M 7y (eine Sekunde, zwei Minuten, drei Stunden, vier Tage, fünf Wochen, sechs Monate, sieben Jahre) angeben. Mit dem Präfix „-“ geben Sie einen negativen Offset vor der aktuellen Zeit an. Wenn Sie nur lowerBound oder upperBound angeben, wird für die jeweils andere Grenze standardmäßig „0“ festgelegt (bedeutet die aktuelle Zeit).

Beispiel:

upperBound=1h (und keine lowerBound) wählt alles in der folgenden Stunde aus.
lowerBound=-1d (und keine upperBound) wählt alles in den vergangenen 24 Stunden aus.
lowerBound=-6M und upperBound=-3M wählt alles aus, was zwischen sechs und drei Monaten alt ist.
lowerBound=-1500 und upperBound=5500 wählt alles aus, was im Zeitraum zwischen einschließlich 1500 Millisekunden in der Vergangenheit und einschließlich 5500 Millisekunden in der Zukunft liegt.
lowerBound=1d und upperBound=2d wählt alles am übernächsten Tag aus.

Schaltjahre werden nicht berücksichtigt, und alle Monate haben 30 Tage.

Filtern wird nicht unterstützt.

Unterstützt die Facettenextraktion auf die gleiche Weise wie das Prädikat „daterange“.

Eigenschaften

upperBound

Obere Datumsgrenze in Millisekunden oder 1s 2m 3h 4d 5w 6M 7y (eine Sekunde, zwei Minuten, drei Stunden, vier Tage, fünf Wochen, sechs Monate, sieben Jahre) relativ zur aktuellen Server-Zeit. Verwenden Sie „-“ für einen negativen Offset.
lowerBound

Untere Datumsgrenze in Millisekunden oder 1s 2m 3h 4d 5w 6M 7y (eine Sekunde, zwei Minuten, drei Stunden, vier Tage, fünf Wochen, sechs Monate, sieben Jahre) relativ zur aktuellen Server-Zeit. Verwenden Sie „-“ für einen negativen Offset.

root

Stammprädikatgruppe. Unterstützt alle Eigenschaften einer Gruppe und ermöglicht das Festlegen globaler Abfrageparameter.

Der Name „root“ wird in Abfragen nie verwendet, er ist implizit.

Eigenschaften

p.offset

Zahl, die den Anfang der Ergebnisseite anzeigt, d. h., wie viele Elemente übersprungen werden sollen.
p.limit

Zahl, die die Seitengröße angibt.
p.guessTotal

Empfohlen: Vermeiden Sie die Berechnung des vollständigen Ergebnisses, da dies aufwendig sein kann. Besser entweder ein Maximalwert, bis zu dem gezählt werden soll (z. B. 1000, eine Zahl, die Benutzenden ausreichendes Feedback zur groben Größe und exakte Zahlen bei kleineren Ergebnissen liefert), oder „true“, um nur bis zum kleinsten notwendigen p.offset + p.limit zu zählen.
p.excerpt

Ist hierfür true festgelegt, wird im Ergebnis ein Volltextauszug eingeschlossen.
p.hits

(nur für das JSON-Servlet) Legt fest, wie Treffer als JSON geschrieben werden. Folgende Standardmethoden stehen zur Auswahl (erweiterbar über den Dienst „ResultHitWriter“):
- einfach:
  
  Minimale Elemente wie path, title, lastmodified, excerpt (falls festgelegt).
- vollständig:
  
  Sling-JSON-Rendern des Knotens, wobei jcr:path den Pfad des Treffers anzeigt: Standardmäßig werden nur die direkten Eigenschaften des Knotens aufgeführt, weiter unten befindliche Unterstrukturen werden mit p.nodedepth=N eingeschlossen, wobei 0 die vollständige Unterstruktur bedeutet. Fügen Sie p.acls=true hinzu, um die JCR-Berechtigungen der aktuellen Sitzung für das jeweilige Ergebniselement einzuschließen (Zuordnungen: create = add_node, modify = set_property, delete = remove).
- selective:
  
  Nur in p.properties angegebene Eigenschaften. Dies ist eine mit Leerzeichen getrennte (verwenden Sie „+“ in URLs) Liste relativer Pfade. Wenn der relative Pfad eine Tiefe > 1 aufweist, werden sie als untergeordnete Objekte angezeigt. Die spezielle Eigenschaft „jcr:path“ umfasst den Pfad des Treffers.

savedquery

Schließt alle Prädikate einer persistenten Query Builder-Abfrage in der aktuellen Abfrage als Untergruppenprädikat ein.

Dadurch wird keine zusätzliche Abfrage ausgeführt, sondern die aktuelle Abfrage erweitert.

Abfragen können programmgesteuert anhand von QueryBuilder#storeQuery() persistiert werden. Das Format kann entweder eine String-Eigenschaft mit mehreren Zeilen oder ein nt:file-Knoten sein, der die Abfrage als Textdatei im Java™-Eigenschaftsformat enthält.

Die Facettenextraktion wird für die Prädikate der gespeicherten Abfrage nicht unterstützt

Eigenschaften

savedquery

Pfad zur gespeicherten Abfrage (String-Eigenschaft oder nt:file-Knoten).

similar

Ähnlichkeitssuche mithilfe der rep:similar() () von JCR XPath.

Filtern wird nicht unterstützt. Facettenextraktion wird nicht unterstützt.

Eigenschaften

similar
Absoluter Pfad zum Knoten, für den ähnliche Knoten gefunden werden sollen.
local
Ein relativer Pfad zu einem untergeordneten Knoten oder . für den aktuellen Knoten (optional; der Standard lautet .).

tag

Sucht nach Inhalten mit Tags, indem Tag-Titelpfade angegeben werden.

Unterstützt die Facettenextraktion. Stellt Buckets für jedes einzigartige Tag bereit. Dazu wird jeweils der aktuelle Tag-Titelpfad verwendet.

Eigenschaften

tag

Tag-Titelpfad, nach dem gesucht werden soll, z. B. „Asset-Eigenschaften: Ausrichtung/Querformat“.
N_value

Verwenden Sie 1_value, 2_value …, um auf mehrere Tags zu prüfen (standardmäßig kombiniert mit OR; wenn and=true, dann mit AND) (seit 5.6).
property

Eigenschaft (bzw. relativer Pfad zur Eigenschaft), die betrachtet werden soll (Standard: cq:tags)

tagid

Dieses Prädikat sucht nach Inhalten mit Tags, indem Tag-IDs angegeben werden.

Unterstützt die Facettenextraktion. Stellt Buckets für jedes einzigartige Tag bereit. Dazu wird jeweils die aktuelle Tag-ID verwendet.

Eigenschaften

tagid

Tag-ID, damit Sie z. B. nach „properties:orientation/landscape“ suchen können.
N_value

Verwenden Sie 1_value, 2_value …, um auf mehrere tagids zu prüfen (standardmäßig kombiniert mit OR; wenn and=true, dann mit AND) (seit 5.6).
property

Eigenschaft (bzw. relativer Pfad zur Eigenschaft), die betrachtet werden soll (Standard: cq:tags).

tagsearch

Dieses Prädikat sucht nach Inhalten mit Tags, indem Keywords angegeben werden. Hierbei wird zunächst nach Tags gesucht, die diese Keywords im Titel enthalten, woraufhin das Ergebnis auf Elemente mit diesen Tags eingeschränkt wird.

Facettenextraktion wird nicht unterstützt.

Eigenschaften

tagsearch

Suchbegriff, nach dem in Tag-Titeln gesucht werden soll.
property

Eigenschaft (bzw. relativer Pfad zur Eigenschaft), die betrachtet werden soll (Standard: cq:tags).
lang

Zum Suchen nur in einem bestimmten lokalisierten Tag-Titel (z. B. de).
all

(bool) Suchen im gesamten Tag-Volltext, d. h. alle Titel, Beschreibungen usw. Hat Vorrang vor „l ang“.

Typ

Dieses Prädikat schränkt Ergebnisse auf einen bestimmten JCR-Knotentyp ein, sowohl auf primäre Knotentypen als auch auf Mixin-Typen. Dadurch werden auch Untertypen dieses Knotentyps gefunden. Die Indizes der Repository-Suche müssen die Knotentypen abdecken, damit eine effiziente Ausführung gewährleistet ist.

Unterstützt die Facettenextraktion. Stellt Buckets für jeden eindeutigen Typ in den Ergebnissen bereit.

Eigenschaften

Typ

Knotentyp bzw. Mixin-Name, nach dem gesucht werden soll, z. B. cq:Page.

recommendation-more-help