Changeset 1509

Timestamp:

19/08/10 14:49:30 (18 months ago)

Author:

Stephen Rankin

Message:

Doc comments update. ref#236.

File:

• trunk/applications/NXconvertpy/src/org/nexusformat/nxvalidate/NXNodeMapper.java (modified) (2 diffs)

trunk/applications/NXconvertpy/src/org/nexusformat/nxvalidate/NXNodeMapper.java

@@ -56 +56 @@
     private NXNodeMapper root = null;
     private File nxsFile = null;
-    private File schematronFile = null;
+    private File nxdlFile = null;
     private File reducedFile = null;
     private File resultsFile = null;
@@ -137 +137 @@
     }
 
-    /*public void insert(NXNodeMapper node) {
-        documents.add(node);
-    }*/
-
+    /**
+     * Get the NXS file belonging to the root node. Any other node should return
+     * null
+     * @return the NXS file as a File object.
+     */
     public File getNXSFile() {
         return nxsFile;
     }
 
-    public File getSchematronFile() {
-        return schematronFile;
-    }
-
-    public void setSchematronFile(File schematronFile) {
-        this.schematronFile = schematronFile;
-    }
-
+    /**
+     * Get the NXDL file belonging to the root node. Any other node should return
+     * null
+     * @return the NXDL file as a File object.
+     */
+    public File getNXDLFile() {
+        return nxdlFile;
+    }
+
+    /**
+     * Set the NXDL file belonging to the root node. Should not be set.
+     * @param the NXDL file as a File object.
+     */
+    public void setNXDLFile(File nxdlFile) {
+        this.nxdlFile = nxdlFile;
+    }
+
+    /**
+     * Get the resultant file produced after NXConvert has been run on the
+     * NXS file
+     * (reduced to XML).
+     * @return the NXConvert reduced file.
+     */
     public File getReducedFile() {
         return reducedFile;
     }
 
+    /**
+     * Set the resultant file produced after NXConvert has been run on the
+     * NXS file.
+     * @param the NXConvert reduced file.
+     */
     public void setReducedFile(File reducedFile) {
         this.reducedFile = reducedFile;
     }
 
+    /**
+     * Get the resultant file produced after the validation procedure has been
+     * performed.
+     * @param the validation results file.
+     */
     public File getResultsFile() {
         return resultsFile;
     }
 
+    /**
+     * Get the resultant file produced after the validation procedure has been
+     * performed.
+     * @param the validation results file.
+     */
     public void setResultsFile(File resultsFile) {
         this.resultsFile = resultsFile;
     }
 
+    /**
+     * Get the resultant DOM document produced after the validation procedure
+     * has been performed.
+     * @return the validation results DOM document.
+     */
     public Document getResultsDoc() {
         return resultsDoc;
     }
 
+    /**
+     * Get the resultant DOM document produced after the validation procedure
+     * has been performed.
+     * @return the validation results DOM document.
+     */
     public void setResultsDoc(Document resultsDoc) {
         this.resultsDoc = resultsDoc;