public abstract class ALcyAddOn extends Object
An ALcyAddOn is the basic block in Lucy for contributing functionality.
Every addon needs a default constructor, because the implementing classes will be instantiated by the Lucy frontend when the addon is loaded.
It is the responsibility of the Lucy frontend to load the addons. The default frontend uses
the TLcyXMLAddOnLoader
, which reads an XML file to determine which addons
need to be loaded and what their configuration source names are.
Modifier | Constructor and Description |
---|---|
protected |
ALcyAddOn()
Creates a new
ALcyAddOn . |
Modifier and Type | Method and Description |
---|---|
String |
getConfigSourceName()
Returns the configuration source name.
|
String |
getDisplayName()
Returns the display name of this addon.
|
abstract void |
plugInto(ILcyLucyEnv aLucyEnv)
Plugs this addon into the given lucy environment.
|
void |
setConfigSourceName(String aConfigSourceName)
Sets the configuration source name.
|
void |
setDisplayName(String aDisplayName)
Sets the display name for this addon.
|
abstract void |
unplugFrom(ILcyLucyEnv aLucyEnv)
Unplugs this addon from the given Lucy environment.
|
public String getDisplayName()
null
.public void setDisplayName(String aDisplayName)
aDisplayName
- The display name for this addon. This name may be null
.public abstract void plugInto(ILcyLucyEnv aLucyEnv)
aLucyEnv
- The lucy environment to plug into.unplugFrom(com.luciad.lucy.ILcyLucyEnv)
public abstract void unplugFrom(ILcyLucyEnv aLucyEnv)
aLucyEnv
- The lucy environment to unplug from.plugInto(com.luciad.lucy.ILcyLucyEnv)
public String getConfigSourceName()
null
.public void setConfigSourceName(String aConfigSourceName)
aConfigSourceName
- The configuration source name. It may be null
.