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
Afficher le fichier Open project: mammo/LukeSharp Class Usage Examples

Protected Properties

Свойство Type Description
dir Lucene.Net.Store.Directory
ir Lucene.Net.Index.IndexReader
myUi System.Windows.Forms.Control

Méthodes publiques

Méthode 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 méthode

public GetDirectory ( ) : Lucene.Net.Store.Directory
Résultat Lucene.Net.Store.Directory

GetIndexReader() public méthode

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

GetPluginHome() public méthode

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
Résultat String

GetPluginInfo() public méthode

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

GetPluginName() public méthode

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
Résultat String

Init() public méthode

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
Résultat bool

SetDirectory() public méthode

public SetDirectory ( Lucene.Net.Store.Directory dir ) : void
dir Lucene.Net.Store.Directory
Résultat void

SetIndexReader() public méthode

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
Résultat void

Property Details

dir protected_oe property

protected Directory,Lucene.Net.Store dir
Résultat Lucene.Net.Store.Directory

ir protected_oe property

protected IndexReader,Lucene.Net.Index ir
Résultat Lucene.Net.Index.IndexReader

myUi protected_oe property

protected Control,System.Windows.Forms myUi
Résultat System.Windows.Forms.Control