vgquotes/Lib/Portoa.Lucene.xml

104 lines
5.0 KiB
XML

<?xml version="1.0"?>
<doc>
<assembly>
<name>Portoa.Lucene</name>
</assembly>
<members>
<member name="T:Portoa.Lucene.LuceneSearcher`1">
<summary>
<see cref="T:Portoa.Search.ISearcher`1"/> implementation based on <c>Lucene.NET</c>
</summary>
</member>
<member name="M:Portoa.Lucene.LuceneSearcher`1.TransformResults(Lucene.Net.Search.ScoreDoc[],Lucene.Net.Search.IndexSearcher)">
<summary>
Transforms the results of a search into a proper result set
</summary>
<param name="scoreDocs">The search results</param>
<param name="searcher">The searcher that performed the search</param>
</member>
<member name="M:Portoa.Lucene.LuceneSearcher`1.EscapeSearchString(System.String)">
<summary>
Escapes a search string; default implementation calls <c>QueryParser.Escape(<paramref name="searchString"/>)</c>
</summary>
<param name="searchString">The search string to escape</param>
</member>
<member name="P:Portoa.Lucene.LuceneSearcher`1.QueryParser">
<summary>
Gets the query parser associated with this searcher
</summary>
</member>
<member name="P:Portoa.Lucene.LuceneSearcher`1.IndexDirectory">
<summary>
Gets the index directory associated with this searcher
</summary>
</member>
<member name="T:Portoa.Lucene.LuceneEntitySearcher`1">
<summary>
<see cref="T:Portoa.Search.ISearcher`1"/> implementation for entities based on <c>Lucene.NET</c>
</summary>
</member>
<member name="T:Portoa.Lucene.LuceneIndexBuilder`1">
<summary>
<see cref="T:Portoa.Search.ISearchIndexBuilder`1"/> implementation based on <c>Lucene.NET</c>
</summary>
<typeparam name="T">The object to build the index for</typeparam>
</member>
<member name="M:Portoa.Lucene.LuceneIndexBuilder`1.#ctor(Lucene.Net.Index.IndexWriter,Portoa.Lucene.ILuceneDocumentHandler{`0},Portoa.Logging.ILogger)">
<param name="indexWriter">The index writer to use to build/update indexes</param>
<param name="documentHandler">Object to handle manipulation between indexable objects and Lucene documents</param>
<param name="logger">Application logger</param>
</member>
<member name="M:Portoa.Lucene.LuceneIndexBuilder`1.GetAllIndexableRecords">
<summary>
Gets all indexable records; used for (re)building the index from scratch
</summary>
</member>
<member name="M:Portoa.Lucene.LuceneIndexBuilder`1.CanUpdateIndex(`0)">
<summary>
Determines whether <paramref name="objectToVerify"/> can have its index updated
</summary>
</member>
<member name="P:Portoa.Lucene.LuceneIndexBuilder`1.IndexWriter">
<summary>
Gets the index writer to use to build/update indexes
</summary>
</member>
<member name="P:Portoa.Lucene.LuceneIndexBuilder`1.DocumentHandler">
<summary>
Gets the object to handle manipulation between indexable objects and Lucene documents
</summary>
</member>
<member name="P:Portoa.Lucene.LuceneIndexBuilder`1.Logger">
<summary>
Application logger
</summary>
</member>
<member name="T:Portoa.Lucene.LuceneEntityIndexBuilder`1">
<summary>
<see cref="T:Portoa.Search.ISearchIndexBuilder`1"/> implementation for entities based on <c>Lucene.NET</c>
</summary>
<typeparam name="T">The entity to build the index for</typeparam>
</member>
<member name="T:Portoa.Lucene.ILuceneDocumentHandler`1">
<summary>
Handles interaction between objects and Lucene documents
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="M:Portoa.Lucene.ILuceneDocumentHandler`1.BuildDocument(`0)">
<summary>
Builds a <see cref="T:Lucene.Net.Documents.Document"/> out of another object
</summary>
<param name="source">The object from which to build the document</param>
</member>
<member name="M:Portoa.Lucene.ILuceneDocumentHandler`1.GetIdTerm(`0)">
<summary>
Gets a term representing the identifying <see cref="T:Lucene.Net.Documents.Field"/> in a
<see cref="T:Lucene.Net.Documents.Document"/>. This <see cref="T:Lucene.Net.Index.Term"/> can be used as a means
to delete documents using an <see cref="T:Lucene.Net.Index.IndexWriter"/>, for example.
</summary>
<param name="source">The object from which to create the term</param>
</member>
</members>
</doc>