Class BaseLuceneSearchProvider

Abstract Base Implementation of a Full Text Search Provider using Lucene.Net.
Inheritance
System.Object
BaseLuceneSearchProvider
LuceneSearchProvider
Namespace: VDS.RDF.Query.FullText.Search.Lucene
Assembly: dotNetRDF.Query.FullText.dll
Syntax
public abstract class BaseLuceneSearchProvider : object, IFullTextSearchProvider, IConfigurationSerializable
Remarks
Derived Implementations may only need to call the base constructor as the LuceneSearchProvider does but if you've implemented custom indexing you may need to extend more of this class.

Constructors

| Improve this Doc View Source

BaseLuceneSearchProvider(Lucene.Net.Util.Version, Directory, Analyzer, IFullTextIndexSchema)

Creates a new Base Lucene Search Provider.
Declaration
public BaseLuceneSearchProvider(Lucene.Net.Util.Version ver, Directory indexDir, Analyzer analyzer, IFullTextIndexSchema schema)
Parameters
Type Name Description
Lucene.Net.Util.Version ver Lucene Version.
Directory indexDir Directory.
Analyzer analyzer Analyzer.
IFullTextIndexSchema schema Index Schema.
| Improve this Doc View Source

BaseLuceneSearchProvider(Lucene.Net.Util.Version, Directory, Analyzer, IFullTextIndexSchema, Boolean)

Creates a new Base Lucene Search Provider.
Declaration
public BaseLuceneSearchProvider(Lucene.Net.Util.Version ver, Directory indexDir, Analyzer analyzer, IFullTextIndexSchema schema, bool autoSync)
Parameters
Type Name Description
Lucene.Net.Util.Version ver Lucene Version.
Directory indexDir Directory.
Analyzer analyzer Analyzer.
IFullTextIndexSchema schema Index Schema.
System.Boolean autoSync Whether the Search Provider should stay in sync with the underlying index.

Properties

| Improve this Doc View Source

IsAutoSynced

Gets whether this search provider is always seeing the latest state of the index.
Declaration
public bool IsAutoSynced { get; }
Property Value
Type Description
System.Boolean

Methods

| Improve this Doc View Source

Dispose()

Disposes of the Search Provider.
Declaration
public void Dispose()
| Improve this Doc View Source

DisposeInternal()

Virtual method that can be overridden to add implementation specific dispose logic.
Declaration
protected virtual void DisposeInternal()
| Improve this Doc View Source

Finalize()

Destructor which ensures that the Search Provider is properly disposed of
Declaration
protected void Finalize()
| Improve this Doc View Source

Match(IEnumerable<Uri>, String)

Gets results that match the given query.
Declaration
public virtual IEnumerable<IFullTextSearchResult> Match(IEnumerable<Uri> graphUris, string text)
Parameters
Type Name Description
IEnumerable<Uri> graphUris Graph URIs.
System.String text Search Query.
Returns
Type Description
IEnumerable<IFullTextSearchResult>
| Improve this Doc View Source

Match(IEnumerable<Uri>, String, Double)

Gets results that match the given query with the score threshold applied.
Declaration
public virtual IEnumerable<IFullTextSearchResult> Match(IEnumerable<Uri> graphUris, string text, double scoreThreshold)
Parameters
Type Name Description
IEnumerable<Uri> graphUris Graph URIs.
System.String text Search Query.
System.Double scoreThreshold Score Threshold.
Returns
Type Description
IEnumerable<IFullTextSearchResult>
| Improve this Doc View Source

Match(IEnumerable<Uri>, String, Double, Int32)

Gets results that match the given query with the score threshold and limit applied.
Declaration
public virtual IEnumerable<IFullTextSearchResult> Match(IEnumerable<Uri> graphUris, string text, double scoreThreshold, int limit)
Parameters
Type Name Description
IEnumerable<Uri> graphUris Graph URIs.
System.String text Search Query.
System.Double scoreThreshold Score Threshold.
System.Int32 limit Result Limit.
Returns
Type Description
IEnumerable<IFullTextSearchResult>
| Improve this Doc View Source

Match(IEnumerable<Uri>, String, Int32)

Gets results that match the given query with a limit applied.
Declaration
public virtual IEnumerable<IFullTextSearchResult> Match(IEnumerable<Uri> graphUris, string text, int limit)
Parameters
Type Name Description
IEnumerable<Uri> graphUris Graph URIs.
System.String text Search Query.
System.Int32 limit Result Limit.
Returns
Type Description
IEnumerable<IFullTextSearchResult>
| Improve this Doc View Source

Match(String)

Gets results that match the given query.
Declaration
public virtual IEnumerable<IFullTextSearchResult> Match(string text)
Parameters
Type Name Description
System.String text Search Query.
Returns
Type Description
IEnumerable<IFullTextSearchResult>
| Improve this Doc View Source

Match(String, Double)

Gets results that match the given query with the score threshold applied.
Declaration
public virtual IEnumerable<IFullTextSearchResult> Match(string text, double scoreThreshold)
Parameters
Type Name Description
System.String text Search Query.
System.Double scoreThreshold Score Threshold.
Returns
Type Description
IEnumerable<IFullTextSearchResult>
| Improve this Doc View Source

Match(String, Double, Int32)

Gets results that match the given query with the score threshold and limit applied.
Declaration
public virtual IEnumerable<IFullTextSearchResult> Match(string text, double scoreThreshold, int limit)
Parameters
Type Name Description
System.String text Search Query.
System.Double scoreThreshold Score Threshold.
System.Int32 limit Result Limit.
Returns
Type Description
IEnumerable<IFullTextSearchResult>
| Improve this Doc View Source

Match(String, Int32)

Gets results that match the given query with a limit applied.
Declaration
public virtual IEnumerable<IFullTextSearchResult> Match(string text, int limit)
Parameters
Type Name Description
System.String text Search Query.
System.Int32 limit Result Limit.
Returns
Type Description
IEnumerable<IFullTextSearchResult>
| Improve this Doc View Source

SerializeConfiguration(ConfigurationSerializationContext)

Serializes Configuration of this Provider.
Declaration
public virtual void SerializeConfiguration(ConfigurationSerializationContext context)
Parameters
Type Name Description
ConfigurationSerializationContext context Serialization Context.

Implements

IDisposable

Extension Methods