Zum Zwecke von programmatischem Arbeiten mit Tags oder zum Erweitern von Tags in einem benutzerdefinierten AEM-Programm wird in diesem Dokument die Verwendung der
die mit dem
Weitere Informationen zum Tagging finden Sie unter:
Die Implementierung des Tagging-Frameworks in AEM ermöglicht die Verwaltung von Tags und Tag-Inhalten mithilfe der JCR-API. TagManager
stellt sicher, dass Tags, die als Werte in der cq:tags
String-Array-Eigenschaft eingegeben wurden, nicht dupliziert werden. Er entfernt TagID
, die auf nicht vorhandene Tags verweisen, und aktualisiert TagID
für verschobene oder zusammengefügte Tags. TagManager
verwendet einen JCR Observation Listener, der alle falschen Änderungen zurückgesetzt. Die wichtigsten Klassen befinden sich im Paket com.day.cq.tagging:
JcrTagManagerFactory
– gibt eine JCR-basierte Implementierung eines TagManager
s 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.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);
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);
Die direkte Anpassung von Node
zu Tag
ist nicht möglich, da Node
die Sling-Methode Adaptable.adaptTo(Class)
nicht implementiert.
// Getting the tags of a Resource:
Tag[] tags = tagManager.getTags(resource);
// Setting tags to a Resource:
tagManager.setTags(resource, 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);
Der gültige zu verwendete RangeIterator
ist:
com.day.cq.commons.RangeIterator
tagManager.deleteTag(tag);
Es ist möglich, den Replikations-Service (Replicator
) mit Tags zu verwenden, da Tags vom Typ nt:hierarchyNode
sind:
replicator.replicate(session, replicationActionType, tagPath);
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 cq:movedTo
-Eigenschaft aufweisen und nicht für einen Inhaltsknoten verwendet werden. 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://<host>:<port>/system/console/configMgr/com.day.cq.tagging.impl.TagGarbageCollector
Die Tag-Suche und die Tag-Auflistung funktionieren folgendermaßen:
TagID
sucht nach den Tags, für die die Eigenschaft cq:movedTo
auf TagID
gesetzt ist und cq:movedTo
-TagID
s folgt.cq:movedTo
besitzen.Ein title
-Tag kann 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 den Unterstrich (_
) anstelle des Bindestrichs/Schrägstrichs (-
) verwenden. Beispiel: de_ch
.
Wird beispielsweise der Seite Produkte das Tag Tiere hinzugefügt wird, wird der Eigenschaft cq:tags
des Knotens /content/wknd/en/products/jcr:content
der Wert stockphotography:animals
hinzugefügt. Die Übersetzung wird vom Tag-Knoten referenziert.
Die Server-seitige API verfügt über lokalisierte title
-bezogene Methoden:
com.day.cq.tagging.Tag
getLocalizedTitle(Locale locale)
getLocalizedTitlePaths()
getLocalizedTitles()
getTitle(Locale locale)
getTitlePath(Locale locale)
com.day.cq.tagging.TagManager
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 Anwendersprache abgerufen werden.
Beim Tagging hängt die Lokalisierung vom Kontext ab, da Tag-titles
in der Seitensprache, in der Anwendersprache oder in jeder anderen Sprache angezeigt werden können.
Im folgenden Verfahren wird beschrieben, wie Sie dem Dialogfeld Tag bearbeiten eine neue Sprache (z. B. Finnisch) hinzufügen:
languages
des Knotens /content/cq:tags
.fi_fi
hinzu, das das finnische Gebietsschema darstellt, und speichern Sie die Änderungen.Finnisch ist jetzt im Tag-Dialogfeld der Seiteneigenschaften und im Dialogfeld Tag bearbeiten verfügbar, wenn Sie ein Tag in der Tagging-Konsole bearbeiten.
Die neue Sprache muss eine der von AEM erkannten Sprachen sein, d. h. sie muss als Knoten unter /libs/wcm/core/resources/languages
verfügbar sein.