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.request.Read;
68 import org.simantics.db.service.CollectionSupport;
69 import org.simantics.db.service.SerialisationSupport;
70 import org.simantics.utils.FileUtils;
71 import org.simantics.utils.datastructures.Pair;
72 import org.simantics.utils.threads.ThreadUtils;
73 import org.slf4j.Logger;
75 import gnu.trove.map.hash.THashMap;
78 * @author Tuukka Lehtonen
79 * @author Antti Villberg
81 abstract public class IndexedRelationsSearcherBase {
83 protected enum State {
84 // No index is available
86 // An index is available, but there is a problem with it
88 // An index is available but no reader or writer is ready
92 // A writer (and a reader) is ready
96 private State state = State.READY;
97 private Throwable exception;
99 public Throwable getException() {
103 public void setProblem(Throwable t) {
105 getLogger().error("Setting problem for {} and previous state {}", this, this.state, t);
106 this.state = State.PROBLEM;
110 public void setNone() {
111 this.state = State.NONE;
114 public void setReady() {
115 this.state = State.READY;
118 protected boolean checkState(State state) {
119 return this.state == state;
122 protected void assertState(State state) throws AssertionError {
124 if(this.state != state) throw new AssertionError("Illegal state, expected " + state.name() + " but was in " + this.state.name());
128 public void changeState(IProgressMonitor monitor, Session session, State state) {
129 changeState(monitor, session, state, 0);
132 protected void changeState(IProgressMonitor monitor, Session session, State state, int depth) {
134 if (this.state == state) {
135 if (getLogger().isDebugEnabled())
136 getLogger().debug("Trying to change state {} to the same as previous state {} in depth {} with {}", state, this.state, depth, this);
140 if (IndexPolicy.TRACE_INDEX_MANAGEMENT)
141 System.err.println("Index state " + this.state.name() + " => " + state.name() + " " + this);
145 // Try to exit problem state
146 if (State.PROBLEM == this.state && depth > 0) {
147 getLogger().info("Try to exit problem state for {} and state {}", this, state);
148 Throwable t = bestEffortClear(monitor, session);
150 getLogger().error("Best effort clear has failed for state {} and this {}", state, this, t);
154 // Managed to get into initial state
155 this.state = State.NONE;
156 getLogger().info("Managed to get into initial state {}", this.state);
160 // Cannot move into read from no index
161 if (State.NONE == this.state && State.READ == state) {
162 if (getLogger().isDebugEnabled())
163 getLogger().debug("Cannot move into read from no index in {} with state {}", this, state);
166 // Cannot move into write from no index
167 if (State.NONE == this.state && State.WRITE == state) {
168 if (getLogger().isDebugEnabled())
169 getLogger().debug("Cannot move into write from no index in {} with state {}", this, state);
173 boolean success = false;
177 if (searcher != null) {
180 if (reader != null) {
190 if (State.READ == state || State.WRITE == state) {
194 boolean forWriting = State.WRITE == state;
196 if (directory != null)
197 throw new IllegalStateException(getDescriptor() + "Index already loaded");
199 SubMonitor mon = SubMonitor.convert(monitor, 100);
201 mon.beginTask("Loading index", 100);
203 if (IndexPolicy.TRACE_INDEX_LOAD)
204 System.out.println(getDescriptor() + "Loading Lucene index from " + indexPath + " for " + (forWriting ? "writing" : "reading"));
206 long start = System.nanoTime();
208 directory = getDirectory(session);
211 // Never overwrite an index that is about to be loaded.
212 // TODO: could use OpenMode.CREATE_OR_APPEND but must test first
213 IndexWriterConfig config = new IndexWriterConfig(Version.LUCENE_4_9, Queries.getAnalyzer()).setOpenMode(OpenMode.APPEND);
215 // FIXME: platform #4676
216 writer = new IndexWriter(directory, config);
217 } catch (IndexNotFoundException e) {
218 // There was no pre-existing index on disk. Create it now.
219 writer = new IndexWriter(directory, config.setOpenMode(OpenMode.CREATE));
222 reader = DirectoryReader.open(directory);
223 searcher = new IndexSearcher(reader);
225 reader = DirectoryReader.open(directory);
226 searcher = new IndexSearcher(reader);
229 long end = System.nanoTime();
233 if (IndexPolicy.PERF_INDEX_LOAD) {
234 double time = (end - start) * 1e-6;
235 System.out.println(getDescriptor() + "Loaded Lucene index from " + indexPath + " for " + (forWriting ? "writing" : "reading") + " in " + time + " ms");
242 } catch (Throwable t) {
247 this.state = State.PROBLEM;
248 changeState(monitor, session, State.NONE, depth+1);
258 public static final FieldType STRING_TYPE = new FieldType();
261 STRING_TYPE.setIndexed(true);
262 STRING_TYPE.setStored(true);
263 STRING_TYPE.setTokenized(true);
264 STRING_TYPE.freeze();
267 protected static Field makeField(String fieldName, String fieldClass) throws DatabaseException {
268 switch (fieldClass) {
269 case "Long": return new LongField(fieldName, 0L, Field.Store.YES);
270 case "String": return new Field (fieldName, "", STRING_TYPE);
271 case "Text": return new TextField(fieldName, "", Field.Store.YES);
273 throw new DatabaseException("Can only index Long, String and Text fields, encountered field type " + fieldClass);
277 protected static Field[] makeFieldsForRelation(GenericRelation r, int boundLength, Document document) throws DatabaseException {
278 Pair<String, String>[] fields = r.getFields();
279 Field[] fs = new Field[Math.max(0, fields.length - boundLength)];
280 for (int i = boundLength; i < fields.length; i++) {
281 Field f = makeField(fields[i].first, fields[i].second);
282 fs[i - boundLength] = f;
283 if (document != null)
289 void insertIndex(IProgressMonitor monitor, GenericRelation r, int boundLength, Collection<Object[]> documentsData)
290 throws CorruptIndexException, IOException, DatabaseException {
291 assertAccessOpen(true);
293 if (IndexPolicy.TRACE_INDEX_UPDATE)
294 System.out.println(getDescriptor() + "Inserting " + documentsData.size() + " documents into index at " + indexPath);
296 long start = 0, end = 0;
297 if (IndexPolicy.PERF_INDEX_UPDATE)
298 start = System.nanoTime();
301 Document document = new Document();
302 Field[] fs = makeFieldsForRelation(r, boundLength, document);
304 for (Object[] documentData : documentsData) {
305 if (setFields(fs, documentData) == null)
308 if (IndexPolicy.TRACE_INDEX_UPDATE)
309 System.out.println(getDescriptor() + "Inserting document " + document);
311 writer.addDocument(document);
314 if (IndexPolicy.PERF_INDEX_UPDATE) {
315 end = System.nanoTime();
316 double ms = (end - start) * 1e-6;
317 System.out.println(getDescriptor() + "Inserted " + documentsData.size() + " documents into index at " + indexPath + " in " + ms + " ms");
324 void removeIndex(IProgressMonitor monitor, GenericRelation r, RequestProcessor processor, String key, Collection<Object> keyValues) throws DatabaseException, CorruptIndexException, IOException {
325 assertAccessOpen(true);
327 if (IndexPolicy.TRACE_INDEX_UPDATE)
328 System.out.println(getDescriptor() + "Removing " + keyValues.size() + " documents from index at " + indexPath);
330 long start = 0, end = 0;
331 if (IndexPolicy.PERF_INDEX_UPDATE)
332 start = System.nanoTime();
335 for (Object keyValue : keyValues) {
336 Term removedTerm = null;
337 if (keyValue instanceof Long) {
338 removedTerm = IndexUtils.longTerm(key, (Long) keyValue);
339 } else if (keyValue instanceof String) {
340 removedTerm = new Term(key, (String) keyValue);
342 // FIXME: should throw an exception for illegal input data but this would leave the index in an incoherent state
346 if (IndexPolicy.TRACE_INDEX_UPDATE)
347 System.out.println(getDescriptor() + "Removing document with key " + removedTerm);
348 writer.deleteDocuments(removedTerm);
351 if (IndexPolicy.PERF_INDEX_UPDATE) {
352 end = System.nanoTime();
353 double ms = (end - start) * 1e-6;
354 System.out.println(getDescriptor() + "Removed " + keyValues.size() + " documents from index at " + indexPath + " in " + ms + " ms");
361 void removeIndex(IProgressMonitor monitor) throws DatabaseException, CorruptIndexException, IOException {
362 assertAccessOpen(true);
364 long start = 0, end = 0;
365 if (IndexPolicy.PERF_INDEX_UPDATE)
366 start = System.nanoTime();
372 if (IndexPolicy.PERF_INDEX_UPDATE) {
373 end = System.nanoTime();
374 double ms = (end - start) * 1e-6;
375 System.out.println(getDescriptor() + "Removed all documents from index at " + indexPath + " in " + ms + " ms");
382 boolean replaceIndex(IProgressMonitor monitor, String key, Collection<Object> keyValues, GenericRelation r, int boundLength, Collection<Object[]> documentsData) throws CorruptIndexException, IOException, DatabaseException {
384 boolean didReplace = false;
386 assertAccessOpen(true);
387 if (keyValues.size() != documentsData.size())
388 throw new IllegalArgumentException("keyValues size does not match documents data size, " + keyValues.size() + " <> " + documentsData.size());
390 if (IndexPolicy.TRACE_INDEX_UPDATE)
391 System.out.println(getDescriptor() + "Replacing " + keyValues.size() + " documents from index at " + indexPath);
393 long start = 0, end = 0;
394 if (IndexPolicy.PERF_INDEX_UPDATE)
395 start = System.nanoTime();
398 Iterator<Object> keyIt = keyValues.iterator();
399 Iterator<Object[]> documentDataIt = documentsData.iterator();
401 Document document = new Document();
402 Field[] fs = makeFieldsForRelation(r, boundLength, document);
405 while (keyIt.hasNext()) {
406 Object keyValue = keyIt.next();
407 Object[] documentData = documentDataIt.next();
409 Term removedTerm = null;
410 if (keyValue instanceof Long) {
411 removedTerm = IndexUtils.longTerm(key, (Long) keyValue);
412 } else if (keyValue instanceof String) {
413 removedTerm = new Term(key, (String) keyValue);
415 // FIXME: should throw an exception for illegal input data but this would leave the index in an incoherent state
416 System.err.println("[" + getClass().getSimpleName() + "] Unrecognized document key to remove '" + keyValue + "', only " + String.class + " and " + Resource.class + " are supported.");
417 continue nextDocument;
420 if (setFields(fs, documentData) == null)
421 continue nextDocument;
423 if (IndexPolicy.TRACE_INDEX_UPDATE)
424 System.out.println(getDescriptor() + "Replacing document with key " + removedTerm + " with " + document);
426 boolean done = false;
427 if(requireChangeInfoOnReplace()) {
428 TopDocs exist = searcher.search(new TermQuery(removedTerm), null, 2);
429 if(exist.scoreDocs.length == 1 && requireChangeInfoOnReplace()) {
430 Document doc = reader.document(exist.scoreDocs[0].doc);
431 if(!areSame(doc, document)) {
432 writer.deleteDocuments(removedTerm);
433 writer.addDocument(document);
435 if (IndexPolicy.TRACE_INDEX_UPDATE)
436 System.out.println("-replaced single existing");
438 if (IndexPolicy.TRACE_INDEX_UPDATE)
439 System.out.println("-was actually same than single existing");
445 writer.deleteDocuments(removedTerm);
446 writer.addDocument(document);
448 if (IndexPolicy.TRACE_INDEX_UPDATE)
449 System.out.println("-had many or none - removed all existing");
454 if (IndexPolicy.PERF_INDEX_UPDATE) {
455 end = System.nanoTime();
456 double ms = (end - start) * 1e-6;
457 System.out.println(getDescriptor() + "Replaced " + keyValues.size() + " documents from index at " + indexPath + " in " + ms + " ms");
467 protected boolean requireChangeInfoOnReplace() {
471 private boolean areSame(Document d1, Document d2) {
472 List<IndexableField> fs1 = d1.getFields();
473 List<IndexableField> fs2 = d2.getFields();
474 if(fs1.size() != fs2.size()) return false;
475 for(int i=0;i<fs1.size();i++) {
476 IndexableField f1 = fs1.get(i);
477 IndexableField f2 = fs2.get(i);
478 String s1 = f1.stringValue();
479 String s2 = f2.stringValue();
480 if (IndexPolicy.TRACE_INDEX_UPDATE)
481 System.err.println("areSame " + s1 + " vs. " + s2 );
482 if(!ObjectUtils.objectEquals(s1,s2)) return false;
487 final RequestProcessor session;
489 final Resource relation;
492 * The schema of the index, i.e. the fields that will be indexed per
493 * document for the specified relation. Since the relation stays the same
494 * throughout the lifetime of this class, the index schema is also assumed
495 * to the same. This means that {@link GenericRelation#getFields()} is
496 * assumed to stay the same.
498 final IndexSchema schema;
510 IndexSearcher searcher;
512 IndexedRelationsSearcherBase(RequestProcessor session, Resource relation, Resource input) {
513 this.session = session;
514 this.relation = relation;
516 this.indexPath = getIndexDirectory(session.getSession(), relation, input);
517 if(isIndexAvailable()) {
522 this.schema = IndexSchema.readFromRelation(session, relation);
525 Directory getDirectory(Session session) throws IOException {
526 return FSDirectory.open(indexPath.toFile());
529 abstract String getDescriptor();
532 * Ensures that searcher is in read or write state.
534 * @param forWriting <code>true</code> to open index for writing,
535 * <code>false</code> for reading
536 * @return true is required state was reached
539 boolean startAccess(IProgressMonitor monitor, Session session, boolean forWriting) {
541 changeState(monitor, session, State.WRITE);
542 return checkState(State.WRITE);
544 changeState(monitor, session, State.READ);
545 return checkState(State.READ);
549 boolean hasAccess(boolean forWriting) {
552 return checkState(State.WRITE);
554 return checkState(State.WRITE) || checkState(State.READ);
558 void assertAccessOpen(boolean forWriting) {
560 if(!checkState(State.WRITE))
561 throw new IllegalStateException("index not opened for writing (directory=" + directory + ", reader=" + reader + ")");
563 if(!(checkState(State.WRITE) || checkState(State.READ)))
564 throw new IllegalStateException("index not opened for reading (directory=" + directory + ", writer=" + writer + ")");
567 void closeWriter(IndexWriter writer) throws CorruptIndexException, IOException {
572 // May throw OOME, see IndexWriter javadoc for the correct actions.
574 } catch (OutOfMemoryError e) {
580 public static String getPattern(GenericRelation relation, int boundCount) {
582 for (int i = 0; i < boundCount; i++)
584 for (int i = 0; i < relation.getFields().length - boundCount; i++)
589 void initializeIndex(IProgressMonitor monitor, ReadGraph graph, Object[] bound, boolean overwrite)
590 throws IOException, DatabaseException
592 IndexingJob.jobifyIfPossible(
594 "Reindexing " + NameUtils.getSafeLabel(graph, input),
597 GenericRelation r = graph.adapt(relation, GenericRelation.class);
599 throw new DatabaseException("Given resource " + relation + "could not be adapted to GenericRelation.");
601 GenericRelation selection = r.select(getPattern(r, bound.length), bound);
603 List<Object[]> results = selection.realize(graph);
604 initializeIndexImpl(new CompletableFuture<>(), mon, r, results, bound, overwrite);
605 } catch (IOException e) {
606 getLogger().error("Index is in problematic state! {}", this, e);
607 throw new DatabaseException(e);
612 private static final int INDEXING_THREAD_COUNT = 2; // this is quite good parallelism level for lucene
614 void initializeIndexImpl(CompletableFuture<?> result, IProgressMonitor monitor, GenericRelation r, List<Object[]> results, final Object[] bound, boolean overwrite) throws IOException {
616 final SubMonitor mon = SubMonitor.convert(monitor, 100);
618 if (IndexPolicy.TRACE_INDEX_INIT)
619 System.out.println(getDescriptor() + "Initializing index at " + indexPath + " (overwrite = " + overwrite + ")");
620 mon.beginTask("Initializing Index", 100);
623 if (Files.exists(indexPath)) {
624 mon.subTask("Erasing previous index");
625 if (getLogger().isDebugEnabled())
626 getLogger().debug("Erasing previous index {}", indexPath.toAbsolutePath());
627 FileUtils.emptyDirectory(indexPath);
631 final AtomicReference<FSDirectory> directory = new AtomicReference<FSDirectory>();
632 final AtomicReference<IndexWriter> writer = new AtomicReference<IndexWriter>();
635 mon.subTask("Start index write");
636 Files.createDirectories(indexPath);
638 directory.set(FSDirectory.open(indexPath.toFile()));
639 IndexWriterConfig conf = new IndexWriterConfig(Version.LUCENE_4_9, Queries.getAnalyzer()).setOpenMode(OpenMode.CREATE);
640 writer.set(new IndexWriter(directory.get(), conf));
644 long realizeStart = 0;
645 if (IndexPolicy.PERF_INDEX_INIT)
646 realizeStart = System.nanoTime();
648 mon.subTask("Calculating indexed content");
653 if (IndexPolicy.PERF_INDEX_INIT)
654 System.out.println(getDescriptor() + "Realized index with " + results.size() + " entries at " + indexPath + " in " + (1e-9 * (System.nanoTime()-realizeStart)) + " seconds.");
656 if (IndexPolicy.TRACE_INDEX_INIT)
657 System.out.println(getDescriptor() + "Indexed relation " + r + " produced " + results.size() + " results");
659 long start = IndexPolicy.PERF_INDEX_INIT ? System.nanoTime() : 0;
661 mon.subTask("Indexing content");
662 final Semaphore s = new Semaphore(0);
663 mon.setWorkRemaining(results.size());
664 for (int i = 0; i < INDEXING_THREAD_COUNT; i++) {
665 final int startIndex = i;
666 ThreadUtils.getBlockingWorkExecutor().submit(() -> {
668 Document document = new Document();
669 Field[] fs = makeFieldsForRelation(r, bound.length, document);
671 for (int index = startIndex; index < results.size(); index += INDEXING_THREAD_COUNT) {
672 if (setFields(fs, results.get(index)) == null)
675 writer.get().addDocument(document);
676 } catch (CorruptIndexException e) {
677 getLogger().error("Index is corrupted! {}", this, e);
678 throw new IllegalStateException(e);
679 } catch (IOException e) {
680 getLogger().error("Index is in problematic state! {}", this, e);
681 throw new IllegalStateException(e);
688 } catch (DatabaseException e) {
689 throw new IllegalStateException(e);
697 s.acquire(INDEXING_THREAD_COUNT);
698 } catch (InterruptedException e) {
699 getLogger().error("Could not initialize index {}", this, e);
702 // http://www.gossamer-threads.com/lists/lucene/java-dev/47895
703 // and http://lucene.apache.org/java/docs/index.html#27+November+2011+-+Lucene+Core+3.5.0
704 // advise against calling optimize at all. So let's not do it anymore.
705 //writer.get().optimize();
706 //writer.get().commit();
708 mon.subTask("Flushing");
710 if (IndexPolicy.PERF_INDEX_INIT)
711 System.out.println(getDescriptor() + "Wrote index at " + indexPath + " in " + (1e-9 * (System.nanoTime()-start)) + " seconds.");
713 result.complete(null);
714 // } catch (DatabaseException e) {
715 // getLogger().error("Could not initialize index due to db {}", this, e);
718 closeWriter(writer.getAndSet(null));
720 FileUtils.uncheckedClose(directory.getAndSet(null));
723 } catch (Throwable t) {
724 getLogger().error("Could not initialize index", t);
725 result.completeExceptionally(t);
730 public List<Object[]> debugDocs(IProgressMonitor monitor) throws ParseException, IOException, DatabaseException {
732 Query query = new MatchAllDocsQuery();
734 TopDocs td = searcher.search(query, Integer.MAX_VALUE);
736 ScoreDoc[ ] scoreDocs = td.scoreDocs;
737 List<Object[]> result = new ArrayList<Object[]>(scoreDocs.length);
739 for(ScoreDoc scoreDoc:scoreDocs) {
743 Document doc = reader.document(scoreDoc.doc);
744 List<IndexableField> fs = doc.getFields();
745 Object[] o = new Object[fs.size()];
747 for (IndexableField f : fs) {
748 o[index++] = f.stringValue();
752 } catch (CorruptIndexException e) {
753 getLogger().error("Index is corrupted! {}", this, e);
754 throw new DatabaseException(e);
755 } catch (IOException e) {
756 getLogger().error("Index is in problematic state! {}", this, e);
757 throw new DatabaseException(e);
767 List<Map<String, Object>> doSearch(IProgressMonitor monitor, RequestProcessor processor, String search, int maxResultCount) throws ParseException, IOException,
770 // An empty search string will crash QueryParser
771 // Just return no results for empty queries.
772 //System.out.println("search: '" + search + "'");
773 if (search.isEmpty())
774 return Collections.emptyList();
776 assertAccessOpen(false);
778 Query query = Queries.parse(search, schema);
780 long start = System.nanoTime();
782 maxResultCount = Math.min(maxResultCount, searcher.getIndexReader().numDocs());
783 if (maxResultCount == 0)
784 return Collections.emptyList();
786 final TopDocs docs = searcher.search(query, null, maxResultCount);
788 // for(Object[] o : debugDocs(monitor)) {
789 // System.err.println("-" + Arrays.toString(o));
792 if (IndexPolicy.PERF_INDEX_QUERY) {
793 long end = System.nanoTime();
794 System.out.println(getDescriptor() + "search(" + search + ", " + maxResultCount + ") into index at " + indexPath + " took " + (1e-9 * (end-start)) + " seconds.");
797 if (docs.totalHits == 0) {
798 return Collections.emptyList();
801 return processor.syncRequest(new Read<List<Map<String, Object>>>() {
804 public List<Map<String, Object>> perform(ReadGraph graph) throws DatabaseException {
806 GenericRelation r = graph.adapt(relation, GenericRelation.class);
808 throw new DatabaseException("Given resource " + graph.syncRequest(new SafeName(relation))
809 + "could not be adapted to GenericRelation.");
811 SerialisationSupport support = graph.getService(SerialisationSupport.class);
813 List<Map<String, Object>> result = new ArrayList<Map<String, Object>>(docs.scoreDocs.length);
815 final DocumentStoredFieldVisitor visitor = new DocumentStoredFieldVisitor();
817 for (ScoreDoc scoreDoc : docs.scoreDocs) {
821 reader.document(scoreDoc.doc, visitor);
823 Document doc = visitor.getDocument();
825 List<IndexableField> fs = doc.getFields();
826 Map<String, Object> entry = new THashMap<String, Object>(fs.size());
827 for (IndexableField f : fs) {
828 IndexSchema.Type type = schema.typeMap.get(f.name());
829 if (type == IndexSchema.Type.LONG) {
830 entry.put(f.name(), support.getResource(f.numericValue().longValue()));
832 entry.put(f.name(), f.stringValue());
838 } catch (CorruptIndexException e) {
839 getLogger().error("Index is corrupted! {}", this, e);
840 throw new DatabaseException(e);
841 } catch (IOException e) {
842 getLogger().error("Index is in problematic state! {}", this, e);
843 throw new DatabaseException(e);
851 static class ResourceVisitor extends StoredFieldVisitor {
856 public Status needsField(FieldInfo fieldInfo) throws IOException {
857 if("Resource".equals(fieldInfo.name)) return Status.YES;
862 public void longField(FieldInfo fieldInfo, long value) throws IOException {
868 static class DumpVisitor extends StoredFieldVisitor {
870 public List<Object> values;
872 DumpVisitor(List<Object> values) {
873 this.values = values;
877 public Status needsField(FieldInfo fieldInfo) throws IOException {
882 public void longField(FieldInfo fieldInfo, long value) throws IOException {
887 public void stringField(FieldInfo fieldInfo, String value) throws IOException {
893 List<Resource> doSearchResources(IProgressMonitor monitor, RequestProcessor processor, String search, int maxResultCount) throws ParseException, IOException,
896 // An empty search string will crash QueryParser
897 // Just return no results for empty queries.
898 //System.out.println("search: '" + search + "'");
899 if (search.isEmpty())
900 return Collections.emptyList();
902 assertAccessOpen(false);
904 Query query = Queries.parse(search, schema);
906 long start = System.nanoTime();
908 maxResultCount = Math.min(maxResultCount, searcher.getIndexReader().numDocs());
909 if (maxResultCount == 0)
910 return Collections.emptyList();
912 final TopDocs docs = searcher.search(query, null, maxResultCount);
914 // for(Object[] o : debugDocs(monitor)) {
915 // System.err.println("-" + Arrays.toString(o));
918 if (IndexPolicy.PERF_INDEX_QUERY) {
919 long end = System.nanoTime();
920 System.out.println(getDescriptor() + "search(" + search + ", " + maxResultCount + ") into index at " + indexPath + " took " + (1e-9 * (end-start)) + " seconds.");
923 if (docs.totalHits == 0) {
924 return Collections.emptyList();
927 return processor.syncRequest(new Read<List<Resource>>() {
930 public List<Resource> perform(ReadGraph graph) throws DatabaseException {
932 CollectionSupport cs = graph.getService(CollectionSupport.class);
933 SerialisationSupport support = graph.getService(SerialisationSupport.class);
935 List<Resource> result = cs.createList();
937 ResourceVisitor visitor = new ResourceVisitor();
939 for (ScoreDoc scoreDoc : docs.scoreDocs) {
941 reader.document(scoreDoc.doc, visitor);
942 result.add(support.getResource(visitor.id));
943 } catch (CorruptIndexException e) {
944 getLogger().error("Index is corrupted! {}", this, e);
945 throw new DatabaseException(e);
946 } catch (IOException e) {
947 getLogger().error("Index is in problematic state! {}", this, e);
948 throw new DatabaseException(e);
956 List<Object> doList(IProgressMonitor monitor, RequestProcessor processor) throws ParseException, IOException,
959 assertAccessOpen(false);
961 Query query = new MatchAllDocsQuery();
963 final TopDocs docs = searcher.search(query, Integer.MAX_VALUE);
965 ArrayList<Object> result = new ArrayList<Object>();
967 DumpVisitor visitor = new DumpVisitor(result);
969 for (ScoreDoc scoreDoc : docs.scoreDocs) {
973 reader.document(scoreDoc.doc, visitor);
975 } catch (CorruptIndexException e) {
976 getLogger().error("Index is corrupted! {}", this, e);
977 throw new DatabaseException(e);
978 } catch (IOException e) {
979 getLogger().error("Index is in problematic state! {}", this, e);
980 throw new DatabaseException(e);
989 protected static Path getIndexDirectory(Session session, Resource relation, Resource input) {
990 Path path = DatabaseIndexing.getIndexLocation(session, relation, input);
991 // System.out.println("getIndexDirectory = " + path);
995 Path getIndexPath() {
999 boolean isIndexAvailable() {
1000 return Files.isDirectory(indexPath);
1003 abstract Throwable bestEffortClear(IProgressMonitor monitor, Session session);
1006 * Start from scratch. Clear all caches and rebuild the index.
1008 Throwable clearDirectory(IProgressMonitor monitor, Session session) {
1010 Path file = getIndexPath();
1013 FileUtils.delete(file);
1014 } catch (Throwable t) {
1015 getLogger().error("Could not delete directory {}", file.toAbsolutePath(), t);
1018 if (Files.exists(file))
1019 return new IllegalStateException("Failed to delete directory " + file.toAbsolutePath());
1023 private Field[] setFields(Field[] fs, Object[] result) {
1024 for (int i = 0; i < result.length; i++) {
1025 Object value = result[i];
1026 if (value instanceof String) {
1027 if (IndexPolicy.DEBUG_INDEX_INIT)
1028 System.out.println(getDescriptor() + "index " + fs[i].name() + " = " + value + " : String");
1029 fs[i].setStringValue((String) value);
1030 } else if (value instanceof Long) {
1031 if (IndexPolicy.DEBUG_INDEX_INIT)
1032 System.out.println(getDescriptor() + "index " + fs[i].name() + " = " + value + " : Long");
1033 fs[i].setLongValue((Long) value);
1035 getLogger().error("Can only index Long and String fields, encountered " + value);
1042 protected abstract Logger getLogger();
1045 public String toString() {
1046 return getClass().getSimpleName() + " [" + String.valueOf(schema) + ", " + String.valueOf(relation) + ", " + String.valueOf(input) + ", " + String.valueOf(indexPath) + ", " + String.valueOf(directory) + ", " + String.valueOf(state) + "]";