Bygga taggar i ett AEM

För programmatiskt arbete med taggar eller tillägg av taggar i ett anpassat AEM-program beskriver den här sidan användningen av

som interagerar med

Mer information om taggning finns i:

  • Administrera taggar om du vill ha information om hur du skapar och hanterar taggar samt om vilka innehållstaggar som har tillämpats.
  • Använda taggar för information om att tagga innehåll.

Översikt över taggnings-API

Implementeringen av taggramverket i AEM gör att du kan hantera taggar och tagginnehåll med JCR-API:t. TagManager ser till att taggar som anges som värden i strängmatrisegenskapen cq:tags inte dupliceras, det tar bort tagg-ID:n som pekar på taggar som inte finns och uppdaterar tagg-ID:n för flyttade eller sammanfogade taggar. TagManager använder en JCR-observationslyssnare som återställer felaktiga ändringar. Huvudklasserna finns i com.day.cq.tagging-paketet:

  • JcrTagManagerFactory - returnerar en JCR-baserad implementering av TagManager. Det är referensimplementeringen av taggnings-API:t.
  • TagManager - gör att du kan lösa och skapa taggar efter sökvägar och namn.
  • Tag - definierar taggobjektet.

Hämta en JCR-baserad TagManager

Om du vill hämta en TagManager-instans måste du ha en JCR Session och anropa getTagManager(Session):

@Reference
JcrTagManagerFactory jcrTagManagerFactory;

TagManager tagManager = jcrTagManagerFactory.getTagManager(session);

I det typiska Sling-sammanhanget kan du även anpassa dig till en TagManager från ResourceResolver:

TagManager tagManager = resourceResolver.adaptTo(TagManager.class);

Hämtar ett taggobjekt

Du kan hämta en Tag genom TagManager genom att antingen matcha en befintlig tagg eller skapa en ny:

Tag tag = tagManager.resolve("my/tag"); // for existing tags

Tag tag = tagManager.createTag("my/tag"); // for new tags

För den JCR-baserade implementeringen, som mappar Tags till JCR Nodes, kan du använda Slings adaptTo-mekanism direkt om du har resursen (t.ex. /content/cq:tags/default/my/tag):

Tag tag = resource.adaptTo(Tag.class);

Även om en tagg endast kan konverteras *från *en resurs (inte en nod), kan en tagg konverteras *till *både en nod och en resurs:

Node node = tag.adaptTo(Node.class);
Resource node = tag.adaptTo(Resource.class);
OBSERVERA

Det går inte att direkt anpassa från Node till Tag eftersom Node inte implementerar metoden Sling Adaptable.adaptTo(Class).

Hämta och ställa in taggar

// Getting the tags of a Resource:
Tag[] tags = tagManager.getTags(resource);

// Setting tags to a Resource:
tagManager.setTags(resource, tags);

Söker efter taggar

// Searching for the Resource objects that are tagged with the tag object:
Iterator<Resource> it = tag.find();

// Retrieving the usage count of the tag object:
long count = tag.getCount();

// Searching for the Resource objects that are tagged with the tagID String:
 RangeIterator<Resource> it = tagManager.find(tagID);
OBSERVERA

Giltiga RangeIterator är:

com.day.cq.commons.RangeIterator

Tar bort taggar

tagManager.deleteTag(tag);

Replikerar taggar

Det går att använda replikeringstjänsten ( Replicator) med taggar eftersom taggar är av typen nt:hierarchyNode:

replicator.replicate(session, replicationActionType, tagPath);

Tagga på klientsidan

CQ.tagging.TagInputField är en formulärwidget för att ange taggar. Den har en snabbmeny där du kan välja bland befintliga taggar, som innehåller automatisk komplettering och många andra funktioner. Dess xtype är tags.

Taggskräpinsamlaren

Taggskräpinsamlaren är en bakgrundstjänst som rensar de dolda och oanvända taggarna. Dolda och oanvända taggar är taggar under /content/cq:tags som har en cq:movedTo-egenskap och som inte används i en innehållsnod - de har ett antal som är noll. Genom att använda den här lat borttagningsprocessen behöver inte innehållsnoden (d.v.s. egenskapen cq:tags) uppdateras som en del av flyttningen eller sammanfogningsåtgärden. Referenserna i egenskapen cq:tags uppdateras automatiskt när egenskapen cq:tags uppdateras, t.ex. via dialogrutan för sidegenskaper.

Taggskräpinsamlaren körs som standard en gång om dagen. Detta kan konfigureras på:

http://localhost:4502/system/console/configMgr/com.day.cq.tagging.impl.TagGarbageCollector

Taggsökning och tagglista

Sökningen efter taggar och tagglistan fungerar enligt följande:

  • Sökningen efter TagID söker efter de taggar som har egenskapen cq:movedTo inställd på TagID och följer genom TagID:n för cq:movedTo.

  • Om du söker efter taggen Title genomsöks bara de taggar som inte har en cq:movedTo-egenskap.

Taggar på olika språk

Som beskrivs i dokumentationen för att administrera taggar kan taggen titledefinieras på olika språk i avsnittet Hantera taggar på olika språk. Sedan läggs en språkkänslig egenskap till i taggnoden. Den här egenskapen har formatet jcr:title.<locale>, t.ex. jcr:title.fr för den franska översättningen. <locale> måste vara en ISO-språksträng med gemener och använda "_" i stället för "-", till exempel: de_ch.

När taggen Djur läggs till på sidan Produkter läggs värdet stockphotography:animals till i egenskapen cq:tags för noden /content/geometrixx/en/products/jcr:content. Översättningen refereras från taggnoden.

Serversidans API har lokaliserade title-relaterade metoder:

  • com.day.cq.tagging.Tag

    • getLocalizedTitle(språkområde)
    • getLocalizedTitlePaths()
    • getLocalizedTitles()
    • getTitle(Locale locale)
    • getTitlePath(språkområde)
  • com.day.cq.tagging.TagManager

    • canCreateTagByTitle(String tagTitlePath, Locale locale)
    • createTagByTitle(String tagTitlePath, Locale locale)
    • resolveByTitle(String tagTitlePath, locale)

I AEM kan språket hämtas antingen från sidspråket eller från användarspråket:

  • för att hämta sidspråket i en JSP:

    • currentPage.getLanguage(false)
  • för att hämta användarspråket i en JSP:

    • slingRequest.getLocale()

currentPage och slingRequest är tillgängliga i en JSP via <cq:definedobjects> taggen.

För taggning beror lokaliseringen på sammanhanget eftersom taggen titleskan visas på sidspråket, på användarspråket eller på något annat språk.

Lägga till ett nytt språk i dialogrutan Redigera tagg

I proceduren nedan beskrivs hur du lägger till ett nytt språk (finska) i dialogrutan Taggredigering:

  1. I CRXDE redigerar du flervärdesegenskapen languages för noden /content/cq:tags.

  2. Lägg till fi_fi - som representerar den finska språkversionen - och spara ändringarna.

Det nya språket (finska) är nu tillgängligt i taggdialogrutan för sidegenskaperna och i dialogrutan Redigera tagg när du redigerar en tagg i konsolen Taggning.

OBSERVERA

Det nya språket måste vara ett av de AEM identifierade språken, d.v.s. det måste vara tillgängligt som en nod under /libs/wcm/core/resources/languages.

På denna sida