Einbinden von Tagging in eine AEM-Anwendung building-tagging-into-an-aem-application
Zum Zweck der programmgesteuerten Arbeit mit Tags oder der Erweiterung von Tags in einem benutzerdefinierten AEM-Programm beschreibt diese Seite die Verwendung des
die mit dem
Weitere Informationen zum Tagging finden Sie unter:
- Informationen zur Erstellung und Verwaltung von Tags sowie dazu, welchen Inhalten Tags zugewiesen werden, finden Sie unter Verwalten von Tags.
- Verwenden von Tags für Informationen zum Tagging von Inhalten.
Übersicht über die Tagging-API overview-of-the-tagging-api
Die Implementierung des Tagging-Frameworks in AEM ermöglicht die Verwaltung von Tags und Tag-Inhalten mithilfe der JCR-API. Der TagManager stellt sicher, dass Tags, die als Werte in der Zeichenfolgen-Array-Eigenschaft cq:tags
eingegeben wurden, nicht dupliziert werden. Er entfernt TagIDs, die auf nicht vorhandene Tags verweisen, und aktualisiert TagIDs für verschobene oder zusammengefügte Tags. TagManager verwendet einen JCR Observation Listener, der alle falschen Änderungen zurücksetzt. Die wichtigsten Klassen befinden sich im Paket com.day.cq.tagging:
- JcrTagManagerFactory – gibt eine JCR-basierte Implementierung eines
TagManager
zurück. Es ist die Referenzimplementierung der Tagging-API. TagManager
– ermöglicht das Auflösen und Erstellen von Tags nach Pfaden und Namen.Tag
- definiert das Tag-Objekt.
Abrufen eines JCR-basierten TagManagers getting-a-jcr-based-tagmanager
Um eine TagManager-Instanz abzurufen, benötigen Sie eine JCR-Session
und Sie müssen getTagManager(Session)
aufrufen:
@Reference
JcrTagManagerFactory jcrTagManagerFactory;
TagManager tagManager = jcrTagManagerFactory.getTagManager(session);
Im typischen Sling-Kontext können Sie sich auch mit dem TagManager
an einen ResourceResolver
anpassen:
TagManager tagManager = resourceResolver.adaptTo(TagManager.class);
Abrufen eines Tag-Objekts retrieving-a-tag-object
Ein Tag
kann über den TagManager
abgerufen werden, indem entweder ein vorhandenes Tag aufgelöst oder ein neues erstellt wird:
Tag tag = tagManager.resolve("my/tag"); // for existing tags
Tag tag = tagManager.createTag("my/tag"); // for new tags
Für die JCR-basierte Implementierung, die Tags
auf JCR-Nodes
abbildet, können Sie den Mechanismus adaptTo
von Sling direkt verwenden, wenn Sie die Ressource haben (z. B. /content/cq:tags/default/my/tag
):
Tag tag = resource.adaptTo(Tag.class);
Während ein Tag nur „von“ einer Ressource (kein Knoten) konvertiert werden kann, kann ein Tag sowohl in einen Knoten als auch in eine Ressource konvertiert werden :
Node node = tag.adaptTo(Node.class);
Resource node = tag.adaptTo(Resource.class);
Node
zu Tag
ist nicht möglich, da Node
die Sling-Methode Adaptable.adaptTo(Class)
nicht implementiert.Abrufen und Festlegen von Tags getting-and-setting-tags
// Getting the tags of a Resource:
Tag[] tags = tagManager.getTags(resource);
// Setting tags to a Resource:
tagManager.setTags(resource, tags);
Suchen nach Tags searching-for-tags
// 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);
RangeIterator
ist:com.day.cq.commons.RangeIterator
Löschen von Tags deleting-tags
tagManager.deleteTag(tag);
Replizieren von Tags replicating-tags
Es ist möglich, den Replikations-Service (Replicator
) mit Tags zu verwenden, da Tags vom Typ nt:hierarchyNode
sind:
replicator.replicate(session, replicationActionType, tagPath);
Tagging auf der Client-Seite tagging-on-the-client-side
CQ.tagging.TagInputField
ist ein Formular-Widget zum Eingeben von Tags. Es beinhaltet ein Popup-Menü für die Auswahl vorhandener Tags, einschließlich Autovervollständigen und vieler anderer Funktionen. Sein xtype ist tags
.
Der Tag Garbage Collector the-tag-garbage-collector
Der Tag Garbage Collector ist ein Hintergrund-Service, der die ausgeblendeten und nicht verwendeten Tags bereinigt. Ausgeblendete und nicht verwendete Tags sind Tags unter /content/cq:tags
, die eine Eigenschaft cq:movedTo
haben und nicht auf einem Inhaltsknoten verwendet werden, d. h. ihre Anzahl beträgt null. Durch Verwenden dieses Lazy-Deletion-Prozesses muss der Inhaltsknoten (d. h. die Eigenschaft cq:tags
) nicht als Teil der Verschiebung oder dem Zusammenführungsvorgang aktualisiert werden. Die Verweise in der Eigenschaft cq:tags
werden automatisch aktualisiert, wenn die Eigenschaft cq:tags
aktualisiert wird, z. B. durch das Seiteneigenschaften-Dialogfeld.
Das Garbage Collector Tag wird standardmäßig einmal am Tag ausgeführt. Dies kann konfiguriert werden unter:
http://localhost:4502/system/console/configMgr/com.day.cq.tagging.impl.TagGarbageCollector
Tag-Suche und Tag-Auflistung tag-search-and-tag-listing
Die Tag-Suche und die Tag-Auflistung funktionieren folgendermaßen:
-
Die Suche nach TagID sucht nach den Tags, für die die Eigenschaft
cq:movedTo
auf TagID gesetzt ist, und folgt dencq:movedTo
-TagIDs. -
Die Suche nach Tag-Titel sucht nur die Tags, die keine Eigenschaft
cq:movedTo
besitzen.
Tags in verschiedenen Sprachen tags-in-different-languages
Wie in der Dokumentation zur Verwaltung von Tags im Abschnitt Verwalten von Tags in verschiedenen Sprachen beschrieben, kann ein Tag-title
in verschiedenen Sprachen definiert werden. Eine sprachempfindliche Eigenschaft wird dann dem Tag-Knoten hinzugefügt. Diese Eigenschaft weist das Format jcr:title.<locale>
auf, beispielsweise jcr:title.fr
für die französische Übersetzung. <locale>
muss eine ISO-Gebietsschema-Zeichenfolge in Kleinbuchstaben sein und „_“ anstelle von „-“ verwenden, zum Beispiel: de_ch
.
Wenn das Tag Animals zur Produktseite hinzugefügt wird, wird der Wert stockphotography:animals
zur Eigenschaft cq:tags
des Knotens „/content/geometrixx/de/products/jcr:content“ hinzugefügt. Die Übersetzung wird vom Tag-Knoten referenziert.
Die Server-seitige API verfügt über lokalisierte title
-bezogene Methoden:
-
- getLocalizedTitle(Locale locale)
- getLocalizedTitlePaths()
- getLocalizedTitles()
- getTitle(Locale locale)
- getTitlePath(Locale locale)
-
- canCreateTagByTitle(String tagTitlePath, Locale locale)
- createTagByTitle(String tagTitlePath, Locale locale)
- resolveByTitle(String tagTitlePath, Locale locale)
In AEM kann die Sprache entweder aus der Seitensprache oder aus der Benutzersprache abgerufen werden:
-
So rufen Sie die Seitensprache in einer JSP ab:
currentPage.getLanguage(false)
-
So rufen Sie die Benutzersprache in einer JSP ab:
slingRequest.getLocale()
currentPage
und slingRequest
sind in einer JSP über das Tag <cq:definedObjects> verfügbar.
Beim Tagging hängt die Lokalisierung vom Kontext ab, da Tag-titles
in der Seitensprache, in der Benutzersprache oder in jeder anderen Sprache angezeigt werden können.
Hinzufügen einer neuen Sprache zum Dialogfeld „Tag bearbeiten“ adding-a-new-language-to-the-edit-tag-dialog
Im folgenden Verfahren wird beschrieben, wie Sie eine neue Sprache (Finnisch) zum Tag bearbeiten dialog:
-
Bearbeiten Sie in CRXDE die Mehrwerteigenschaft
languages
des Knotens/content/cq:tags
. -
Fügen Sie
fi_fi
hinzu, das das finnische Gebietsschema darstellt, und speichern Sie die Änderungen.
Die neue Sprache (Finnisch) ist jetzt im Tag-Dialogfeld der Seiteneigenschaften und im Dialogfeld Tag bearbeiten verfügbar, wenn Sie ein Tag in der Tagging-Konsole bearbeiten.
/libs/wcm/core/resources/languages
verfügbar sein.