1 // Copyright 2011 Google Inc. All Rights Reserved.
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
7 // http://www.apache.org/licenses/LICENSE-2.0
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
19 package com.hughes.android.dictionary.engine;
21 import com.hughes.android.dictionary.DictionaryInfo;
22 import com.hughes.android.dictionary.DictionaryInfo.IndexInfo;
23 import com.hughes.android.dictionary.engine.RowBase.RowKey;
24 import com.hughes.util.CachingList;
25 import com.hughes.util.StringUtil;
26 import com.hughes.util.TransformingList;
27 import com.hughes.util.raf.RAFList;
28 import com.hughes.util.raf.RAFSerializable;
29 import com.hughes.util.raf.RAFSerializer;
30 import com.hughes.util.raf.SerializableSerializer;
31 import com.hughes.util.raf.UniformRAFList;
32 import com.ibm.icu.text.Collator;
33 import com.ibm.icu.text.Transliterator;
35 import java.io.DataInput;
36 import java.io.DataOutput;
37 import java.io.IOException;
38 import java.io.PrintStream;
39 import java.io.RandomAccessFile;
40 import java.util.AbstractList;
41 import java.util.ArrayList;
42 import java.util.Collection;
43 import java.util.Collections;
44 import java.util.Comparator;
45 import java.util.EnumMap;
46 import java.util.HashSet;
47 import java.util.LinkedHashMap;
48 import java.util.LinkedHashSet;
49 import java.util.List;
52 import java.util.concurrent.atomic.AtomicBoolean;
53 import java.util.regex.Pattern;
55 public final class Index implements RAFSerializable<Index> {
57 static final int CACHE_SIZE = 5000;
59 public final Dictionary dict;
61 public final String shortName; // Typically the ISO code for the language.
62 public final String longName;
64 // persisted: tells how the entries are sorted.
65 public final Language sortLanguage;
66 final String normalizerRules;
68 // Built from the two above.
69 private Transliterator normalizer;
72 public final List<IndexEntry> sortedIndexEntries;
75 public final Set<String> stoplist;
80 public final List<RowBase> rows;
81 public final boolean swapPairEntries;
84 int mainTokenCount = -1;
86 // --------------------------------------------------------------------------
88 public Index(final Dictionary dict, final String shortName, final String longName,
89 final Language sortLanguage, final String normalizerRules,
90 final boolean swapPairEntries, final Set<String> stoplist) {
92 this.shortName = shortName;
93 this.longName = longName;
94 this.sortLanguage = sortLanguage;
95 this.normalizerRules = normalizerRules;
96 this.swapPairEntries = swapPairEntries;
97 sortedIndexEntries = new ArrayList<IndexEntry>();
98 this.stoplist = stoplist;
99 rows = new ArrayList<RowBase>();
105 * Deferred initialization because it can be slow.
107 public synchronized Transliterator normalizer() {
108 if (normalizer == null) {
109 normalizer = Transliterator
110 .createFromRules("", normalizerRules, Transliterator.FORWARD);
116 * Note that using this comparator probably involves doing too many text
119 public NormalizeComparator getSortComparator() {
120 return new NormalizeComparator(normalizer(), sortLanguage.getCollator());
123 public Index(final Dictionary dict, final DataInput inp) throws IOException {
125 RandomAccessFile raf = (RandomAccessFile)inp;
126 shortName = raf.readUTF();
127 longName = raf.readUTF();
128 final String languageCode = raf.readUTF();
129 sortLanguage = Language.lookup(languageCode);
130 normalizerRules = raf.readUTF();
131 swapPairEntries = raf.readBoolean();
132 if (sortLanguage == null) {
133 throw new IOException("Unsupported language: " + languageCode);
135 if (dict.dictFileVersion >= 2) {
136 mainTokenCount = raf.readInt();
138 sortedIndexEntries = CachingList.create(
139 RAFList.create(raf, indexEntrySerializer, raf.getFilePointer(), dict.dictFileVersion,
140 dict.dictFileVersion >= 7 ? 16 : 1, dict.dictFileVersion >= 7), CACHE_SIZE);
141 if (dict.dictFileVersion >= 7) {
142 int count = StringUtil.readVarInt(raf);
143 stoplist = new HashSet<String>(count);
144 for (int i = 0; i < count; ++i) {
145 stoplist.add(raf.readUTF());
147 } else if (dict.dictFileVersion >= 4) {
148 stoplist = new SerializableSerializer<Set<String>>().read(raf);
150 stoplist = Collections.emptySet();
152 rows = CachingList.create(
153 UniformRAFList.create(raf, new RowBase.Serializer(this), raf.getFilePointer()),
158 public void write(final DataOutput out) throws IOException {
159 RandomAccessFile raf = (RandomAccessFile)out;
160 raf.writeUTF(shortName);
161 raf.writeUTF(longName);
162 raf.writeUTF(sortLanguage.getIsoCode());
163 raf.writeUTF(normalizerRules);
164 raf.writeBoolean(swapPairEntries);
165 if (dict.dictFileVersion >= 2) {
166 raf.writeInt(mainTokenCount);
168 RAFList.write(raf, sortedIndexEntries, indexEntrySerializer, 16, true);
169 StringUtil.writeVarInt(raf, stoplist.size());
170 for (String i : stoplist) {
173 UniformRAFList.write(raf, rows, new RowBase.Serializer(this), 3 /* bytes per entry */);
176 public void print(final PrintStream out) {
177 for (final RowBase row : rows) {
182 private final RAFSerializer<IndexEntry> indexEntrySerializer = new RAFSerializer<IndexEntry>() {
184 public IndexEntry read(DataInput raf) throws IOException {
185 return new IndexEntry(Index.this, raf);
189 public void write(DataOutput raf, IndexEntry t) throws IOException {
194 public static final class IndexEntry implements RAFSerializable<Index.IndexEntry> {
195 private final Index index;
196 public final String token;
197 private final String normalizedToken;
198 public final int startRow;
199 public final int numRows; // doesn't count the token row!
200 public List<HtmlEntry> htmlEntries;
201 private int[] htmlEntryIndices;
203 public IndexEntry(final Index index, final String token, final String normalizedToken,
204 final int startRow, final int numRows) {
206 assert token.equals(token.trim());
207 assert token.length() > 0;
209 this.normalizedToken = normalizedToken;
210 this.startRow = startRow;
211 this.numRows = numRows;
212 this.htmlEntries = new ArrayList<HtmlEntry>();
215 public IndexEntry(final Index index, final DataInput raf) throws IOException {
217 token = raf.readUTF();
218 if (index.dict.dictFileVersion >= 7) {
219 startRow = StringUtil.readVarInt(raf);
220 numRows = StringUtil.readVarInt(raf);
222 startRow = raf.readInt();
223 numRows = raf.readInt();
225 final boolean hasNormalizedForm = raf.readBoolean();
226 normalizedToken = hasNormalizedForm ? raf.readUTF() : token;
227 htmlEntryIndices = null;
228 if (index.dict.dictFileVersion >= 7) {
229 int size = StringUtil.readVarInt(raf);
230 htmlEntryIndices = new int[size];
231 for (int i = 0; i < size; ++i) {
232 htmlEntryIndices[i] = StringUtil.readVarInt(raf);
234 this.htmlEntries = CachingList.create(new AbstractList<HtmlEntry>() {
236 public HtmlEntry get(int i) {
237 return index.dict.htmlEntries.get(htmlEntryIndices[i]);
241 return htmlEntryIndices.length;
244 } else if (index.dict.dictFileVersion >= 6) {
245 this.htmlEntries = CachingList.create(
246 RAFList.create((RandomAccessFile)raf, index.dict.htmlEntryIndexSerializer,
247 ((RandomAccessFile)raf).getFilePointer(), index.dict.dictFileVersion), 1);
249 this.htmlEntries = Collections.emptyList();
253 public void write(DataOutput raf) throws IOException {
255 StringUtil.writeVarInt(raf, startRow);
256 StringUtil.writeVarInt(raf, numRows);
257 final boolean hasNormalizedForm = !token.equals(normalizedToken);
258 raf.writeBoolean(hasNormalizedForm);
259 if (hasNormalizedForm) {
260 raf.writeUTF(normalizedToken);
262 StringUtil.writeVarInt(raf, htmlEntries.size());
263 for (HtmlEntry e : htmlEntries)
264 StringUtil.writeVarInt(raf, e.index());
267 public String toString() {
268 return String.format("%s@%d(%d)", token, startRow, numRows);
271 public String normalizedToken() {
272 return normalizedToken;
276 static final TransformingList.Transformer<IndexEntry, String> INDEX_ENTRY_TO_TOKEN = new TransformingList.Transformer<IndexEntry, String>() {
278 public String transform(IndexEntry t1) {
283 public IndexEntry findExact(final String exactToken) {
284 final int result = Collections.binarySearch(
285 TransformingList.create(sortedIndexEntries, INDEX_ENTRY_TO_TOKEN), exactToken,
286 getSortComparator());
288 return sortedIndexEntries.get(result);
293 public IndexEntry findInsertionPoint(String token, final AtomicBoolean interrupted) {
294 final int index = findInsertionPointIndex(token, interrupted);
295 return index != -1 ? sortedIndexEntries.get(index) : null;
298 public int findInsertionPointIndex(String token, final AtomicBoolean interrupted) {
299 token = normalizeToken(token);
302 int end = sortedIndexEntries.size();
304 final Comparator sortCollator = sortLanguage.getCollator();
305 while (start < end) {
306 final int mid = (start + end) / 2;
307 if (interrupted.get()) {
310 final IndexEntry midEntry = sortedIndexEntries.get(mid);
312 final int comp = sortCollator.compare(token, midEntry.normalizedToken());
314 final int result = windBackCase(token, mid, interrupted);
316 } else if (comp < 0) {
317 // System.out.println("Upper bound: " + midEntry + ", norm=" +
318 // midEntry.normalizedToken() + ", mid=" + mid);
321 // System.out.println("Lower bound: " + midEntry + ", norm=" +
322 // midEntry.normalizedToken() + ", mid=" + mid);
327 // If we search for a substring of a string that's in there, return
329 int result = Math.min(start, sortedIndexEntries.size() - 1);
330 result = windBackCase(sortedIndexEntries.get(result).normalizedToken(), result, interrupted);
334 private final int windBackCase(final String token, int result, final AtomicBoolean interrupted) {
335 while (result > 0 && sortedIndexEntries.get(result - 1).normalizedToken().equals(token)) {
337 if (interrupted.get()) {
344 public IndexInfo getIndexInfo() {
345 return new DictionaryInfo.IndexInfo(shortName, sortedIndexEntries.size(), mainTokenCount);
348 private static final int MAX_SEARCH_ROWS = 1000;
350 private final Map<String, Integer> prefixToNumRows = new LinkedHashMap<String, Integer>();
352 private synchronized final int getUpperBoundOnRowsStartingWith(final String normalizedPrefix,
353 final int maxRows, final AtomicBoolean interrupted) {
354 final Integer numRows = prefixToNumRows.get(normalizedPrefix);
355 if (numRows != null) {
358 final int insertionPointIndex = findInsertionPointIndex(normalizedPrefix, interrupted);
361 for (int index = insertionPointIndex; index < sortedIndexEntries.size(); ++index) {
362 if (interrupted.get()) {
365 final IndexEntry indexEntry = sortedIndexEntries.get(index);
366 if (!indexEntry.normalizedToken.startsWith(normalizedPrefix)) {
369 rowCount += indexEntry.numRows + indexEntry.htmlEntries.size();
370 if (rowCount > maxRows) {
371 System.out.println("Giving up, too many words with prefix: " + normalizedPrefix);
375 prefixToNumRows.put(normalizedPrefix, numRows);
379 public final List<RowBase> multiWordSearch(
380 final String searchText, final List<String> searchTokens,
381 final AtomicBoolean interrupted) {
382 final long startMills = System.currentTimeMillis();
383 final List<RowBase> result = new ArrayList<RowBase>();
385 final Set<String> normalizedNonStoplist = new LinkedHashSet<String>();
387 String bestPrefix = null;
388 int leastRows = Integer.MAX_VALUE;
389 final StringBuilder searchTokensRegex = new StringBuilder();
390 for (int i = 0; i < searchTokens.size(); ++i) {
391 if (interrupted.get()) {
394 final String searchToken = searchTokens.get(i);
395 final String normalized = normalizeToken(searchTokens.get(i));
396 // Normalize them all.
397 searchTokens.set(i, normalized);
399 if (!stoplist.contains(searchToken)) {
400 if (normalizedNonStoplist.add(normalized)) {
401 final int numRows = getUpperBoundOnRowsStartingWith(normalized,
402 MAX_SEARCH_ROWS, interrupted);
403 if (numRows != -1 && numRows < leastRows) {
405 // We really are done here.
406 return Collections.emptyList();
409 bestPrefix = normalized;
414 if (searchTokensRegex.length() > 0) {
415 searchTokensRegex.append("[\\s]*");
417 searchTokensRegex.append(Pattern.quote(normalized));
419 final Pattern pattern = Pattern.compile(searchTokensRegex.toString());
421 if (bestPrefix == null) {
422 bestPrefix = searchTokens.get(0);
423 System.out.println("Everything was in the stoplist!");
425 System.out.println("Searching using prefix: " + bestPrefix + ", leastRows=" + leastRows
426 + ", searchTokens=" + searchTokens);
428 // Place to store the things that match.
429 final Map<RowMatchType, List<RowBase>> matches = new EnumMap<RowMatchType, List<RowBase>>(
431 for (final RowMatchType rowMatchType : RowMatchType.values()) {
432 if (rowMatchType != RowMatchType.NO_MATCH) {
433 matches.put(rowMatchType, new ArrayList<RowBase>());
439 final int exactMatchIndex = findInsertionPointIndex(searchText, interrupted);
440 if (exactMatchIndex != -1) {
441 final IndexEntry exactMatch = sortedIndexEntries.get(exactMatchIndex);
442 if (pattern.matcher(exactMatch.token).find()) {
443 matches.get(RowMatchType.TITLE_MATCH).add(rows.get(exactMatch.startRow));
447 final String searchToken = bestPrefix;
448 final int insertionPointIndex = findInsertionPointIndex(searchToken, interrupted);
449 final Set<RowKey> rowsAlreadySeen = new HashSet<RowBase.RowKey>();
450 for (int index = insertionPointIndex; index < sortedIndexEntries.size()
451 && matchCount < MAX_SEARCH_ROWS; ++index) {
452 if (interrupted.get()) {
455 final IndexEntry indexEntry = sortedIndexEntries.get(index);
456 if (!indexEntry.normalizedToken.startsWith(searchToken)) {
460 // System.out.println("Searching indexEntry: " + indexEntry.token);
462 // Extra +1 to skip token row.
463 for (int rowIndex = indexEntry.startRow + 1; rowIndex < indexEntry.startRow + 1
465 && rowIndex < rows.size(); ++rowIndex) {
466 if (interrupted.get()) {
469 final RowBase row = rows.get(rowIndex);
470 final RowBase.RowKey rowKey = row.getRowKey();
471 if (rowsAlreadySeen.contains(rowKey)) {
474 rowsAlreadySeen.add(rowKey);
475 final RowMatchType matchType = row.matches(searchTokens, pattern, normalizer(),
477 if (matchType != RowMatchType.NO_MATCH) {
478 matches.get(matchType).add(row);
485 // Sort them into a reasonable order.
486 final RowBase.LengthComparator lengthComparator = new RowBase.LengthComparator(
488 for (final Collection<RowBase> rows : matches.values()) {
489 final List<RowBase> ordered = new ArrayList<RowBase>(rows);
490 Collections.sort(ordered, lengthComparator);
491 result.addAll(ordered);
494 System.out.println("searchDuration: " + (System.currentTimeMillis() - startMills));
498 private String normalizeToken(final String searchToken) {
499 if (TransliteratorManager.init(null)) {
500 final Transliterator normalizer = normalizer();
501 return normalizer.transliterate(searchToken);
503 // Do our best since the Transliterators aren't up yet.
504 return searchToken.toLowerCase();