Changeset 3004 for trunk/sources/HeuristicLab.Persistence/3.3/Default

Timestamp:

03/11/10 12:54:14 (15 years ago)

Author:

epitzer

Message:

add complete persistence API docs (#548)

Location:

trunk/sources/HeuristicLab.Persistence/3.3/Default

Files:

• CompositeSerializers/Storable/DataMemberAccessor.cs (modified) (6 diffs)
• Xml/Primitive/System.Drawing/Bitmap2XmlSerializer.cs (modified) (2 diffs)
• Xml/XmlGenerator.cs (modified) (2 diffs)

trunk/sources/HeuristicLab.Persistence/3.3/Default/CompositeSerializers/Storable/DataMemberAccessor.cs

@@ -5 +5 @@
 namespace HeuristicLab.Persistence.Default.CompositeSerializers.Storable {
 
+  /// <summary>
+  /// Encapsulation and abstraction for access a data member of an object
+  /// regardless of it being a property or field. Addicionally a
+  /// default value and an alternate name can be specified.
+  /// </summary>
   public class DataMemberAccessor {
 
@@ -12 +17 @@
     public readonly object DefaultValue;
 
+
+    /// <summary>
+    /// Create a DataMemberAccessor from a FieldInfo or PropertyInfo for the give object.
+    /// </summary>
     public DataMemberAccessor(MemberInfo memberInfo, string name, object defaultvalue, object obj) {
       Name = name;
@@ -33 +42 @@
     }
 
+    /// <summary>
+    /// Wrap existing getter and setter functions.
+    /// </summary>
     public DataMemberAccessor(string name, object defaultValue,
         Func<object> getter, Action<object> setter) {
@@ -40 +52 @@
       Set = setter;
     }
-
+    
+    /// <summary>
+    /// Create an empty accessor that just encapsulates an object
+    /// without access.
+    /// </summary>
     public DataMemberAccessor(object o) {
       Name = null;
@@ -48 +64 @@
     }
 
+    /// <summary>
+    /// Create an empty accessor that just encapsulates an object
+    /// without access.
+    /// </summary>
     public DataMemberAccessor(object o, string name) {
       Name = name;
@@ -54 +74 @@
       Set = null;
     }
-
 
     public override string ToString() {

trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Primitive/System.Drawing/Bitmap2XmlSerializer.cs

@@ -11 +11 @@
 
 namespace HeuristicLab.Persistence.Default.Xml.Primitive {
-  public class Bitmap2XmlSerializer :PrimitiveXmlSerializerBase<Bitmap>{
-    private static Regex re = new Regex(@"<!\[CDATA\[((?:[^]]|\](?!\]>))*)\]\]>", RegexOptions.Singleline);
+  public class Bitmap2XmlSerializer : PrimitiveXmlSerializerBase<Bitmap> {
 
     public override XmlString Format(Bitmap o) {
       MemoryStream stream = new MemoryStream();
-      o.Save(stream,ImageFormat.Png);
+      o.Save(stream, ImageFormat.Png);
       byte[] array = stream.ToArray();
       Byte1DArray2XmlSerializer serializer = new Byte1DArray2XmlSerializer();
@@ -32 +31 @@
       Bitmap bitmap = new Bitmap(stream);
       return bitmap;
-  }
+    }
   }
 }

trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/XmlGenerator.cs

@@ -11 +11 @@
 namespace HeuristicLab.Persistence.Default.Xml {
 
+
+  /// <summary>
+  /// Main entry point of persistence to XML. Use the static methods to serialize
+  /// to a file or to a stream.
+  /// </summary>
   public class XmlGenerator : GeneratorBase<string> {
 
@@ -155 +160 @@
     }
 
+    /// <summary>
+    /// Serialize an object into a file.
+    /// 
+    /// The XML configuration is obtained from the <code>ConfigurationService</code>.
+    /// The file is actually a ZIP file.
+    /// Compression level is set to 5 and needed assemblies are not included.
+    /// </summary>    
     public static void Serialize(object o, string filename) {
-      Serialize(o, filename, ConfigurationService.Instance.GetDefaultConfig(new XmlFormat()), false, 5);
-    }
-
+      Serialize(o, filename, ConfigurationService.Instance.GetConfiguration(new XmlFormat()), false, 5);
+    }
+
+    /// <summary>
+    /// Serialize an object into a file.
+    /// 
+    /// The XML configuration is obtained from the <code>ConfigurationService</code>.
+    /// Needed assemblies are not included.
+    /// </summary>
+    /// <param name="compression">ZIP file compression level</param>
     public static void Serialize(object o, string filename, int compression) {
       Serialize(o, filename, ConfigurationService.Instance.GetConfiguration(new XmlFormat()), false, compression);
     }
+
 
     public static void Serialize(object obj, string filename, Configuration config) {