Major refactor of down dictionary list is stored by app.

[Dictionary.git] / src / com / hughes / android / dictionary / engine / Dictionary.java

diff --git a/src/com/hughes/android/dictionary/engine/Dictionary.java b/src/com/hughes/android/dictionary/engine/Dictionary.java
index 26dae916630924bb595104949c0431d05f0f616c..245f138a6f5a7c60645d1be2ec0b9dc4049c7bf5 100644 (file)
--- a/src/com/hughes/android/dictionary/engine/Dictionary.java
+++ b/src/com/hughes/android/dictionary/engine/Dictionary.java
@@ -1,11 +1,27 @@
+// Copyright 2011 Google Inc. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package com.hughes.android.dictionary.engine;
 
+import java.io.File;
 import java.io.IOException;
 import java.io.PrintStream;
 import java.io.RandomAccessFile;
 import java.util.ArrayList;
 import java.util.List;
 
+import com.hughes.android.dictionary.DictionaryInfo;
 import com.hughes.util.CachingList;
 import com.hughes.util.raf.RAFList;
 import com.hughes.util.raf.RAFListSerializer;
@@ -16,14 +32,29 @@ public class Dictionary implements RAFSerializable<Dictionary> {
   
   static final int CACHE_SIZE = 5000;
   
+  static final int CURRENT_DICT_VERSION = 3;
+  static final String END_OF_DICTIONARY = "END OF DICTIONARY";
+  
   // persisted
-  final String dictInfo;
-  final List<PairEntry> pairEntries;
-  final List<TextEntry> textEntries;
-  final List<EntrySource> sources;
-  final List<Index> indices;
+  final int dictFileVersion;
+  final long creationMillis;
+  public final String dictInfo;
+  public final List<PairEntry> pairEntries;
+  public final List<TextEntry> textEntries;
+  public final List<EntrySource> sources;
+  public final List<Index> indices;
+  
+  /**
+   * dictFileVersion 1 adds:
+   * <li> links to sources?
+   * 
+   * dictFileVersion 2 adds:
+   * <li> counts of tokens in indices.
+   */
   
   public Dictionary(final String dictInfo) {
+    this.dictFileVersion = CURRENT_DICT_VERSION;
+    this.creationMillis = System.currentTimeMillis();
     this.dictInfo = dictInfo;
     pairEntries = new ArrayList<PairEntry>();
     textEntries = new ArrayList<TextEntry>();
@@ -32,28 +63,37 @@ public class Dictionary implements RAFSerializable<Dictionary> {
   }
 
   public Dictionary(final RandomAccessFile raf) throws IOException {
+    dictFileVersion = raf.readInt();
+    if (dictFileVersion < 0 || dictFileVersion > CURRENT_DICT_VERSION) {
+      throw new IOException("Invalid dictionary version: " + dictFileVersion);
+    }
+    creationMillis = raf.readLong();
     dictInfo = raf.readUTF();
-    sources = CachingList.createFullyCached(RAFList.create(raf, EntrySource.SERIALIZER, raf.getFilePointer()));
-    pairEntries = CachingList.create(RAFList.create(raf, PairEntry.SERIALIZER, raf.getFilePointer()), CACHE_SIZE);
-    textEntries = CachingList.create(RAFList.create(raf, TextEntry.SERIALIZER, raf.getFilePointer()), CACHE_SIZE);
+    
+    // Load the sources, then seek past them, because reading them later disrupts the offset.
+    final RAFList<EntrySource> rafSources = RAFList.create(raf, new EntrySource.Serializer(this), raf.getFilePointer());
+    sources = new ArrayList<EntrySource>(rafSources);
+    raf.seek(rafSources.getEndOffset());
+    
+    pairEntries = CachingList.create(RAFList.create(raf, new PairEntry.Serializer(this), raf.getFilePointer()), CACHE_SIZE);
+    textEntries = CachingList.create(RAFList.create(raf, new TextEntry.Serializer(this), raf.getFilePointer()), CACHE_SIZE);
     indices = CachingList.createFullyCached(RAFList.create(raf, indexSerializer, raf.getFilePointer()));
-  }
-  
-  public void print(final PrintStream out) {
-    out.println("dictInfo=" + dictInfo);
-    for (final Index index : indices) {
-      index.print(out);
-      out.println();
+    final String end = raf.readUTF(); 
+    if (!end.equals(END_OF_DICTIONARY)) {
+      throw new IOException("Dictionary seems corrupt: " + end);
     }
   }
-
+  
   @Override
   public void write(RandomAccessFile raf) throws IOException {
+    raf.writeInt(dictFileVersion);
+    raf.writeLong(creationMillis);
     raf.writeUTF(dictInfo);
-    RAFList.write(raf, sources, EntrySource.SERIALIZER);
-    RAFList.write(raf, pairEntries, PairEntry.SERIALIZER);
-    RAFList.write(raf, textEntries, TextEntry.SERIALIZER);
+    RAFList.write(raf, sources, new EntrySource.Serializer(this));
+    RAFList.write(raf, pairEntries, new PairEntry.Serializer(this));
+    RAFList.write(raf, textEntries, new TextEntry.Serializer(this));
     RAFList.write(raf, indices, indexSerializer);
+    raf.writeUTF(END_OF_DICTIONARY);
   }
 
   private final RAFListSerializer<Index> indexSerializer = new RAFListSerializer<Index>() {
@@ -65,5 +105,49 @@ public class Dictionary implements RAFSerializable<Dictionary> {
     public void write(RandomAccessFile raf, Index t) throws IOException {
       t.write(raf);
     }};
+    
+    public void print(final PrintStream out) {
+      out.println("dictInfo=" + dictInfo);
+      for (final EntrySource entrySource : sources) {
+        out.printf("EntrySource: %s %d\n", entrySource.name, entrySource.numEntries);
+      }
+      out.println();
+      for (final Index index : indices) {
+        out.printf("Index: %s %s\n", index.shortName, index.longName);
+        index.print(out);
+        out.println();
+      }
+    }
+
+    public DictionaryInfo getDictionaryInfo() {
+      final DictionaryInfo result = new DictionaryInfo();
+      result.creationMillis = this.creationMillis;
+      result.dictInfo = this.dictInfo;
+      for (final Index index : indices) {
+        result.indexInfos.add(index.getIndexInfo());
+      }
+      return result;
+    }
+    
+    public static DictionaryInfo getDictionaryInfo(final File file) {
+      RandomAccessFile raf = null;
+      try {
+        raf = new RandomAccessFile(file, "r");
+        final Dictionary dict = new Dictionary(raf);
+        final DictionaryInfo dictionaryInfo = dict.getDictionaryInfo();
+        raf.close();
+        return dictionaryInfo;
+      } catch (IOException e) {
+        return null;
+      } finally {
+        if (raf != null) {
+          try {
+            raf.close();
+          } catch (IOException e) {
+            e.printStackTrace();
+          }
+        }
+      }
+    }
 
 }
\ No newline at end of file