Changeset 4898 for trunk/src/clients/web/net/sf/basedb

Timestamp:

Apr 21, 2009, 11:29:09 AM (14 years ago)

Author:

Martin Svensson

Message:

References #1297 Added support for custom data loaders and collections

Location:

trunk/src/clients/web/net/sf/basedb/clients/web/plugins

Files:

• DataLoader.java (added)
• ExportTemplate.java (modified) (2 diffs)
• ExportedProperty.java (modified) (5 diffs)
• PlainTextTemplate.java (modified) (2 diffs)
• QueryWrapper.java (modified) (2 diffs)
• SimpleExport.java (modified) (4 diffs)
• XMLTemplate.java (modified) (3 diffs)

trunk/src/clients/web/net/sf/basedb/clients/web/plugins/ExportTemplate.java

@@ -23 +23 @@
 
 import java.io.IOException;
+import java.util.Collection;
 import java.util.List;
 
@@ -84 +85 @@
   
   /**
+    Write the values in a collection
+    @param ep Exported property the values belong to
+    @param values The values to be written
+    @since 2.12
+   */
+  public void writeCollection(ExportedProperty ep, Collection<?> values)
+    throws IOException;
+  
+  /**
     End writing an item
     @throws IOException If there is an error

trunk/src/clients/web/net/sf/basedb/clients/web/plugins/ExportedProperty.java

@@ -41 +41 @@
   public final Unit unit;
   public final Formatter formatter;
+  public final DataLoader dataloader;
   
   public static ExportedProperty parse(DbControl dc, String column, boolean annotatable, Formatter formatter)
@@ -60 +61 @@
   public static ExportedProperty parse(DbControl dc, String column, String columnPrefix, 
     boolean annotatable, Formatter formatter, boolean sameUnits)
+  {
+    return parse(dc, column, columnPrefix, annotatable, formatter, sameUnits, null);
+  }
+  
+  /**
+    @since 2.12
+  */
+  @SuppressWarnings("unchecked")
+  public static ExportedProperty parse(DbControl dc, String column, String columnPrefix, 
+      boolean annotatable, Formatter formatter, boolean sameUnits, DataLoader dataloader)
   {
     String[] p = column.split(":");
@@ -81 +92 @@
     if (columnPrefix != null) title = columnPrefix + title;
     if (columnSuffix != null) title += columnSuffix;
-    return new ExportedProperty(name, title, at, unit, formatter);
+    return new ExportedProperty(name, title, at, unit, formatter, dataloader);
   }
 
@@ -95 +106 @@
     AnnotationType annotationType, Unit unit, Formatter formatter)
   {
+    this(name, title, annotationType, unit, formatter, null);   
+  }
+  
+  public ExportedProperty(String name, String title, 
+      AnnotationType annotationType, Unit unit, Formatter formatter, DataLoader dataloader)
+  {
     this.name = name;
     this.title = title;
@@ -100 +117 @@
     this.formatter = formatter;
     this.unit = unit;
+    this.dataloader = dataloader;
   }
-  
 }

trunk/src/clients/web/net/sf/basedb/clients/web/plugins/PlainTextTemplate.java

@@ -24 +24 @@
 import java.io.IOException;
 import java.io.Writer;
+import java.util.Collection;
 import java.util.List;
 import java.util.regex.Pattern;
@@ -122 +123 @@
     exportStream.write(escape(ep.formatter.format(data)));
   }
+  
+  /**
+    Writes a collection of values.
+    @since 2.12
+   */
+  @Override
+  @SuppressWarnings("unchecked")
+  public void writeCollection(ExportedProperty ep, Collection<?> values)
+      throws IOException
+  {
+    if (colNum > 0) exportStream.write("\t");
+    colNum++;   
+    exportStream.write(escape(Values.getString(values, ",", true, ep.formatter)));
+  }
 
   /**

trunk/src/clients/web/net/sf/basedb/clients/web/plugins/QueryWrapper.java

@@ -32 +32 @@
   @base.modified $Date$
 */
-interface QueryWrapper<T>
+interface QueryWrapper<T> extends DataLoader<T>
 {
   /**
@@ -47 +47 @@
   public int getId(T item);
   
-  /**
-    Get the value for the specified property.
-    @param exportedProperty The property to get the value for
-    @param item The item that holds the value
-   * @throws Exception If failing to get the data.
-  */
-  public Object getData(ExportedProperty exportedProperty, T item)
-    throws Exception;
-  
 }

trunk/src/clients/web/net/sf/basedb/clients/web/plugins/SimpleExport.java

@@ -76 +76 @@
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collection;
 import java.util.Date;
 import java.util.List;
@@ -252 +253 @@
     MultiFormatter defaultFormatter = new MultiFormatter(new ToStringFormatter<Object>(), true);
     defaultFormatter.registerFormatter(Date.class, FormatterFactory.getDateFormatter(sc));
+    DataLoader dataloader = null;
     for (String column : columns)
     {
@@ -265 +267 @@
           formatter = (Formatter<?>)possibleFormatter;
         }
+        // Get the registered dataloader for current column, if any, and clear it. 
+        Object possibleDataloader = cc.setObject("export.dataloader." + property, null);        
+        if (possibleDataloader instanceof DataLoader)
+        {
+          dataloader = (DataLoader<?>)possibleDataloader;
+        }
       }
       ExportedProperty ep = ExportedProperty.parse(dc, column, columnPrefix, 
-        annotatable, formatter, sameUnits);
+        annotatable, formatter, sameUnits, dataloader);
       exportedProperties.add(ep);
       properties.add(ep.name);
@@ -569 +577 @@
             else
             {
-              Object data = queryWrapper.getData(ep, item);
-              template.writeProperty(ep, data);
+              Object data = ep.dataloader == null ? 
+                  queryWrapper.getData(ep, item) : ep.dataloader.getData(ep, item);
+              
+              if (data instanceof Collection)
+              {
+                template.writeCollection(ep, (Collection)data);
+              }
+              else
+              {
+                template.writeProperty(ep, data);
+              }
             }
           }

trunk/src/clients/web/net/sf/basedb/clients/web/plugins/XMLTemplate.java

@@ -24 +24 @@
 import java.io.IOException;
 import java.io.Writer;
+import java.util.Collection;
 import java.util.List;
 import java.util.regex.Pattern;
@@ -138 +139 @@
   /**
     Add the property value to the current item element.
+    @since 2.12
   */
   @SuppressWarnings("unchecked")
@@ -149 +151 @@
   
   /**
+    Add collection values to the current item element.
+   */
+  @Override
+  @SuppressWarnings("unchecked")
+  public void writeCollection(ExportedProperty ep, Collection<?> values)
+    throws IOException
+  {
+    
+    Element property = new Element("property-value");
+    property.setAttribute("ref", ep.name);
+    if (values != null)
+    {
+      for (Object value : values)
+      {
+        Element valueElement = new Element("value");
+        valueElement.setText(escape(ep.formatter.format(value)));
+        property.addContent(valueElement);
+      }
+    }
+    itemElement.addContent(property);
+  }
+  
+  /**
     Write the current item element to the export stream.
   */