DokumentationAEM 6.4Användarhandbok om utveckling

Predikatreferens för Query Builder query-builder-predicate-reference

Last update: Thu May 04 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Skapat för:

  • Developer
CAUTION
AEM 6.4 har nått slutet på den utökade supporten och denna dokumentation är inte längre uppdaterad. Mer information finns i teknisk supportperiod. Hitta de versioner som stöds här.

Allmänt general

Predikat predicates

boolproperty boolproperty

Matchar JCR BOOLEAN-egenskaper. Accepterar endast värdena " true" och " false". Vid " false", matchar det om egenskapen har värdet " false" eller om den inte finns alls. Detta kan vara användbart för att kontrollera om det finns booleska flaggor som bara är inställda när de är aktiverade.

Ärvda " operationparametern har ingen betydelse.

Stöder facetextrahering. Tillhandahåller bucklar för varje true eller false värde, men bara för befintliga egenskaper.

Egenskaper properties

  • boolproperty
    relativ sökväg till egenskap, till exempel
    myFeatureEnabled eller jcr:content/myFeatureEnabled

  • value
    värde att kontrollera egenskap för, "
    true" eller " false"

innehållfragment contentfragment

Begränsar resultatet till innehållsfragment.

Filtrering stöds inte.

Stöder inte facetextrahering.

Egenskaper properties-1

  • innehållfragment
    Den kan användas med vilket värde som helst för att kontrollera om det finns innehållsfragment.

dateComparison datecomparison

Jämför två JCR DATE-egenskaper med varandra. Kan testa om de är lika, olika, större än eller större än eller lika med.

Detta är ett predikat som bara kan filtreras och kan inte utnyttja ett sökindex.

Egenskaper properties-2

  • property1

    path to first date property

  • property2

    path to second date, egenskap

  • operation

    " =" för exakt matchning, " !=" för jämförelse av skillnader, " >" for property1 större än property2, " >=" för property1 större än eller lika med property2. Standardvärdet är " =".

daterange daterange

Matchar JCR DATE-egenskaper mot ett datum/tidsintervall. Detta använder ISO8601
format för datum och tid ( YYYY-MM-DDTHH:mm:ss.SSSZ) och tillåter även partiella representationer, som YYYY-MM-DD. Alternativt kan tidsstämpeln anges i antal millisekunder sedan 1970 i UTC-tidszonen, det unika tidsformatet.

Du kan söka efter vad som helst mellan två tidsstämplar, vad som helst nyare eller äldre än ett visst datum, och du kan även välja mellan inkluderande och öppna intervall.

Stöder facetextrahering. Kommer att tillhandahålla fickor "idag", "den här veckan", "den här månaden", "de senaste tre månaderna", "det här året", "det senaste året" och "tidigare än det senaste året".

Filtrering stöds inte.

Egenskaper properties-3

  • property

    relativ sökväg till en DATE egenskap, till exempel jcr:lastModified

  • lowerBound

    nedre gräns för att kontrollera egenskap för, till exempel 2014-10-01

  • lowerOperation

    " >" (nyare) eller " >=" (på eller nyare), gäller för lowerBound. Standardvärdet är " >".

  • upperBound

    övre gräns för att kontrollera egenskap för, till exempel 2014-10-01T12:15:00

  • upperOperation

    " <" (äldre) eller " <=" (vid eller äldre), gäller för upperBound. Standardvärdet är " <".

  • timeZone

    ID för den tidszon som ska användas när den inte anges som en ISO-8601-datumsträng. Standardvärdet är systemets standardtidszon.

exkluderingsdjup excludepaths

Utesluter noder från resultatet där deras sökväg matchar ett reguljärt uttryck.

Detta är ett predikat som bara kan filtreras och kan inte utnyttja ett sökindex.

Stöder inte facetextrahering.

Egenskaper properties-4

  • exkluderingsdjup

    reguljära uttryck som matchas mot resultatsökvägar, utan matchande sökvägar från resultatet.

fulltext fulltext

Söker efter termer i fulltextindexet.

Filtrering stöds inte.

Stöder inte facetextrahering.

Egenskaper properties-5

  • fulltext

    fulltextsöktermer

  • relPath

    den relativa sökvägen som ska sökas i egenskapen eller undernoden. Den här egenskapen är valfri.

grupp group

Tillåter att kapslade villkor skapas. Grupper kan innehålla kapslade grupper. Allt i en fråga finns implicit i en rotgrupp som kan ha p.or och p.not parametrar också.

Exempel på matchning av en av två egenskaper mot ett värde:

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

Detta är begreppsmässigt (1_property ELLER 2_property).

Exempel för kapslade grupper:

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

Detta söker efter termen "Förvaltning" på sidor i /content/geometrixx/en eller i tillgångar i /content/dam/geometrixx.

Detta är begreppsmässigt fulltext AND ( (path AND type) OR (path AND type) ). Observera att sådana OR-kopplingar behöver bra index för att fungera.

Egenskaper properties-6

  • p.or

    om inställt på " true", måste bara ett predikat i gruppen matcha. Standardvärdet är " false", vilket betyder att alla måste matcha

  • p.not

    om inställt på " true", negeras gruppen (standardvärdet är " false")

  • <predicate>

    lägger till kapslade predikat

  • N_<predicate>

    lägger till flera kapslade predikat samtidigt, som 1_property, 2_property, ...

hasPermission haspermission

Begränsar resultatet till objekt där den aktuella sessionen har den angivna JCR-behörigheter.

Detta är ett predikat som bara kan filtreras och kan inte utnyttja ett sökindex. Det stöder inte facetextrahering.

Egenskaper properties-7

  • hasPermission

    kommaavgränsade JCR-behörigheter som den aktuella användarsessionen måste ha för noden i fråga. till exempel jcr:write, jcr:modifyAccessControl

språk language

Söker efter CQ-sidor på ett visst språk. Det här tittar både på sidspråksegenskapen och sidsökvägen, som ofta innehåller språket eller språket i en webbplatsstruktur på den översta nivån.

Detta är ett predikat som bara kan filtreras och kan inte utnyttja ett sökindex.

Stöder facetextrahering. Ger buketter för varje unik språkkod.

Egenskaper properties-8

  • språk

    ISO-språkkod, till exempel " de"

huvudtillgång mainasset

Kontrollerar om en nod är en DAM-huvudresurs och inte en underresurs. Detta är i stort sett alla noder som inte finns i en delresursnod. Observera att detta inte kontrollerar dam:Asset nodtyp. Ange bara " mainasset=true" eller " mainasset=false", det finns inga fler egenskaper.

Detta är ett predikat som bara kan filtreras och kan inte utnyttja ett sökindex.

Stöder facetextrahering. Tillhandahåller 2 bucket för huvud- och deltillgångar.

Egenskaper properties-9

  • huvudtillgång

    boolesk, " true" for main assets, " false" för undertillgångar

medlemOf memberof

Söker efter objekt som tillhör en viss resursinsamling för sling.

Detta är ett predikat som bara kan filtreras och kan inte utnyttja ett sökindex. Stöder inte facetextrahering.

Egenskaper properties-10

  • medlemOf

    sökväg till Sling-resurssamling

nodename nodename

Matchar JCR-nodnamn.

Stöder facetextrahering. Tillhandahåller bucket för varje unikt nodnamn (filnamn).

Egenskaper properties-11

  • nodename

    nodnamnsmönster som tillåter jokertecken: * = ett eller inga tecken, ? = any char, [abc] = endast tecken inom hakparentes

inte utgånget notexpired

Matchar objekt genom att kontrollera om en JCR DATE-egenskap är större eller lika med den aktuella servertiden. Detta kan användas för att kontrollera en expiresAt" som date-egenskap och begränsa till endast de som ännu inte har gått ut ( notexpired=true) eller som redan har gått ut ( notexpired=false).

Filtrering stöds inte.

Stöder facet-extrahering på samma sätt som daterange-predikatet.

Egenskaper properties-12

  • inte utgånget

    boolesk, " true" för ännu inte förfallit (datum i framtiden eller lika med), " false" för utgången (tidigare datum) (obligatoriskt)

  • property

    relativ sökväg till DATE egenskap som ska kontrolleras (obligatoriskt)

orderby orderby

Sortera resultatet. Om det krävs en ordning med flera egenskaper måste det här prefixet läggas till flera gånger med hjälp av talprefixet, till exempel 1_orderby=first, 2_oderby=second.

Egenskaper properties-13

  • orderby

    antingen JCR-egenskapsnamnet som anges av ett radavstånd på @, till exempel @jcr:lastModified eller @jcr:content/jcr:titleeller ett annat predikat i frågan, till exempel 2_propertysom sorteringen ska göras på

  • sortera

    sorteringsriktning, antingen " desc" för fallande eller " asc" for ascending (default)

  • case

    om inställt på " ignore" kommer att göra sorteringsskiftläget okänsligt, vilket innebär att "a" kommer före "B", om den är tom eller utelämnad är sorteringen skiftlägeskänslig, vilket betyder "B" kommer före "a"

bana path

Söker i en viss bana.

Stöder inte facetextrahering.

Egenskaper properties-14

  • bana

    banmönster, beroende på exakt, kommer antingen hela underträdet att matcha (som att lägga till //* in xpath, but note that this does not include the base path) (exact=false, default) or only an exact path matching, which can include wilcards ( *). om self anges söks hela underträdet inklusive basnoden igenom

  • exakt

    if exact är true/on, den exakta sökvägen måste matcha, men den kan innehålla enkla jokertecken ( *), som matchar namn, men inte " /"; om det är false (standard) inkluderas alla underordnade (valfritt)

  • platt

    söker bara efter direkt underordnade objekt (som att lägga till " /*" in xpath) (används endast om " exact' är inte sant, valfritt)

  • self

    söker i underträdet men inkluderar basnoden som angetts som sökväg (inga jokertecken)

property property

Matchar JCR-egenskaper och deras värden.

Stöder facetextrahering. Ger bucket för varje unikt egenskapsvärde i resultatet.

Egenskaper properties-15

  • property

    relativ sökväg till egenskap, till exempel jcr:title

  • value

    Värde att kontrollera egenskap för. följer egenskapstypen JCR till strängkonverteringar

  • N_värde

    use 1_value, 2_value, … för att kontrollera om det finns flera värden (i kombination med OR som standard, med AND if och=true) (sedan 5.3)

  • och

    anges till true för att kombinera flera värden ( N_value) med OCH (sedan 5.3)

  • operation

    " equals" för exakt matchning (standard), " unequals" för jämförelse av skillnader, " like" för att använda jcr:like xpath-funktion (valfri), " not" utan matchning (t.ex. " not(@prop)" in xpath, value param will be ignore) or " exists" for exist check (value can be true - property must exist, the default - or false - same as " not")

  • djup

    antal jokernivåer under vilka egenskapen/den relativa sökvägen kan finnas (till exempel property=size depth=2 kommer att kontrollera nod/storlek, nod/*/size och nod/*/*/size)

rangegenskap rangeproperty

Matchar en JCR-egenskap mot ett intervall. Detta gäller egenskaper med linjär typ som LONG, DOUBLE och DECIMAL. För DATE se daterange-predikatet som har optimerade indata för datumformat.

Du kan definiera en nedre gräns och en övre gräns eller endast en av dem. Åtgärden (t.ex. "mindre än" eller "mindre eller lika med") kan också anges för enskilt nedre och övre gräns.

Stöder inte facetextrahering.

Egenskaper properties-16

  • property

    relativ sökväg till egenskap

  • lowerBound

    nedre gräns för check-egenskap för

  • lowerOperation

    " >" (standard) eller " >=", gäller lowerValue

  • upperBound

    övre gräns för check-egenskap för

  • upperOperation

    " <" (standard) eller " <=", gäller lowerValue

  • decimal

    " true" om egenskapen checked är av typen Decimal

relativ relativedaterange

Matchar JCR DATE egenskaper mot ett datum/tidsintervall med tidsförskjutningar i förhållande till den aktuella servertiden. Du kan ange lowerBound och upperBound med ett millisekundvärde eller bugzillasyntax 1s 2m 3h 4d 5w 6M 7y (en sekund, två minuter, tre timmar, fyra dagar, fem veckor, sex månader, sju år). Prefix med " -" om du vill ange en negativ förskjutning före den aktuella tiden. Om du bara anger lowerBound eller upperBoundblir det andra standardvärdet 0, vilket innebär den aktuella tiden.

Till exempel:

  • upperBound=1h (och nej) lowerBound) skulle välja vad som helst under nästa timme
  • lowerBound=-1d (och nej) upperBound) skulle välja vad som helst de senaste 24 timmarna
  • lowerBound=-6M och upperBound=-3M väljer du mellan 6 månader och 3 månader
  • lowerBound=-1500 och upperBound=5500 kan välja mellan 1 500 millisekunder tidigare och 5 500 millisekunder i framtiden
  • lowerBound=1d och upperBound=2d skulle välja vad som helst i övermorgon

Observera att programmet inte tar hänsyn till skottår och att alla månader är 30 dagar.

Filtrering stöds inte.

Stöder facet-extrahering på samma sätt som daterange-predikatet.

Egenskaper properties-17

  • upperBound

    övre gräns för datum i millisekunder eller 1s 2m 3h 4d 5w 6M 7y (en sekund, två minuter, tre timmar, fyra dagar, fem veckor, sex månader, sju år) i förhållande till aktuell servertid, använd "-" för negativ offset

  • lowerBound

    nedre gräns i millisekunder eller 1s 2m 3h 4d 5w 6M 7y (en sekund, två minuter, tre timmar, fyra dagar, fem veckor, sex månader, sju år) i förhållande till aktuell servertid, använd "-" för negativ offset

root root

Rotpredikatgrupp. Stöder alla funktioner i en grupp och tillåter att globala frågeparametrar ställs in.

Namnet "root" används aldrig i en fråga, det är underförstått.

Egenskaper properties-18

  • p.offset

    tal som anger början på resultatsidan, d.v.s. hur många objekt som ska hoppas över

  • p.limit

    nummer som anger sidstorleken

  • p.gissningTotal

    rekommenderas: Undvik att beräkna det totala resultatet som kan vara kostsamt. antingen en siffra som anger den högsta summan att räkna upp till (t.ex. 1000, ett tal som ger användarna tillräckligt med feedback på grovstorleken och exakta tal för mindre resultat) eller " true" för att endast räkna upp till det minsta nödvändiga p.offset + p.limit

  • p.excerpt

    om inställt på " true", ta med utdrag av fullständig text i resultatet

  • p.hits

    (endast för JSON-servern) väljer du hur träffar skrivs som JSON, med dessa standardinställningar (utbyggbara via ResultHitWriter-tjänsten):

    • enkel:

      minimala objekt som path, title, lastmodified, excerpt (om angivet)

    • full:

      sling JSON rendering of the node, with jcr:path som anger träffens sökväg: som standard visas bara de direkta egenskaperna för noden, inklusive ett djupare träd med p.nodedepth=N, med 0 avses hela det oändliga underträdet, add p.acls=true för att inkludera JCR-behörigheterna för den aktuella sessionen för det angivna resultatobjektet (mappningar: create = add_node, modify = set_property, delete = remove)

    • selektiv:

      endast egenskaper som anges i p.properties, som är en blankstegsavgränsad (använd"+" i URL-adresser) lista med relativa sökvägar, Om den relativa sökvägen har ett djup > 1 representeras dessa som underordnade objekt. den speciella jcr:path-egenskapen innehåller träffens sökväg

sparad fråga savedquery

Inkluderar alla predikat för en beständig querybuilder-fråga i den aktuella frågan som ett undergruppsprediat.

Observera att detta inte kör en extra fråga utan utökar den aktuella frågan.

Frågor kan sparas programmatiskt med QueryBuilder#storeQuery(). Formatet kan antingen vara en flerradig String-egenskap eller en nt:file nod som innehåller frågan som en textfil i Java-egenskapsformat.

Stöder inte facetextrahering för predikaten i den sparade frågan.

Egenskaper properties-19

  • sparad fråga

    sökväg till den sparade frågan (egenskapen String eller nt:file nod)

liknande similar

Likhetssökning med JCR XPath rep:similar().

Filtrering stöds inte. Stöder inte facetextrahering.

Egenskaper properties-20

  • liknande
    absolut sökväg till noden som liknande noder ska hittas för

  • lokal
    en relativ sökväg till en underordnad nod eller
    . för den aktuella noden (valfritt) är " .")

tag tag

Söker efter innehåll som har taggats med en eller flera taggar genom att ange sökvägar för taggtiteln.

Stöder facetextrahering. Tillhandahåller bucket för varje unik tagg med hjälp av deras aktuella namnsökväg för taggen.

Egenskaper properties-21

  • tag

    sökväg till tagg som du vill söka efter, t.ex. "Resursegenskaper: Orientering / liggande"

  • N_värde

    use 1_value, 2_value, … att söka efter flera taggar (i kombination med OR som standard, med AND if och=true) (sedan 5.6)

  • property

    egenskap (eller relativ sökväg till egenskap) att titta på (standard) cq:tags")

tagid tagid

Söker efter innehåll som taggats med en eller flera taggar genom att ange tagg-ID:n.

Stöder facetextrahering. Tillhandahåller bucket för varje unik tagg med deras aktuella tagg-ID.

Egenskaper properties-22

  • tagid

    tagg-id att söka efter, till exempel " properties:orientation/landscape"

  • N_värde

    use 1_value, 2_value, … att söka efter flera taggar (i kombination med OR som standard, med AND if och=true) (sedan 5.6)

  • property

    egenskap (eller relativ sökväg till egenskap) att titta på (standard) cq:tags")

tagsearch tagsearch

Söker efter innehåll som taggats med en eller flera taggar genom att ange nyckelord. Då söker först efter taggar som innehåller dessa nyckelord i sina titlar och begränsar sedan resultatet till enbart objekt som taggats med dessa.

Stöder inte facetextrahering.

Egenskaper Properties-1

  • tagsearch

    nyckelord som du vill söka efter i taggtitlar

  • property

    egenskap (eller relativ sökväg till egenskap) att titta på (standard) cq:tags")

  • lang

    om du bara vill söka i en viss lokaliserad taggtitel (t.ex. " de")

  • alla

    (bool) söka efter hela taggens fulltext, dvs. alla titlar, beskrivning osv. (har företräde framför"l" ang")

type type

Begränsar resultaten till en viss JCR-nodtyp, både primär nodtyp och blandningstyp. Detta söker även efter undertyper av den nodtypen. Observera att databasens sökindex måste omfatta nodtyperna för effektiv körning.

Stöder facetextrahering. Tillhandahåller bucket för varje unik typ i resultatet.

Egenskaper Properties-2

  • type

    nodtyp eller blandnamn att söka efter, till exempel cq:Page

recommendation-more-help
2315f3f5-cb4a-4530-9999-30c8319c520e