C# Class Lucene.Net.LukeNet.Plugins.LukePlugin

LukePlugin is a superclass of any plugin that wants to be loaded automatically, and to work with the current index. abial
Inheritance: System.Windows.Forms.UserControl
Show file Open project: mammo/LukeSharp Class Usage Examples

Protected Properties

Property Type Description
dir Lucene.Net.Store.Directory
ir Lucene.Net.Index.IndexReader
myUi System.Windows.Forms.Control

Public Methods

Method Description
GetDirectory ( ) : Lucene.Net.Store.Directory
GetIndexReader ( ) : IndexReader

Returns a reference to the IndexReader currently open in the application.
GetPluginHome ( ) : String

Return URL to plugin home page or author's e-mail. NOTE: this MUST be a fully qualified URL, i.e. including the protocol part.
GetPluginInfo ( ) : String

Return short one-line info about the plugin.
GetPluginName ( ) : String

Returns a plugin name. NOTE: this should be a short (preferably one word) String, because it's length affects the amount of available screen space.
Init ( ) : bool

Initialize this component. Parent view, this view, directory and index reader should already be initialized. This method will be called repeatedly, whenever new index is loaded into Luke.
SetDirectory ( Lucene.Net.Store.Directory dir ) : void
SetIndexReader ( IndexReader ir ) : void

Set a reference to the IndexReader currently open in the application.

Method Details

GetDirectory() public method

public GetDirectory ( ) : Lucene.Net.Store.Directory
return Lucene.Net.Store.Directory

GetIndexReader() public method

Returns a reference to the IndexReader currently open in the application.
public GetIndexReader ( ) : IndexReader
return Lucene.Net.Index.IndexReader

GetPluginHome() public method

Return URL to plugin home page or author's e-mail. NOTE: this MUST be a fully qualified URL, i.e. including the protocol part.
public GetPluginHome ( ) : String
return String

GetPluginInfo() public method

Return short one-line info about the plugin.
public GetPluginInfo ( ) : String
return String

GetPluginName() public method

Returns a plugin name. NOTE: this should be a short (preferably one word) String, because it's length affects the amount of available screen space.
public GetPluginName ( ) : String
return String

Init() public method

Initialize this component. Parent view, this view, directory and index reader should already be initialized. This method will be called repeatedly, whenever new index is loaded into Luke.
public Init ( ) : bool
return bool

SetDirectory() public method

public SetDirectory ( Lucene.Net.Store.Directory dir ) : void
dir Lucene.Net.Store.Directory
return void

SetIndexReader() public method

Set a reference to the IndexReader currently open in the application.
public SetIndexReader ( IndexReader ir ) : void
ir Lucene.Net.Index.IndexReader IndexReader for the current index
return void

Property Details

dir protected property

protected Directory,Lucene.Net.Store dir
return Lucene.Net.Store.Directory

ir protected property

protected IndexReader,Lucene.Net.Index ir
return Lucene.Net.Index.IndexReader

myUi protected property

protected Control,System.Windows.Forms myUi
return System.Windows.Forms.Control