Changeset 260

Timestamp:

03/15/08 12:27:06 (4 years ago)

Author:

kasper

Message:

Added javadoc and cobertura reporting to BirtReportPortlet

Location:

portlets/BirtReportPortlet/trunk/src/main/java/dk/eobjects/portlets/birt

Files:

• Constants.java (modified) (1 diff)
• controller/ViewReports.java (modified) (1 diff)
• helpers/LabelContainerComparator.java (modified) (1 diff)
• helpers/PreferencesValidator.java (modified) (1 diff)
• helpers/ReportFileFilter.java (modified) (1 diff)
• model/LabelContainer.java (modified) (1 diff)
• model/Report.java (modified) (1 diff)
• model/ReportDirectory.java (modified) (1 diff)

portlets/BirtReportPortlet/trunk/src/main/java/dk/eobjects/portlets/birt/Constants.java

@@ -17 +17 @@
 package dk.eobjects.portlets.birt;
 
+/**
+ * Constants used throughout the portlet
+ * 
+ * @author kasper
+ */
 public interface Constants {
-        
+
         public static final String REPORT_SUFFIX = ".rptdesign";
 

portlets/BirtReportPortlet/trunk/src/main/java/dk/eobjects/portlets/birt/controller/ViewReports.java

@@ -32 +32 @@
 import dk.eobjects.portlets.birt.model.ReportDirectory;
 
+/**
+ * Controller for viewing/browsing reports in a directory.
+ * 
+ * @author kasper
+ */
 public class ViewReports extends AbstractController {
 

portlets/BirtReportPortlet/trunk/src/main/java/dk/eobjects/portlets/birt/helpers/LabelContainerComparator.java

@@ -21 +21 @@
 import dk.eobjects.portlets.birt.model.LabelContainer;
 
+/**
+ * Comparator for <code>LabelContainer</code> objects
+ * 
+ * @author kasper
+ */
 public class LabelContainerComparator implements Comparator<LabelContainer> {
 

portlets/BirtReportPortlet/trunk/src/main/java/dk/eobjects/portlets/birt/helpers/PreferencesValidator.java

@@ -24 +24 @@
 import dk.eobjects.portlets.birt.Constants;
 
+/**
+ * Validates the preferences of the porlet
+ * 
+ * @author kasper
+ */
 public class PreferencesValidator implements javax.portlet.PreferencesValidator {
 

portlets/BirtReportPortlet/trunk/src/main/java/dk/eobjects/portlets/birt/helpers/ReportFileFilter.java

@@ -22 +22 @@
 import dk.eobjects.portlets.birt.Constants;
 
+/**
+ * File filter for finding report files
+ * 
+ * @author kasper
+ */
 public class ReportFileFilter implements FileFilter {
 
         public boolean accept(File file) {
-                if (file.isFile() && file.getName().endsWith(Constants.REPORT_SUFFIX) && !file.isHidden()) {
+                if (file.isFile() && file.getName().endsWith(Constants.REPORT_SUFFIX)
+                                && !file.isHidden()) {
                         return true;
                 }

portlets/BirtReportPortlet/trunk/src/main/java/dk/eobjects/portlets/birt/model/LabelContainer.java

@@ -17 +17 @@
 package dk.eobjects.portlets.birt.model;
 
+/**
+ * Defines an interface for objects which can be shown in the UI with a label
+ * 
+ * @author kasper
+ */
 public interface LabelContainer extends Comparable<LabelContainer> {
 

portlets/BirtReportPortlet/trunk/src/main/java/dk/eobjects/portlets/birt/model/Report.java

@@ -22 +22 @@
 import dk.eobjects.portlets.birt.helpers.LabelContainerComparator;
 
+/**
+ * Represents a report file
+ * 
+ * @author kasper
+ */
 public class Report implements LabelContainer {
 

portlets/BirtReportPortlet/trunk/src/main/java/dk/eobjects/portlets/birt/model/ReportDirectory.java

@@ -27 +27 @@
 import dk.eobjects.portlets.birt.helpers.ReportFileFilter;
 
+/**
+ * Represents a directory containing reports
+ * 
+ * @author kasper
+ */
 public class ReportDirectory implements LabelContainer {