Changeset 6770 for trunk/gli/src/org/greenstone/gatherer/msm

Timestamp:

2004-02-10T18:07:32+13:00 (20 years ago)

Author:

kjdon

Message:

fixed all the javadoc errors. (hope I didn't commit anything I wasn't supposed to)

Location:

trunk/gli/src/org/greenstone/gatherer/msm

Files:

• LegacyCollectionImporter.java (modified) (1 diff)
• MSMAction.java (modified) (1 diff)
• MSMPrompt.java (modified) (1 diff)
• MSMUtils.java (modified) (1 diff)
• MetadataComboBoxModel.java (modified) (2 diffs)
• MetadataSet.java (modified) (1 diff)
• MetadataSetManager.java (modified) (6 diffs)
• parsers/GreenstoneMetadataParser.java (modified) (1 diff)

trunk/gli/src/org/greenstone/gatherer/msm/LegacyCollectionImporter.java

@@ -108 +108 @@
 
     /** Processes the files in the import tree, editing metadata.xml files so they contain namespaced element names.
-     * @param collection_folder the base folder of this collection, needed for storing importing profiles
      * @param file the current file we are inspecting
      */

trunk/gli/src/org/greenstone/gatherer/msm/MSMAction.java

@@ -60 +60 @@
      * @param action An <i>int</i> representing what action needs to be taken in subsequent access of the given set and source element.
      * @param target A <strong>String</strong> representing the fully qualified name of the target element.
-     * @param hfile If this action was created from the hfile parsing stage, does the element require a replacement to change its alias value into a real one. Note that this profile item may be created for fully namespaced elements as well, to ensure aliases are always remapped.
      */ 
     public MSMAction(int action, String target) {

trunk/gli/src/org/greenstone/gatherer/msm/MSMPrompt.java

@@ -659 +659 @@
     /** Prompts the user to choose how to import a metadata element. Gives the option of renaming the element to a certain value of a certain set, or adding to a selected set.
      * @param name The name of the original metadata as a String.
-     * @param set The set previously choosen as the default set for this metadata (which it doesn't match somehow).
      * @return An ElementWrapper around the element that it has been matched to.
      * @see org.greenstone.gatherer.msm.MSMPrompt.MSMDialog

trunk/gli/src/org/greenstone/gatherer/msm/MSMUtils.java

@@ -224 +224 @@
     /** Method to compare two metadata elements (of type Element, which is bound to get more than a bit confusing) for equality. This test may only check the structural (ie pretty much unchanging) consistancy, or may include the AssignedValue tree as well (which will be different for each collection I'd imagine).
      * @param a_set The <strong>MetadataSet</strong> a comes from.
-     * @param a An <strong>Element</strong>.
+     * @param ae An <strong>Element</strong>.
      * @param b_set The <strong>MetadataSet</strong> b comes from.
-     * @param b The <strong>Element</strong> to compare it to.
+     * @param be The <strong>Element</strong> to compare it to.
      * @param values <i>true</i> if the AssignedValues tree should also be compared, <i>false</i> otherwise.
      * @return <i>true</i> if the elements are equal, <i>false</i> otherwise.

trunk/gli/src/org/greenstone/gatherer/msm/MetadataComboBoxModel.java

@@ -44 +44 @@
 import org.w3c.dom.*;
 
-/** A combobox model that contains information from an array of NodeLists. */
+/** A combobox model that contains information from the metadata set manager.
+ * @see org.greenstone.gatherer.msm.MetadataSetManager*/
 public class MetadataComboBoxModel
     extends DefaultComboBoxModel 
@@ -50 +51 @@
     private MetadataSetManager msm = null;
     /** Constructor.
-     * @param nodelists The <strong>NodeList[]</strong> this model is proxied to.
+     * @param msm The <strong>MetadataSetManager</strong> this model is proxied to.
      */
     public MetadataComboBoxModel(MetadataSetManager msm) {

trunk/gli/src/org/greenstone/gatherer/msm/MetadataSet.java

@@ -552 +552 @@
      * @see org.greenstone.gatherer.Configuration#getLanguage()
      * @see org.greenstone.gatherer.Gatherer#config
-     * @see org.greenstone.gatherer.msm.MSMUtils#getValue(Element)
+     * @see org.greenstone.gatherer.msm.MSMUtils#getValue(Node)
      * @see org.greenstone.gatherer.util.StaticStrings#CODE_ATTRIBUTE
      * @see org.greenstone.gatherer.util.StaticStrings#SETLANGUAGE_ELEMENT

trunk/gli/src/org/greenstone/gatherer/msm/MetadataSetManager.java

@@ -100 +100 @@
 
     /** Attach a piece of metadata to a record or records, ensuring the value tree is built properly, and correct messaging fired.
+     * @param id
      * @param records A FileNode[] of records, or directories, to add the specified metadata to.
      * @param element The metadata element, contained within an ElementWrapper to base metadata on.
-     * @param value The value to assign to the metadata as a String.
+     * @param value_str The value to assign to the metadata as a String.
      */
     public Metadata addMetadata(long id, FileNode records[], ElementWrapper element, String value_str) {
@@ -169 +170 @@
     }
 
-    /** Add a value tree to a given metadata element.
-     * @param element The ElementWrapper containing the element you wish to add a value tree for.
-     * @param value_tree The root Element of the value tree.
+    /** Add a value tree to a given metadata element represented as a GValueModel
+     * @param model The <strong>GValueTree</strong> model
      */
     public void addValueTree(GValueModel model) {
@@ -686 +686 @@
     }
     /** This method takes two metadata sets, the current one and a new one, and merges them. This merge takes place at an element level falling to lower levels as necessary (using <i>mergeMDE()</i> to merge elements and <i>mergeMDV()</i> to merge value trees.
-     * @param mds_current The currently loaded MetadataSet.
+     * @param mds_cur The currently loaded MetadataSet.
      * @param mds_new A new MetadataSet you wish to merge in.
      * @return A boolean with value <i>true</i> indicating if the merge was successful, otherwise <i>false</i> if errors were detected.
@@ -1041 +1041 @@
 
     /** Update a piece of metadata connected to a record or records, ensuring the value tree is built properly, and correct messaging fired.
+     * @param id
+     * @param old_metadata The metadata element,
      * @param records A FileNode[] of records, or directories, to add the specified metadata to.
-     * @param element The metadata element, contained within an ElementWrapper to base metadata on.
-     * @param value The value to assign to the metadata as a String.
+     * @param value_str The value to assign to the metadata as a String.
      * @param action The default action to take in the prompt.
      * @param file_level If true then the metadata can be replaced normally, if false then we should actually use an add method instead.
@@ -1092 +1093 @@
      * @param data the new Metadata.
      * @param action the default action as an int. May require user interaction.
-     * @param fire_event <i>true</i> if this action should fire a metadata changed event, <i>false</i> if we are calling this as an affect of a previous event. (Don't want an infinitely recursive loop, do we).
      * @param multiple_selection <i>true</i> if more than one file or folder was selected.
      * @return an int specifying the current action. Thus changes in lower parts of the tree continue to effect other disjoint subtrees.
@@ -1194 +1194 @@
      * @param data the <strong>Metadata</strong> you wish removed from the tree.
      * @param action an <i>int</i> specifying the wanted prompting action.
-     * @param fire_event <i>true</i> if this action should fire metadata changed events.
      * @param multiple_selection the number of records in the selection, as an <i>int</i>. Used to determine prompt controls.
      * @return an <i>int</i> specifying the current action. Thus changes in lower parts of the tree continue to effect other disjoint subtrees.

trunk/gli/src/org/greenstone/gatherer/msm/parsers/GreenstoneMetadataParser.java

@@ -688 +688 @@
     extends LinkedHashMap {
     /** Retrieve the CollectCFG object that matches the given collection file path.
-     * @param collection_file The <strong>File</strong> that references the collection's directory.
+     * @param collect_cfg_file The <strong>File</strong> that references the collection's directory.
      * @return The <strong>CollectCFG</strong> that belongs to this collection, or <i>null</i> if no such file exists (so we probably aren't in a collection!).
      */