1 /*******************************************************************************
2 * Copyright (c) 2007, 2015 Association for Decentralized Information Management
4 * All rights reserved. This program and the accompanying materials
5 * are made available under the terms of the Eclipse Public License v1.0
6 * which accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
10 * VTT Technical Research Centre of Finland - initial API and implementation
11 * Semantum Oy - Fix for simantics issue #6053
12 *******************************************************************************/
13 package org.simantics.db.indexing;
15 import java.io.IOException;
16 import java.nio.file.Files;
17 import java.nio.file.Path;
18 import java.util.ArrayList;
19 import java.util.Collection;
20 import java.util.Collections;
21 import java.util.Iterator;
22 import java.util.List;
24 import java.util.concurrent.CompletableFuture;
25 import java.util.concurrent.Semaphore;
26 import java.util.concurrent.atomic.AtomicReference;
28 import org.apache.lucene.document.Document;
29 import org.apache.lucene.document.DocumentStoredFieldVisitor;
30 import org.apache.lucene.document.Field;
31 import org.apache.lucene.document.FieldType;
32 import org.apache.lucene.document.LongField;
33 import org.apache.lucene.document.TextField;
34 import org.apache.lucene.index.CorruptIndexException;
35 import org.apache.lucene.index.DirectoryReader;
36 import org.apache.lucene.index.FieldInfo;
37 import org.apache.lucene.index.IndexNotFoundException;
38 import org.apache.lucene.index.IndexReader;
39 import org.apache.lucene.index.IndexWriter;
40 import org.apache.lucene.index.IndexWriterConfig;
41 import org.apache.lucene.index.IndexWriterConfig.OpenMode;
42 import org.apache.lucene.index.IndexableField;
43 import org.apache.lucene.index.StoredFieldVisitor;
44 import org.apache.lucene.index.Term;
45 import org.apache.lucene.queryparser.classic.ParseException;
46 import org.apache.lucene.search.IndexSearcher;
47 import org.apache.lucene.search.MatchAllDocsQuery;
48 import org.apache.lucene.search.Query;
49 import org.apache.lucene.search.ScoreDoc;
50 import org.apache.lucene.search.TermQuery;
51 import org.apache.lucene.search.TopDocs;
52 import org.apache.lucene.store.Directory;
53 import org.apache.lucene.store.FSDirectory;
54 import org.apache.lucene.util.Version;
55 import org.eclipse.core.runtime.IProgressMonitor;
56 import org.eclipse.core.runtime.SubMonitor;
57 import org.simantics.databoard.util.ObjectUtils;
58 import org.simantics.db.ReadGraph;
59 import org.simantics.db.RequestProcessor;
60 import org.simantics.db.Resource;
61 import org.simantics.db.Session;
62 import org.simantics.db.common.request.SafeName;
63 import org.simantics.db.common.utils.NameUtils;
64 import org.simantics.db.exception.DatabaseException;
65 import org.simantics.db.indexing.internal.IndexingJob;
66 import org.simantics.db.layer0.adapter.GenericRelation;
67 import org.simantics.db.layer0.genericrelation.IndexException;
68 import org.simantics.db.request.Read;
69 import org.simantics.db.service.CollectionSupport;
70 import org.simantics.db.service.SerialisationSupport;
71 import org.simantics.utils.FileUtils;
72 import org.simantics.utils.datastructures.Pair;
73 import org.simantics.utils.threads.ThreadUtils;
74 import org.slf4j.Logger;
76 import gnu.trove.map.hash.THashMap;
79 * @author Tuukka Lehtonen
80 * @author Antti Villberg
82 abstract public class IndexedRelationsSearcherBase {
84 protected enum State {
85 // No index is available
87 // An index is available, but there is a problem with it
89 // An index is available but no reader or writer is ready
93 // A writer (and a reader) is ready
97 private State state = State.READY;
98 private Throwable exception;
100 public Throwable getException() {
104 public void setProblem(Throwable t) {
106 getLogger().error("Setting problem for {} and previous state {}", this, this.state, t);
107 this.state = State.PROBLEM;
111 public void setNone() {
112 this.state = State.NONE;
115 public void setReady() {
116 this.state = State.READY;
119 public State state() {
123 protected boolean checkState(State state) {
124 return this.state == state;
127 protected void assertState(State state) throws IndexException {
128 State s = this.state;
130 throw new IndexException("Illegal index searcher state, expected " + state.name() + " but state was " + s.name());
133 public void changeState(IProgressMonitor monitor, Session session, State state) {
134 changeState(monitor, session, state, 0);
137 protected void changeState(IProgressMonitor monitor, Session session, State state, int depth) {
139 if (this.state == state) {
140 if (getLogger().isDebugEnabled())
141 getLogger().debug("Trying to change state {} to the same as previous state {} in depth {} with {}", state, this.state, depth, this);
145 if (IndexPolicy.TRACE_INDEX_MANAGEMENT)
146 System.err.println("Index state " + this.state.name() + " => " + state.name() + " " + this);
150 // Try to exit problem state
151 if (State.PROBLEM == this.state && depth > 0) {
152 getLogger().info("Try to exit problem state for {} and state {}", this, state);
153 Throwable t = bestEffortClear(monitor, session);
155 getLogger().error("Best effort clear has failed for state {} and this {}", state, this, t);
159 // Managed to get into initial state
160 this.state = State.NONE;
161 getLogger().info("Managed to get into initial state {}", this.state);
165 // Cannot move into read from no index
166 if (State.NONE == this.state && State.READ == state) {
167 if (getLogger().isDebugEnabled())
168 getLogger().debug("Cannot move into read from no index in {} with state {}", this, state);
171 // Cannot move into write from no index
172 if (State.NONE == this.state && State.WRITE == state) {
173 if (getLogger().isDebugEnabled())
174 getLogger().debug("Cannot move into write from no index in {} with state {}", this, state);
178 boolean success = false;
182 if (searcher != null) {
185 if (reader != null) {
195 if (State.READ == state || State.WRITE == state) {
199 boolean forWriting = State.WRITE == state;
201 if (directory != null)
202 throw new IllegalStateException(getDescriptor() + "Index already loaded");
204 SubMonitor mon = SubMonitor.convert(monitor, 100);
206 mon.beginTask("Loading index", 100);
208 if (IndexPolicy.TRACE_INDEX_LOAD)
209 System.out.println(getDescriptor() + "Loading Lucene index from " + indexPath + " for " + (forWriting ? "writing" : "reading"));
211 long start = System.nanoTime();
213 directory = getDirectory(session);
216 // Never overwrite an index that is about to be loaded.
217 // TODO: could use OpenMode.CREATE_OR_APPEND but must test first
218 IndexWriterConfig config = new IndexWriterConfig(Version.LUCENE_4_9, Queries.getAnalyzer()).setOpenMode(OpenMode.APPEND);
220 // FIXME: platform #4676
221 writer = new IndexWriter(directory, config);
222 } catch (IndexNotFoundException e) {
223 // There was no pre-existing index on disk. Create it now.
224 writer = new IndexWriter(directory, config.setOpenMode(OpenMode.CREATE));
227 reader = DirectoryReader.open(directory);
228 searcher = new IndexSearcher(reader);
230 reader = DirectoryReader.open(directory);
231 searcher = new IndexSearcher(reader);
234 long end = System.nanoTime();
238 if (IndexPolicy.PERF_INDEX_LOAD) {
239 double time = (end - start) * 1e-6;
240 System.out.println(getDescriptor() + "Loaded Lucene index from " + indexPath + " for " + (forWriting ? "writing" : "reading") + " in " + time + " ms");
247 } catch (Throwable t) {
252 this.state = State.PROBLEM;
253 changeState(monitor, session, State.NONE, depth+1);
263 public static final FieldType STRING_TYPE = new FieldType();
266 STRING_TYPE.setIndexed(true);
267 STRING_TYPE.setStored(true);
268 STRING_TYPE.setTokenized(true);
269 STRING_TYPE.freeze();
272 protected static Field makeField(String fieldName, String fieldClass) throws DatabaseException {
273 switch (fieldClass) {
274 case "Long": return new LongField(fieldName, 0L, Field.Store.YES);
275 case "String": return new Field (fieldName, "", STRING_TYPE);
276 case "Text": return new TextField(fieldName, "", Field.Store.YES);
278 throw new DatabaseException("Can only index Long, String and Text fields, encountered field type " + fieldClass);
282 protected static Field[] makeFieldsForRelation(GenericRelation r, int boundLength, Document document) throws DatabaseException {
283 Pair<String, String>[] fields = r.getFields();
284 Field[] fs = new Field[Math.max(0, fields.length - boundLength)];
285 for (int i = boundLength; i < fields.length; i++) {
286 Field f = makeField(fields[i].first, fields[i].second);
287 fs[i - boundLength] = f;
288 if (document != null)
294 void insertIndex(IProgressMonitor monitor, GenericRelation r, int boundLength, Collection<Object[]> documentsData)
295 throws CorruptIndexException, IOException, DatabaseException {
296 assertAccessOpen(true);
298 if (IndexPolicy.TRACE_INDEX_UPDATE)
299 System.out.println(getDescriptor() + "Inserting " + documentsData.size() + " documents into index at " + indexPath);
301 long start = 0, end = 0;
302 if (IndexPolicy.PERF_INDEX_UPDATE)
303 start = System.nanoTime();
306 Document document = new Document();
307 Field[] fs = makeFieldsForRelation(r, boundLength, document);
309 for (Object[] documentData : documentsData) {
310 if (setFields(fs, documentData) == null)
313 if (IndexPolicy.TRACE_INDEX_UPDATE)
314 System.out.println(getDescriptor() + "Inserting document " + document);
316 writer.addDocument(document);
319 if (IndexPolicy.PERF_INDEX_UPDATE) {
320 end = System.nanoTime();
321 double ms = (end - start) * 1e-6;
322 System.out.println(getDescriptor() + "Inserted " + documentsData.size() + " documents into index at " + indexPath + " in " + ms + " ms");
329 void removeIndex(IProgressMonitor monitor, GenericRelation r, RequestProcessor processor, String key, Collection<Object> keyValues) throws DatabaseException, CorruptIndexException, IOException {
330 assertAccessOpen(true);
332 if (IndexPolicy.TRACE_INDEX_UPDATE)
333 System.out.println(getDescriptor() + "Removing " + keyValues.size() + " documents from index at " + indexPath);
335 long start = 0, end = 0;
336 if (IndexPolicy.PERF_INDEX_UPDATE)
337 start = System.nanoTime();
340 for (Object keyValue : keyValues) {
341 Term removedTerm = null;
342 if (keyValue instanceof Long) {
343 removedTerm = IndexUtils.longTerm(key, (Long) keyValue);
344 } else if (keyValue instanceof String) {
345 removedTerm = new Term(key, (String) keyValue);
347 // FIXME: should throw an exception for illegal input data but this would leave the index in an incoherent state
351 if (IndexPolicy.TRACE_INDEX_UPDATE)
352 System.out.println(getDescriptor() + "Removing document with key " + removedTerm);
353 writer.deleteDocuments(removedTerm);
356 if (IndexPolicy.PERF_INDEX_UPDATE) {
357 end = System.nanoTime();
358 double ms = (end - start) * 1e-6;
359 System.out.println(getDescriptor() + "Removed " + keyValues.size() + " documents from index at " + indexPath + " in " + ms + " ms");
366 void removeIndex(IProgressMonitor monitor) throws DatabaseException, CorruptIndexException, IOException {
367 assertAccessOpen(true);
369 long start = 0, end = 0;
370 if (IndexPolicy.PERF_INDEX_UPDATE)
371 start = System.nanoTime();
377 if (IndexPolicy.PERF_INDEX_UPDATE) {
378 end = System.nanoTime();
379 double ms = (end - start) * 1e-6;
380 System.out.println(getDescriptor() + "Removed all documents from index at " + indexPath + " in " + ms + " ms");
387 boolean replaceIndex(IProgressMonitor monitor, String key, Collection<Object> keyValues, GenericRelation r, int boundLength, Collection<Object[]> documentsData) throws CorruptIndexException, IOException, DatabaseException {
389 boolean didReplace = false;
391 assertAccessOpen(true);
392 if (keyValues.size() != documentsData.size())
393 throw new IllegalArgumentException("keyValues size does not match documents data size, " + keyValues.size() + " <> " + documentsData.size());
395 if (IndexPolicy.TRACE_INDEX_UPDATE)
396 System.out.println(getDescriptor() + "Replacing " + keyValues.size() + " documents from index at " + indexPath);
398 long start = 0, end = 0;
399 if (IndexPolicy.PERF_INDEX_UPDATE)
400 start = System.nanoTime();
403 Iterator<Object> keyIt = keyValues.iterator();
404 Iterator<Object[]> documentDataIt = documentsData.iterator();
406 Document document = new Document();
407 Field[] fs = makeFieldsForRelation(r, boundLength, document);
410 while (keyIt.hasNext()) {
411 Object keyValue = keyIt.next();
412 Object[] documentData = documentDataIt.next();
414 Term removedTerm = null;
415 if (keyValue instanceof Long) {
416 removedTerm = IndexUtils.longTerm(key, (Long) keyValue);
417 } else if (keyValue instanceof String) {
418 removedTerm = new Term(key, (String) keyValue);
420 // FIXME: should throw an exception for illegal input data but this would leave the index in an incoherent state
421 System.err.println("[" + getClass().getSimpleName() + "] Unrecognized document key to remove '" + keyValue + "', only " + String.class + " and " + Resource.class + " are supported.");
422 continue nextDocument;
425 if (setFields(fs, documentData) == null)
426 continue nextDocument;
428 if (IndexPolicy.TRACE_INDEX_UPDATE)
429 System.out.println(getDescriptor() + "Replacing document with key " + removedTerm + " with " + document);
431 boolean done = false;
432 if(requireChangeInfoOnReplace()) {
433 TopDocs exist = searcher.search(new TermQuery(removedTerm), null, 2);
434 if(exist.scoreDocs.length == 1 && requireChangeInfoOnReplace()) {
435 Document doc = reader.document(exist.scoreDocs[0].doc);
436 if(!areSame(doc, document)) {
437 writer.deleteDocuments(removedTerm);
438 writer.addDocument(document);
440 if (IndexPolicy.TRACE_INDEX_UPDATE)
441 System.out.println("-replaced single existing");
443 if (IndexPolicy.TRACE_INDEX_UPDATE)
444 System.out.println("-was actually same than single existing");
450 writer.deleteDocuments(removedTerm);
451 writer.addDocument(document);
453 if (IndexPolicy.TRACE_INDEX_UPDATE)
454 System.out.println("-had many or none - removed all existing");
459 if (IndexPolicy.PERF_INDEX_UPDATE) {
460 end = System.nanoTime();
461 double ms = (end - start) * 1e-6;
462 System.out.println(getDescriptor() + "Replaced " + keyValues.size() + " documents from index at " + indexPath + " in " + ms + " ms");
472 protected boolean requireChangeInfoOnReplace() {
476 private boolean areSame(Document d1, Document d2) {
477 List<IndexableField> fs1 = d1.getFields();
478 List<IndexableField> fs2 = d2.getFields();
479 if(fs1.size() != fs2.size()) return false;
480 for(int i=0;i<fs1.size();i++) {
481 IndexableField f1 = fs1.get(i);
482 IndexableField f2 = fs2.get(i);
483 String s1 = f1.stringValue();
484 String s2 = f2.stringValue();
485 if (IndexPolicy.TRACE_INDEX_UPDATE)
486 System.err.println("areSame " + s1 + " vs. " + s2 );
487 if(!ObjectUtils.objectEquals(s1,s2)) return false;
492 final RequestProcessor session;
494 final Resource relation;
497 * The schema of the index, i.e. the fields that will be indexed per
498 * document for the specified relation. Since the relation stays the same
499 * throughout the lifetime of this class, the index schema is also assumed
500 * to the same. This means that {@link GenericRelation#getFields()} is
501 * assumed to stay the same.
503 final IndexSchema schema;
515 IndexSearcher searcher;
517 IndexedRelationsSearcherBase(RequestProcessor session, Resource relation, Resource input) {
518 this.session = session;
519 this.relation = relation;
521 this.indexPath = getIndexDirectory(session.getSession(), relation, input);
522 if(isIndexAvailable()) {
527 this.schema = IndexSchema.readFromRelation(session, relation);
530 Directory getDirectory(Session session) throws IOException {
531 return FSDirectory.open(indexPath.toFile());
534 abstract String getDescriptor();
537 * Ensures that searcher is in read or write state.
539 * @param forWriting <code>true</code> to open index for writing,
540 * <code>false</code> for reading
541 * @return true is required state was reached
544 boolean startAccess(IProgressMonitor monitor, Session session, boolean forWriting) {
546 changeState(monitor, session, State.WRITE);
547 return checkState(State.WRITE);
549 changeState(monitor, session, State.READ);
550 return checkState(State.READ);
554 boolean hasAccess(boolean forWriting) {
557 return checkState(State.WRITE);
559 return checkState(State.WRITE) || checkState(State.READ);
563 void assertAccessOpen(boolean forWriting) {
565 if(!checkState(State.WRITE))
566 throw new IllegalStateException("index not opened for writing (directory=" + directory + ", reader=" + reader + ")");
568 if(!(checkState(State.WRITE) || checkState(State.READ)))
569 throw new IllegalStateException("index not opened for reading (directory=" + directory + ", writer=" + writer + ")");
572 void closeWriter(IndexWriter writer) throws CorruptIndexException, IOException {
577 // May throw OOME, see IndexWriter javadoc for the correct actions.
579 } catch (OutOfMemoryError e) {
585 public static String getPattern(GenericRelation relation, int boundCount) {
587 for (int i = 0; i < boundCount; i++)
589 for (int i = 0; i < relation.getFields().length - boundCount; i++)
594 void initializeIndex(IProgressMonitor monitor, ReadGraph graph, Object[] bound, boolean overwrite)
595 throws IOException, DatabaseException
597 IndexingJob.jobifyIfPossible(
599 "Reindexing " + NameUtils.getSafeLabel(graph, input),
602 GenericRelation r = graph.adapt(relation, GenericRelation.class);
604 throw new DatabaseException("Given resource " + relation + "could not be adapted to GenericRelation.");
606 GenericRelation selection = r.select(getPattern(r, bound.length), bound);
608 List<Object[]> results = selection.realize(graph);
609 initializeIndexImpl(new CompletableFuture<>(), mon, r, results, bound, overwrite);
610 } catch (IOException e) {
611 getLogger().error("Index is in problematic state! {}", this, e);
612 throw new DatabaseException(e);
617 private static final int INDEXING_THREAD_COUNT = 2; // this is quite good parallelism level for lucene
619 void initializeIndexImpl(CompletableFuture<?> result, IProgressMonitor monitor, GenericRelation r, List<Object[]> results, final Object[] bound, boolean overwrite) throws IOException {
621 final SubMonitor mon = SubMonitor.convert(monitor, 100);
623 if (IndexPolicy.TRACE_INDEX_INIT)
624 System.out.println(getDescriptor() + "Initializing index at " + indexPath + " (overwrite = " + overwrite + ")");
625 mon.beginTask("Initializing Index", 100);
628 if (Files.exists(indexPath)) {
629 mon.subTask("Erasing previous index");
630 if (getLogger().isDebugEnabled())
631 getLogger().debug("Erasing previous index {}", indexPath.toAbsolutePath());
632 FileUtils.emptyDirectory(indexPath);
636 final AtomicReference<FSDirectory> directory = new AtomicReference<FSDirectory>();
637 final AtomicReference<IndexWriter> writer = new AtomicReference<IndexWriter>();
640 mon.subTask("Start index write");
641 Files.createDirectories(indexPath);
643 directory.set(FSDirectory.open(indexPath.toFile()));
644 IndexWriterConfig conf = new IndexWriterConfig(Version.LUCENE_4_9, Queries.getAnalyzer()).setOpenMode(OpenMode.CREATE);
645 writer.set(new IndexWriter(directory.get(), conf));
649 long realizeStart = 0;
650 if (IndexPolicy.PERF_INDEX_INIT)
651 realizeStart = System.nanoTime();
653 mon.subTask("Calculating indexed content");
658 if (IndexPolicy.PERF_INDEX_INIT)
659 System.out.println(getDescriptor() + "Realized index with " + results.size() + " entries at " + indexPath + " in " + (1e-9 * (System.nanoTime()-realizeStart)) + " seconds.");
661 if (IndexPolicy.TRACE_INDEX_INIT)
662 System.out.println(getDescriptor() + "Indexed relation " + r + " produced " + results.size() + " results");
664 long start = IndexPolicy.PERF_INDEX_INIT ? System.nanoTime() : 0;
666 mon.subTask("Indexing content");
667 final Semaphore s = new Semaphore(0);
668 mon.setWorkRemaining(results.size());
669 for (int i = 0; i < INDEXING_THREAD_COUNT; i++) {
670 final int startIndex = i;
671 ThreadUtils.getBlockingWorkExecutor().submit(() -> {
673 Document document = new Document();
674 Field[] fs = makeFieldsForRelation(r, bound.length, document);
676 for (int index = startIndex; index < results.size(); index += INDEXING_THREAD_COUNT) {
677 if (setFields(fs, results.get(index)) == null)
680 writer.get().addDocument(document);
681 } catch (CorruptIndexException e) {
682 getLogger().error("Index is corrupted! {}", this, e);
683 throw new IllegalStateException(e);
684 } catch (IOException e) {
685 getLogger().error("Index is in problematic state! {}", this, e);
686 throw new IllegalStateException(e);
693 } catch (DatabaseException e) {
694 throw new IllegalStateException(e);
702 s.acquire(INDEXING_THREAD_COUNT);
703 } catch (InterruptedException e) {
704 getLogger().error("Could not initialize index {}", this, e);
707 // http://www.gossamer-threads.com/lists/lucene/java-dev/47895
708 // and http://lucene.apache.org/java/docs/index.html#27+November+2011+-+Lucene+Core+3.5.0
709 // advise against calling optimize at all. So let's not do it anymore.
710 //writer.get().optimize();
711 //writer.get().commit();
713 mon.subTask("Flushing");
715 if (IndexPolicy.PERF_INDEX_INIT)
716 System.out.println(getDescriptor() + "Wrote index at " + indexPath + " in " + (1e-9 * (System.nanoTime()-start)) + " seconds.");
718 result.complete(null);
719 // } catch (DatabaseException e) {
720 // getLogger().error("Could not initialize index due to db {}", this, e);
723 closeWriter(writer.getAndSet(null));
725 FileUtils.uncheckedClose(directory.getAndSet(null));
728 } catch (Throwable t) {
729 getLogger().error("Could not initialize index", t);
730 result.completeExceptionally(t);
735 public List<Object[]> debugDocs(IProgressMonitor monitor) throws ParseException, IOException, DatabaseException {
737 Query query = new MatchAllDocsQuery();
739 TopDocs td = searcher.search(query, Integer.MAX_VALUE);
741 ScoreDoc[ ] scoreDocs = td.scoreDocs;
742 List<Object[]> result = new ArrayList<Object[]>(scoreDocs.length);
744 for(ScoreDoc scoreDoc:scoreDocs) {
748 Document doc = reader.document(scoreDoc.doc);
749 List<IndexableField> fs = doc.getFields();
750 Object[] o = new Object[fs.size()];
752 for (IndexableField f : fs) {
753 o[index++] = f.stringValue();
757 } catch (CorruptIndexException e) {
758 getLogger().error("Index is corrupted! {}", this, e);
759 throw new DatabaseException(e);
760 } catch (IOException e) {
761 getLogger().error("Index is in problematic state! {}", this, e);
762 throw new DatabaseException(e);
772 List<Map<String, Object>> doSearch(IProgressMonitor monitor, RequestProcessor processor, String search, int maxResultCount) throws ParseException, IOException,
775 // An empty search string will crash QueryParser
776 // Just return no results for empty queries.
777 //System.out.println("search: '" + search + "'");
778 if (search.isEmpty())
779 return Collections.emptyList();
781 assertAccessOpen(false);
783 Query query = Queries.parse(search, schema);
785 long start = System.nanoTime();
787 maxResultCount = Math.min(maxResultCount, searcher.getIndexReader().numDocs());
788 if (maxResultCount == 0)
789 return Collections.emptyList();
791 final TopDocs docs = searcher.search(query, null, maxResultCount);
793 // for(Object[] o : debugDocs(monitor)) {
794 // System.err.println("-" + Arrays.toString(o));
797 if (IndexPolicy.PERF_INDEX_QUERY) {
798 long end = System.nanoTime();
799 System.out.println(getDescriptor() + "search(" + search + ", " + maxResultCount + ") into index at " + indexPath + " took " + (1e-9 * (end-start)) + " seconds.");
802 if (docs.totalHits == 0) {
803 return Collections.emptyList();
806 return processor.syncRequest(new Read<List<Map<String, Object>>>() {
809 public List<Map<String, Object>> perform(ReadGraph graph) throws DatabaseException {
811 GenericRelation r = graph.adapt(relation, GenericRelation.class);
813 throw new DatabaseException("Given resource " + graph.syncRequest(new SafeName(relation))
814 + "could not be adapted to GenericRelation.");
816 SerialisationSupport support = graph.getService(SerialisationSupport.class);
818 List<Map<String, Object>> result = new ArrayList<Map<String, Object>>(docs.scoreDocs.length);
820 final DocumentStoredFieldVisitor visitor = new DocumentStoredFieldVisitor();
822 for (ScoreDoc scoreDoc : docs.scoreDocs) {
826 reader.document(scoreDoc.doc, visitor);
828 Document doc = visitor.getDocument();
830 List<IndexableField> fs = doc.getFields();
831 Map<String, Object> entry = new THashMap<String, Object>(fs.size());
832 for (IndexableField f : fs) {
833 IndexSchema.Type type = schema.typeMap.get(f.name());
834 if (type == IndexSchema.Type.LONG) {
835 entry.put(f.name(), support.getResource(f.numericValue().longValue()));
837 entry.put(f.name(), f.stringValue());
843 } catch (CorruptIndexException e) {
844 getLogger().error("Index is corrupted! {}", this, e);
845 throw new DatabaseException(e);
846 } catch (IOException e) {
847 getLogger().error("Index is in problematic state! {}", this, e);
848 throw new DatabaseException(e);
856 static class ResourceVisitor extends StoredFieldVisitor {
861 public Status needsField(FieldInfo fieldInfo) throws IOException {
862 if("Resource".equals(fieldInfo.name)) return Status.YES;
867 public void longField(FieldInfo fieldInfo, long value) throws IOException {
873 static class DumpVisitor extends StoredFieldVisitor {
875 public List<Object> values;
877 DumpVisitor(List<Object> values) {
878 this.values = values;
882 public Status needsField(FieldInfo fieldInfo) throws IOException {
887 public void longField(FieldInfo fieldInfo, long value) throws IOException {
892 public void stringField(FieldInfo fieldInfo, String value) throws IOException {
898 List<Resource> doSearchResources(IProgressMonitor monitor, RequestProcessor processor, String search, int maxResultCount) throws ParseException, IOException,
901 // An empty search string will crash QueryParser
902 // Just return no results for empty queries.
903 //System.out.println("search: '" + search + "'");
904 if (search.isEmpty())
905 return Collections.emptyList();
907 assertAccessOpen(false);
909 Query query = Queries.parse(search, schema);
911 long start = System.nanoTime();
913 maxResultCount = Math.min(maxResultCount, searcher.getIndexReader().numDocs());
914 if (maxResultCount == 0)
915 return Collections.emptyList();
917 final TopDocs docs = searcher.search(query, null, maxResultCount);
919 // for(Object[] o : debugDocs(monitor)) {
920 // System.err.println("-" + Arrays.toString(o));
923 if (IndexPolicy.PERF_INDEX_QUERY) {
924 long end = System.nanoTime();
925 System.out.println(getDescriptor() + "search(" + search + ", " + maxResultCount + ") into index at " + indexPath + " took " + (1e-9 * (end-start)) + " seconds.");
928 if (docs.totalHits == 0) {
929 return Collections.emptyList();
932 return processor.syncRequest(new Read<List<Resource>>() {
935 public List<Resource> perform(ReadGraph graph) throws DatabaseException {
937 CollectionSupport cs = graph.getService(CollectionSupport.class);
938 SerialisationSupport support = graph.getService(SerialisationSupport.class);
940 List<Resource> result = cs.createList();
942 ResourceVisitor visitor = new ResourceVisitor();
944 for (ScoreDoc scoreDoc : docs.scoreDocs) {
946 reader.document(scoreDoc.doc, visitor);
947 result.add(support.getResource(visitor.id));
948 } catch (CorruptIndexException e) {
949 getLogger().error("Index is corrupted! {}", this, e);
950 throw new DatabaseException(e);
951 } catch (IOException e) {
952 getLogger().error("Index is in problematic state! {}", this, e);
953 throw new DatabaseException(e);
961 List<Object> doList(IProgressMonitor monitor, RequestProcessor processor) throws ParseException, IOException,
964 assertAccessOpen(false);
966 Query query = new MatchAllDocsQuery();
968 final TopDocs docs = searcher.search(query, Integer.MAX_VALUE);
970 ArrayList<Object> result = new ArrayList<Object>();
972 DumpVisitor visitor = new DumpVisitor(result);
974 for (ScoreDoc scoreDoc : docs.scoreDocs) {
978 reader.document(scoreDoc.doc, visitor);
980 } catch (CorruptIndexException e) {
981 getLogger().error("Index is corrupted! {}", this, e);
982 throw new DatabaseException(e);
983 } catch (IOException e) {
984 getLogger().error("Index is in problematic state! {}", this, e);
985 throw new DatabaseException(e);
994 protected static Path getIndexDirectory(Session session, Resource relation, Resource input) {
995 Path path = DatabaseIndexing.getIndexLocation(session, relation, input);
996 // System.out.println("getIndexDirectory = " + path);
1000 Path getIndexPath() {
1004 boolean isIndexAvailable() {
1005 return Files.isDirectory(indexPath);
1008 abstract Throwable bestEffortClear(IProgressMonitor monitor, Session session);
1011 * Start from scratch. Clear all caches and rebuild the index.
1013 Throwable clearDirectory(IProgressMonitor monitor, Session session) {
1015 Path file = getIndexPath();
1018 FileUtils.delete(file);
1019 } catch (Throwable t) {
1020 getLogger().error("Could not delete directory {}", file.toAbsolutePath(), t);
1023 if (Files.exists(file))
1024 return new IllegalStateException("Failed to delete directory " + file.toAbsolutePath());
1028 private Field[] setFields(Field[] fs, Object[] result) {
1029 for (int i = 0; i < result.length; i++) {
1030 Object value = result[i];
1031 if (value instanceof String) {
1032 if (IndexPolicy.DEBUG_INDEX_INIT)
1033 System.out.println(getDescriptor() + "index " + fs[i].name() + " = " + value + " : String");
1034 fs[i].setStringValue((String) value);
1035 } else if (value instanceof Long) {
1036 if (IndexPolicy.DEBUG_INDEX_INIT)
1037 System.out.println(getDescriptor() + "index " + fs[i].name() + " = " + value + " : Long");
1038 fs[i].setLongValue((Long) value);
1040 getLogger().error("Can only index Long and String fields, encountered " + value);
1047 protected abstract Logger getLogger();
1050 public String toString() {
1051 return getClass().getSimpleName() + " [" + String.valueOf(schema) + ", " + String.valueOf(relation) + ", " + String.valueOf(input) + ", " + String.valueOf(indexPath) + ", " + String.valueOf(directory) + ", " + String.valueOf(state) + "]";