svn commit: r903434 - /lucene/mahout/trunk/core/src/main/java/org/apache/mahout/cf/taste/model/IDMigrator.java

[sr...@apache.org]

Author: srowen
Date: Tue Jan 26 21:47:49 2010
New Revision: 903434

URL: http://svn.apache.org/viewvc?rev=903434&view=rev
Log:
Javadoc fix

Modified:
    lucene/mahout/trunk/core/src/main/java/org/apache/mahout/cf/taste/model/IDMigrator.java

Modified: lucene/mahout/trunk/core/src/main/java/org/apache/mahout/cf/taste/model/IDMigrator.java
URL: http://svn.apache.org/viewvc/lucene/mahout/trunk/core/src/main/java/org/apache/mahout/cf/taste/model/IDMigrator.java?rev=903434&r1=903433&r2=903434&view=diff
==============================================================================
--- lucene/mahout/trunk/core/src/main/java/org/apache/mahout/cf/taste/model/IDMigrator.java (original)
+++ lucene/mahout/trunk/core/src/main/java/org/apache/mahout/cf/taste/model/IDMigrator.java Tue Jan 26 21:47:49 2010
@@ -44,7 +44,6 @@
 
   /**
    * @return the top 8 bytes of the MD5 hash of the bytes of the given {@link String}'s UTF-8 encoding as a long.
-   *  The reverse mapping is also stored.
    * @throws TasteException if an error occurs while storing the mapping
    */
   long toLongID(String stringID);
@@ -67,7 +66,8 @@
   void storeMapping(long longID, String stringID) throws TasteException;
 
   /**
-   * Make the mapping aware of the given string IDs.
+   * Make the mapping aware of the given string IDs. This must be called initially before
+   * the implementation is used, or else it will not be aware of reverse long-to-String mappings.
    *
    * @throws TasteException if an error occurs while storing the mappings
    */