some Un-/Marshal functions added

Author: duschata

typescript/src/main/resources/readme_de.md renamed to typescript/readme_de.md

@@ -1,9 +1,8 @@
-
-Tests gibt es noch nicht, ich denke mein Ansatz dient erst mal der Orientierung und Diskussion.
+Tests gibt es noch nicht, ich denke mein Ansatz dient erst mal der Orientierung und Diskussion. Wenn es alles so weit OK ist, können wir bestehende Tests auf TS umstellen. 
 
 Die Definitiondatei war ürsprünglich nicht systematisch erstellt, sondern hat sich aus den Anforderungen ergeben, die ich ad hoc beim Verwenden von Jsonix ergeben haben. Dazu hatte ich mir ursprünglich den Context rekursiv (begrenzt auf eine gewisse Tiefe) als JSON.stringify ausgeben lassen und dann bearbeitet, was natürlich nicht so gut die Class-Hierarchie trifft.
 
-Da ich kein professionelles UML-Tool besitze (und schon gar keins, was TS erzeugt, falls es so etwas überhaupt gibt), bin ich auf Java ausgewichen. 
+Da ich kein professionelles UML-Tool besitze (und schon gar keins, was TS erzeugt, falls es so etwas überhaupt gibt (StarUML und TS-Plugin bekomme ich nicht zum laufen)), bin ich auf Java ausgewichen. 
 Die Klassen, die in Java erzeugt werden "ähneln" den Design-Pattern von TS, so dass man Ende mit ein paar regulären Ausrücken, den Code umwandeln kann (zu den Interfaces komme ich später. Man könnte das natürlich auch via xmi lösen, das fände ich zum gegenwärtigen Zeitpunkt aber etwas übertrieben.
 
 Die Klassenhierarchie aus 
@@ -20,17 +19,6 @@ In der Java Uml habe ich einfach Interfaces benutzt, was nicht ganz korrekt ist,
 
 In TS und plain-JS, was d.ts benutzt gibt es keinen wirklich funktionierende instanceof Implementierung. Das generierte JS weiß quasi nichts von den Klassen, die in TS definiert sind. Der Code "weiß", wenn er eine TypeInfo verarbeitet nicht, ob es nicht vielleicht eine ClassInfo ist. Jsonix benutzt hier in jeder Klasse ein CLASS_NAME Feld, das konnte ich in die Interfaces nicht aufnehmen, da sie keinen Initializer besitzten dürfen (das Problem sollte aber erledigt sein, wenn man Klassen definiert, die ein CLASS_NAME Feld besitzen können).
 
+Ich hätte gerne Generics eingebaut, leider geht das wegen der gekapselten factory nicht. Hier könnte man eine Funktion in Jsonix ergänzen, dann sollte es gehen:
 
-
-
-
-
-
- 
-
-
-
-
-
-
- 
+createUnmarshaller<T>(type: T): Unmarshaller<T>;

typescript/src/main/typescript/Jsonix.d.ts

@@ -1,69 +1,113 @@
 /**
  * (description)
- * 
+ *
  * @interface Unmarshaller
  */
-interface Unmarshaller {
+interface Unmarshaller {  //TODO: <T> @see createUnmarshaller
     /**
      * (description)
-     * 
+     *
      * @param {string} arg (description)
      * @returns {Object} (description)
      */
     unmarshalString(arg: string): Object;
+
+    /**
+     * (description)
+     * 
+     * @param {string} fileName (description)
+     * @param {(unmarshalled:Object)=> void} callback (description)
+     * @param {Object} options (description)
+     */
+    unmarshalFile(fileName: string, callback: (unmarshalled: Object) => void, options: Object): void;
+
+
     /**
      * (description)
      * 
-     * @param {File} arg (description)
+     * @param {string} url (description)
+     * @param {(unmarshalled:Object)=> void} callback (description)
+     * @param {Object} options (description)
+     */
+    unmarshalURL(url: string, callback: (unmarshalled: Object) => void, options: Object): void;
+
+    /**
+     * (description)
+     * 
+     * @param {Element} doc (description)
+     * @param {string} scope (description)
      * @returns {Object} (description)
      */
-    unmarshalFile(arg: File): Object;
+    unmarshalDocument(doc: Element, scope: string): Object;
 }
 /**
  * (description)
- * 
+ *
  * @interface Marshaller
  */
-interface Marshaller {
+interface Marshaller { // TODO: generics like marshalString(object:T):string;
+    /**
+     * (description)
+     * 
+     * @param {Object} object (description)
+     * @returns {string} (description)
+     */
+    marshalString(object: Object): string;
 
+    /**
+     * (description)
+     * 
+     * @param {Object} object (description)
+     * @returns {Element} (description)
+     */
+    marshalDocument(object: Object): Element;
 }
 
 declare module Jsonix {
     export class Context {
         /**
          * Creates an instance of Context.
-         * 
+         *
          * @param {any[]} s (description)
          */
         constructor(s: any[]);
+
         /**
          * (description)
-         * 
+         *
          * @param {string} name (description)
          * @returns {TypeInfo} (description)
          */
         getTypeInfoByName(name: string): TypeInfo;
+
         /**
          * (description)
-         * 
+         *
          * @param {string} typeName (description)
          * @returns {TypeInfo} (description)
          */
         getTypeInfoByTypeName(typeName: string): TypeInfo;
+
         /**
          * (description)
-         * 
+         *
          * @param {string} typeNameKey (description)
          * @returns {TypeInfo} (description)
          */
         getTypeInfoByTypeNameKey(typeNameKey: string): TypeInfo;
+
         getElementInfo(name: string, scope: string): any;
+
         getSubstitutionMembers(name: string): any;
 
         createMarshaller(): Marshaller;
+
         createUnmarshaller(): Unmarshaller;
 
+        //TODO: createUnmarshaller<T>(type: T): Unmarshaller<T>;
+
         getNamespaceURI(prefix: string): any;
+
         getPrefix(namespaceURI: string, defaultPrefix: string): any;
 
         builtinTypeInfos: {
@@ -134,7 +178,7 @@ declare module Jsonix {
 
 /**
  * (description)
- * 
+ *
  * @interface Styled
  */
 interface Styled {
@@ -145,7 +189,7 @@ interface Styled {
 //TODO: package Schema.XSD
 /**
  * (description)
- * 
+ *
  * @interface QName
  */
 interface QName {
@@ -159,7 +203,7 @@ interface QName {
 //TODO: package mapping
 /**
  * (description)
- * 
+ *
  * @interface TypeInfo
  */
 interface TypeInfo {
@@ -169,7 +213,7 @@ interface TypeInfo {
 
 /**
  * (description)
- * 
+ *
  * @interface PropertyInfo
  */
 interface PropertyInfo {
@@ -183,7 +227,7 @@ interface PropertyInfo {
 
 /**
  * (description)
- * 
+ *
  * @interface AbstractElementPropertyInfo
  * @extends {PropertyInfo}
  */
@@ -197,7 +241,7 @@ interface AbstractElementPropertyInfo extends PropertyInfo {
 
 /**
  * (description)
- * 
+ *
  * @interface ElementPropertyInfo
  * @extends {AbstractElementPropertyInfo}
  */
@@ -209,7 +253,7 @@ interface ElementPropertyInfo extends AbstractElementPropertyInfo {
 
 /**
  * (description)
- * 
+ *
  * @interface ClassInfo
  * @extends {TypeInfo}
  * @extends {Styled}
@@ -254,5 +298,4 @@ interface ClassInfo extends TypeInfo, Styled {
         value: { v }
     }
 
-
 }