Syntax

$objects.instanceExport(
    name: "my-export.objects.xml", 
    excludes: [`my.module:MyType#excludedRef`], 
    includes: [`my.module:MyType#includedRef`])

Beschreibung

Exportiert eine Menge von Objekt-Instanzen nach XML. Das erzeugte Format kann mit der Funktion instanceImport() später wieder eingelesen und zu Objekten instanziiert werden. Standardmäßig werden alle aus den Eingabe-Objekten über Kompositionsreferenzen referenzierten Objekte mitexportiert. Wenn ein Objekt aus dem so exportierten Objektgraphen über eine reguläre Referenz referenziert wird, dann muss dieses Objekt entweder auch über eine Kompositionsreferenz in den Export eingeschlossen werden, oder die reguläre Referenz muss über den includes-Parameter wie eine Kompositionsreferenz behandelt, oder über den excludes-Parameter vom Export ausgeschlossen werden.

Parameter

Name	Typ	Beschreibung	Pflicht	Default
objects	Menge von Objekten	Die Menge der zu exportierenden Objekte. Ausgehend von diesen Objekten werden alle über Kompositionsreferenzen erreichbaren Objekte mitexportiert.	ja	-
name	Zeichenkette	Der Dateiname der Export-Datei	nein	"<Datum>-<Typ>.objects.xml"
excludes	Menge von Attributen und/oder Typen	Alle in dieser Menge angegebenen Attribute werden vom Export ausgeschossen. Wird ein Typ angegeben, werden alle Attribute dieses Typs ausgeschlossen.	nein	[]
includes	Menge von Attributen und/oder Typen	Alle in dieser Menge angegebenen Referenzen werden wie Kompositionen behandelt und die von ihnen referenzierten Objekte werden in den Export eingeschlossen. Wird eine Klasse angegeben, dann werden alle Referenzen die diese Klasse als Typ haben in den Export eingeschlossen.	nein	[]

Rückgabewert

Typ: Binärwert

Die aus dem Objekgraphen erzeugte XML-Datei.

Beispiele

Alle Accounts als XML-Export

all(`tl.accounts:Person`)
    .instanceExport(
        name: "all-accounts.xml",
        includes: [
            `tl.accounts:Person#representativeGroup`, 
            `tl.accounts:Person#contact`])

Ausgabe: XML-Datei mit allen Accounts im System inklusive ihrer Kontakte und Stellvertretergruppen.