Die Warenkorbfunktion (workbasket)

Beschreibung der Komponente zur integration eines Warenkorbs in die Anwendung

Allgemein

Das Paket org.mycore.frontend.basket implementiert eine Korbfunktion für MyCoRe Anwendungen. Ein Korb sammelt Verweise auf Objekte, z. B. Dokumente in einem Dokumentenserver oder Bilder, die zu einem Album zusammengefasst werden sollen. Das Paket enthält Klassen für den API-Zugriff auf die Korbfunktionen und ein Servlet, das die Weboberfläche implementiert.

Ein Eintrag im Korb besteht aus einer eindeutigen ID und einer URI. Die ID repräsentiert ein Objekt, das im Korb enthalten sein soll, z. B. die MCRObjectID. Die URI gibt eine Quelle für XML-Daten an, die das Objekt beschreiben. Ein XSL-Stylesheet kann diese URI auflösen, um die im Korb enthaltenen Objekte in der Weboberfläche darzustellen.

MCRBasketEntry entry = new MCRBasketEntry( "DocPortal_document_00774301", "mcrobject:DocPortal_document_00774301" );

Ein Korb wird zunächst in nicht persistenter Form in der Session des Benutzers im Speicher gehalten. Innerhalb einer Anwendung und einer Session könnte es verschiedene Körbe geben, die über ein Typattribut unterschieden werden können, z. B. einen Korb zu Sammeln von Dokumenten, einen anderen Korb für Verweise auf Bilddateien.

Beispiel (API):

       MCRBasketEntry entry = new MCRBasketEntry( "DocPortal_document_00774301", "mcrobject:DocPortal_document_00774301" );
       MCRBasket basket = MCRBasketManager.getOrCreateBasketInSession( "objects" );
       basket.add( entry );
     

Die Klasse Basket implementiert die Schnittstellen List<MCRBasketEntry> und Set<MCRBasketEntry>.
Das MCRBasketServlet implementiert die Weboberfläche der Korbfunktion.
Beispiel (Servlet):

  • den Inhalt des Korbs "objects" anzeigen
    BasketServlet?type=objects&action=show
  • einen Eintrag dem Korb hinzufügen
    BasketServlet?type=objects&action=add&id=DocPortal_document_00774301&uri=mcrobject:DocPortal_document_00774301
  • die Parameter id und uri sind wiederholbar, so dass in einem Durchgang gleich mehrere Objekte zum Korb hinzugefügt oder gelöscht werden können. Damit die korrekte Zuordnung beibehalten wird, sollten die Parameter aber nicht als GET (Query-String) sondern mittels POST (HTML-Formular) übertragen werden.
  • den Korb leeren
    BasketServlet?type=objects&action=clear

Die HTML-Ausgabe von BasketServlet wird durch das XSL Stylesheet basket-{TYP}.xsl generiert, im obigen Beispiel also basket-objects.xsl.

Reihenfolge der Einträge

Einträge im Korb werden in einer definierten Reihenfolge abgelegt, zunächst in der Reihenfolge des Einfügens in den Korb. Die Position der Einträge ist veränderbar, Einträge können auf und ab geschoben werden:

       basket.up( entry );
       basket.down( entry );
       basket.move( entry, 3 ); // move entry 3 positions down
      

bzw.

        BasketServlet?type=objects&action=up&id=DocPortal_document_00774301
        BasketServlet?type=objects&action=down&id=DocPortal_document_00774301
      

Ein Objekt kann nur einmal in einem Korb vorhanden sein (Set-Eigenschaft). Zum Vergleich von Einträgen wird die ID des Eintrages verwendet.

Entfernen von Objekten

       basket.remove( entry );
       basket.removeEntry( "DocPortal_document_00774301" );
       basket.remove( basket.get( "DocPortal_document_00774301" ) );
     

bzw.

BasketServlet?type=objects&action=remove&id=DocPortal_document_00774301

Kommentare

Einträge im Korb können kommentiert werden.

       entry.setComment( "Kommentar" );
       String comment = entry.getComment();
     

bzw.

BasketServlet?type=objects&action=comment&id=DocPortal_document_0077430

Der obige Aufruf erwartet als weitere Requestparameter die Ausgabe eines Editor-Formulars. In diesem Formular wird der Kommentar bearbeitet. DocPortal enthält hierfür kein Beispiel. Das Formular basket-edit.xml aus miless kann hier als Vorlage dienen.

Körbe speichern und laden

Ein Korb wird zunächst in nicht persistenter Form in der Session der Webanwendung gehalten und dort bearbeitet. Eine Anwendung kann Funktionen zur Speicherung eines Korbes bereitstellen. Beispielsweise könnten in einer Bilddatenbank einzelne Bildobjekte im Korb gesammelt werden und diese Kollektion dann als Album mit weiteren Metadaten persistent gespeichert werden. Die Kollektion kann hierbei beliebige Metadaten enthalten und durch einen MyCoRe Objekttyp implementiert werden. Die Inhalte des Korbs selbst, d.h. die enthaltenen Verweise auf Objekte, werden als XML in einer Derivat-Datei gespeichert.

Korb speichern

       MCRObjectID ownerID = MCRObjectID.getInstance( "ImagePortal_basket_01234567" );
       MCRBasketPersistence.createDerivateWithBasket(basket, ownerID);
     

bzw.

BasketServlet?type=objects&action=create&ownerID=ImagePortal_basket_01234567

erzeugt ein neues Derivat für das Metadaten-Objekt ImagePortal_basket_01234567, legt darin eine Datei basket.xml an und speichert die Verweise des Korbs "objects" darin.

Das Metadaten-Objekt, das die Inhalte des Korbs persistent aufnimmt, kann zuvor auf beliebige andere Weise erstellt werden, etwa über ein Formular, das wie bei jedem MyCoRe Objekt Metadaten zur Beschreibung der Kollektion aufnimmt. Ein Korb merkt sich, in welchem Derivat er gespeichert wurde:

String derivateID = basket.getDerivateID();

Korb erneut speichern

Ein Korb wird in der Session über das BasketServlet oder über die API bearbeitet. Nach Veränderung kann er erneut persistent gespeichert werden:

MCRBasketPersistence.updateBasket(basket);

bzw.

BasketServlet?type=objects&action=update

Korb laden

Ein Korb kann aus der gespeicherten Form zur Anzeige und Bearbeitung in die Session geladen werden:

       MCRBasket basket = MCRBasketPersistence.retrieveBasket(derivateID);
       MCRBasketManager.setBasketInSession(basket);
     

bzw.

BasketServlet?action=retrieve&derivateID=ImagePortal_derivate_12345678

Aufgelöstes XML oder beliebige weitere Metadaten im Korb

In der Regel wird ein Korb nur Referenzen auf andere Objekte enthalten. Für einige Anwendungsfälle kann es jedoch nützlich sein, direkt das aufgelöste XML der Objekt-Metadaten statt nur die URI-Referenz darauf im Korb zu halten. In miless können so beispielsweise Publikationen in einem Korb gesammelt werden, und deren Metadaten direkt im Korb für alle Einträge auf einmal geändert werden. Erst beim Speichern des Korbes werden diese Änderungen dann von miless persistent gemacht.

Um die URI-Referenz für neue Einträge direkt aufzulösen und das XML der enthaltenen Objekte im Korb abzulegen, sind folgende Aufrufe zu nutzen:

       MCRBasketEntry entry = new MCRBasketEntry( "DocPortal_document_00774301", "mcrobject:DocPortal_document_00774301" );
       entry.resolveContent();
       basket.add(entry);
       Element resolvedXML = entry.getContent();
     

bzw.

BasketServlet?type=objects&action=add&id=DocPortal_document_00774301&uri=mcrobject:DocPortal_document_00774301&resolve=true

Es liegt in der Verantwortung der Anwendung, diese Variante zu unterstützen.

XML-Darstellung

Die Klassen MCRBasketXMLBuilder und MCRBasketXMLExporter transformieren ein Korbobjekt und seine Einträge von/nach XML. Bei der Generierung einer XML-Darstellung der Korbinhalte kann gewählt werden, ob die XML-Metadaten der Objekte selbst auch enthalten sein sollen:

       boolean includeBasketEntryContent = false;
       Document xml = new MCRBasketXMLBuilder( includeBasketEntryContent ).buildXML(basket);
     

bzw.

MCRBasket basket = new MCRBasketXMLParser().parse( xml );

Wird der Inhalt eines Korbes in einer Derivat-Datei persistent gespeichert, werden stets nur die enthaltenen Referenzen, nicht aber das aufgelöste XML der Objekt-Metadaten gespeichert.
Beispiel:

 
       <basket type="objects" id="ImagePortal_derivate_12345678">
         <entry id="DocPortal_document_00774301" uri="mcrobject:DocPortal_document_00774301">
           <!-- Hier evtl. weitere aufgelöste XML-Metadaten des Objektes -->
           <comment>Kommentar</comment>
         </entry>
       </basket>