|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.getopt.luke.LukePlugin
public abstract class LukePlugin
LukePlugin is a superclass of any plugin that wants to be loaded automatically, and to work with the current index.
Field Summary | |
---|---|
protected Luke |
app
|
protected org.apache.lucene.store.Directory |
dir
|
protected org.apache.lucene.index.IndexReader |
ir
|
protected java.lang.Object |
myUi
|
Constructor Summary | |
---|---|
LukePlugin()
|
Method Summary | |
---|---|
Luke |
getApplication()
Get current application context. |
org.apache.lucene.store.Directory |
getDirectory()
|
org.apache.lucene.index.IndexReader |
getIndexReader()
Returns a reference to the IndexReader currently open in the application. |
java.lang.Object |
getMyUi()
Returns this plugin's UI object. |
abstract java.lang.String |
getPluginHome()
Return URL to plugin home page or author's e-mail. |
abstract java.lang.String |
getPluginInfo()
Return short one-line info about the plugin. |
abstract java.lang.String |
getPluginName()
Returns a plugin name. |
abstract java.lang.String |
getXULName()
This method should return a fully qualified name/path of the XUL resource used to build the UI for the plugin. |
abstract boolean |
init()
Initialize this component. |
void |
setApplication(Luke app)
Set application context. |
void |
setDirectory(org.apache.lucene.store.Directory dir)
|
void |
setIndexReader(org.apache.lucene.index.IndexReader ir)
Set a reference to the IndexReader currently open in the application. |
void |
setMyUi(java.lang.Object ui)
Set a reference to this plugin's UI object (a panel). |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected Luke app
protected java.lang.Object myUi
protected org.apache.lucene.index.IndexReader ir
protected org.apache.lucene.store.Directory dir
Constructor Detail |
---|
public LukePlugin()
Method Detail |
---|
public void setApplication(Luke app)
app
- parent application.public Luke getApplication()
public void setMyUi(java.lang.Object ui)
ui
- this plugin's UI objectpublic java.lang.Object getMyUi()
public void setIndexReader(org.apache.lucene.index.IndexReader ir)
ir
- IndexReader for the current indexpublic org.apache.lucene.index.IndexReader getIndexReader()
public void setDirectory(org.apache.lucene.store.Directory dir)
public org.apache.lucene.store.Directory getDirectory()
public abstract boolean init() throws java.lang.Exception
java.lang.Exception
- when an unrecoverable error occurspublic abstract java.lang.String getXULName()
public abstract java.lang.String getPluginName()
public abstract java.lang.String getPluginInfo()
public abstract java.lang.String getPluginHome()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |