/// <summary> /// Removes a document from the index. /// </summary> /// <param name="document">The document to remove.</param> /// <param name="state">A state object that is passed to the IndexStorer SaveDate/DeleteData function.</param> /// <exception cref="ArgumentNullException">If <paramref name="document"/> is <c>null</c>.</exception> public void RemoveDocument(IDocument document, object state) { if (document == null) { throw new ArgumentNullException("document"); } DumpedChange dc = RemoveDocumentInternal(document); if (dc != null) { OnIndexChange(document, IndexChangeType.DocumentRemoved, dc, state); } // else nothing to do }
/// <summary> /// Initializes a new instance of the <see cref="IndexChangedEventArgs" /> class. /// </summary> /// <param name="document">The affected document.</param> /// <param name="change">The change performed.</param> /// <param name="changeData">The dumped change data.</param> /// <param name="state">A state object that is passed to the IndexStorer SaveDate/DeleteData function.</param> /// <exception cref="ArgumentNullException">If <paramref name="change"/> is not <see cref="IndexChangeType.IndexCleared"/> and <paramref name="document"/> or <paramref name="changeData"/> are <c>null</c>.</exception> public IndexChangedEventArgs(IDocument document, IndexChangeType change, DumpedChange changeData, object state) { if (change != IndexChangeType.IndexCleared) { if (document == null) { throw new ArgumentNullException("document"); } if (changeData == null) { throw new ArgumentNullException("changeData"); } } Document = document; Change = change; ChangeData = changeData; State = state; }
/// <summary> /// Initializes a new instance of the <see cref="IndexChangedEventArgs" /> class. /// </summary> /// <param name="document">The affected document.</param> /// <param name="change">The change performed.</param> /// <param name="changeData">The dumped change data.</param> /// <param name="state">A state object that is passed to the IndexStorer SaveDate/DeleteData function.</param> /// <param name="result">The storer result, if any.</param> /// <exception cref="ArgumentNullException">If <paramref name="change"/> is not <see cref="IndexChangeType.IndexCleared"/> and <paramref name="document"/> or <paramref name="changeData"/> are <c>null</c>.</exception> public IndexChangedEventArgs(IDocument document, IndexChangeType change, DumpedChange changeData, object state, IndexStorerResult result) : this(document, change, changeData, state) { Result = result; }
/// <summary> /// Takes care of firing the <see cref="IndexChanged" /> event. /// </summary> /// <param name="document">The affected document.</param> /// <param name="change">The change performed.</param> /// <param name="changeData">The dumped change data.</param> /// <param name="state">A state object that is passed to the IndexStorer SaveDate/DeleteData function.</param> /// <returns>The storage result or <c>null</c>.</returns> protected IndexStorerResult OnIndexChange(IDocument document, IndexChangeType change, DumpedChange changeData, object state) { if (IndexChanged != null) { IndexChangedEventArgs args = new IndexChangedEventArgs(document, change, changeData, state); IndexChanged(this, args); return(args.Result); } else { return(null); } }
/// <summary> /// Stores a document in the index. /// </summary> /// <param name="document">The document.</param> /// <param name="keywords">The document keywords, if any, an empty array or <c>null</c> otherwise.</param> /// <param name="content">The content of the document.</param> /// <param name="state">A state object that is passed to the IndexStorer SaveDate/DeleteData function.</param> /// <returns>The number of indexed words (including duplicates) in the document title and content.</returns> /// <remarks>Indexing the content of the document is <b>O(n)</b>, /// where <b>n</b> is the total number of words in the document. /// If the specified document was already in the index, all the old occurrences /// are deleted from the index.</remarks> /// <exception cref="ArgumentNullException">If <paramref name="document"/> or <paramref name="content"/> are <c>null</c>.</exception> public int StoreDocument(IDocument document, string[] keywords, string content, object state) { if (document == null) { throw new ArgumentNullException("document"); } if (keywords == null) { keywords = new string[0]; } if (content == null) { throw new ArgumentNullException("content"); } lock (this) { DumpedChange removeChange = RemoveDocumentInternal(document); if (removeChange != null) { OnIndexChange(document, IndexChangeType.DocumentRemoved, removeChange, state); } } keywords = Tools.CleanupKeywords(keywords); // When the IndexStorer handles the IndexChanged event and a document is added, the storer generates a new ID and returns it // via the event handler, then the in-memory index is updated (the document instance is shared across all words) - the final ID // is generated by the actual IndexStorer implementation (SaveData properly populates the Result field in the args) List <DumpedWord> dw = new List <DumpedWord>(content.Length / 5); List <DumpedWordMapping> dm = new List <DumpedWordMapping>(content.Length / 5); Word tempWord = null; List <Word> newWords = new List <Word>(50); DumpedWord tempDumpedWord = null; int count = 0; uint sequentialWordId = uint.MaxValue; // Store content words WordInfo[] words = document.Tokenize(content); words = Tools.RemoveStopWords(words, _stopWords); foreach (WordInfo info in words) { dm.Add(StoreWord(info.Text, document, info.FirstCharIndex, info.WordIndex, WordLocation.Content, out tempWord, out tempDumpedWord)); if (tempDumpedWord != null && tempWord != null) { dm[dm.Count - 1].WordID = sequentialWordId; tempDumpedWord.ID = sequentialWordId; dw.Add(tempDumpedWord); tempWord.ID = sequentialWordId; newWords.Add(tempWord); sequentialWordId--; } } count += words.Length; // Store title words words = document.Tokenize(document.Title); words = Tools.RemoveStopWords(words, _stopWords); foreach (WordInfo info in words) { dm.Add(StoreWord(info.Text, document, info.FirstCharIndex, info.WordIndex, WordLocation.Title, out tempWord, out tempDumpedWord)); if (tempDumpedWord != null && tempWord != null) { dm[dm.Count - 1].WordID = sequentialWordId; tempDumpedWord.ID = sequentialWordId; dw.Add(tempDumpedWord); tempWord.ID = sequentialWordId; newWords.Add(tempWord); sequentialWordId--; } } count += words.Length; ushort tempCount = 0; // Store keywords for (ushort i = 0; i < (ushort)keywords.Length; i++) { dm.Add(StoreWord(keywords[i], document, tempCount, i, WordLocation.Keywords, out tempWord, out tempDumpedWord)); if (tempDumpedWord != null && tempWord != null) { dm[dm.Count - 1].WordID = sequentialWordId; tempDumpedWord.ID = sequentialWordId; dw.Add(tempDumpedWord); tempWord.ID = sequentialWordId; newWords.Add(tempWord); sequentialWordId--; } tempCount += (ushort)(1 + keywords[i].Length); } count += keywords.Length; IndexStorerResult result = OnIndexChange(document, IndexChangeType.DocumentAdded, new DumpedChange(new DumpedDocument(document), dw, dm), state); // Update document ID if (result != null && result.DocumentID.HasValue) { document.ID = result.DocumentID.Value; } else { // HACK: result is null -> index is corrupted, silently return return(0); } // Update word IDs in newWords bool wordIdUpdated = false; foreach (Word word in newWords) { wordIdUpdated = false; foreach (WordId id in result.WordIDs) { if (id.Text == word.Text) { word.ID = id.ID; wordIdUpdated = true; break; } } if (!wordIdUpdated) { throw new InvalidOperationException("No ID for new word"); } } return(count); }
/// <summary> /// Stores new data into the data storage. /// </summary> /// <param name="data">The data to store.</param> /// <param name="state">A state object passed by the index.</param> /// <returns>The storer result, if any.</returns> /// <remarks>When saving a new document, the document ID in data.Mappings must be /// replaced with the currect document ID, generated by the concrete implementation of /// this method. data.Words should have IDs numbered from uint.MaxValue downwards. /// The method re-numbers the words appropriately.</remarks> protected abstract IndexStorerResult SaveData(DumpedChange data, object state);
/// <summary> /// Deletes data from the data storage. /// </summary> /// <param name="data">The data to delete.</param> /// <param name="state">A state object passed from the index.</param> protected abstract void DeleteData(DumpedChange data, object state);