文档

Author: hankcs

src/main/java/com/hankcs/hanlp/dictionary/common/CommonDictionary.java

@@ -34,8 +34,20 @@ public abstract class CommonDictionary<V>
 {
     DoubleArrayTrie<V> trie;
 
+    /**
+     * 从字节中加载值数组
+     *
+     * @param byteArray
+     * @return
+     */
     protected abstract V[] loadValueArray(ByteArray byteArray);
 
+    /**
+     * 从txt路径加载
+     *
+     * @param path
+     * @return
+     */
     public boolean load(String path)
     {
         trie = new DoubleArrayTrie<V>();
@@ -60,6 +72,7 @@ public boolean load(String path)
         {
             logger.warning("读取" + path + "失败" + e);
         }
+        onLoaded(map);
         Set<Map.Entry<String, V>> entrySet = map.entrySet();
         List<String> keyList = new ArrayList<String>(entrySet.size());
         List<V> valueList = new ArrayList<V>(entrySet.size());
@@ -79,6 +92,12 @@ public boolean load(String path)
         return true;
     }
 
+    /**
+     * 从dat路径加载
+     *
+     * @param byteArray
+     * @return
+     */
     protected boolean loadDat(ByteArray byteArray)
     {
         V[] valueArray = loadValueArray(byteArray);
@@ -89,6 +108,13 @@ protected boolean loadDat(ByteArray byteArray)
         return trie.load(byteArray, valueArray);
     }
 
+    /**
+     * 保存dat到路径
+     *
+     * @param path
+     * @param valueArray
+     * @return
+     */
     protected boolean saveDat(String path, List<V> valueArray)
     {
         try
@@ -110,6 +136,13 @@ protected boolean saveDat(String path, List<V> valueArray)
         return true;
     }
 
+    /**
+     * 保存单个值到流中
+     *
+     * @param value
+     * @param out
+     * @throws IOException
+     */
     protected abstract void saveValue(V value, DataOutputStream out) throws IOException;
 
     /**
@@ -144,5 +177,20 @@ public int size()
         return trie.size();
     }
 
+    /**
+     * 从一行词典条目创建值
+     *
+     * @param params 第一个元素为键，请注意跳过
+     * @return
+     */
     protected abstract V createValue(String[] params);
+
+    /**
+     * 文本词典加载完毕的回调函数
+     *
+     * @param map
+     */
+    protected void onLoaded(TreeMap<String, V> map)
+    {
+    }
 }

src/main/java/com/hankcs/hanlp/dictionary/common/EnumItemDictionary.java

@@ -18,6 +18,8 @@
 import java.util.Map;
 
 /**
+ * 枚举条目的通用词典（类似C++的模板，然而Java并没有模板机制，所以有几个方法需要子类啰嗦一下）
+ *
  * @author hankcs
  */
 public abstract class EnumItemDictionary<E extends Enum<E>> extends CommonDictionary<EnumItem<E>>
@@ -34,10 +36,26 @@ protected EnumItem<E> createValue(String[] params)
         return nrEnumItem;
     }
 
+    /**
+     * 代理E.valueOf
+     *
+     * @param name
+     * @return
+     */
     protected abstract E valueOf(String name);
 
+    /**
+     * 代理E.values
+     *
+     * @return
+     */
     protected abstract E[] values();
 
+    /**
+     * 代理new EnumItem<E>
+     *
+     * @return
+     */
     protected abstract EnumItem<E> newItem();
 
     @Override

src/main/java/com/hankcs/hanlp/dictionary/nr/NRDictionary.java

@@ -16,6 +16,8 @@
 import com.hankcs.hanlp.corpus.tag.NR;
 import com.hankcs.hanlp.dictionary.common.EnumItemDictionary;
 
+import java.util.TreeMap;
+
 /**
  * 一个好用的人名词典
  *
@@ -41,4 +43,10 @@ protected EnumItem<NR> newItem()
     {
         return new EnumItem<NR>();
     }
+
+    @Override
+    protected void onLoaded(TreeMap<String, EnumItem<NR>> map)
+    {
+        map.put(" ", new EnumItem<NR>(NR.K, NR.A)); // txt中不允许出现空格词条，这里补上
+    }
 }