net.ontopia.topicmaps.nav2.plugins
Interface PluginIF

All Known Implementing Classes:

DefaultPlugin, FulltextPlugin, GooglePlugin, RDF2TMPlugin, ReloadPlugin, TextPlugin, TopicMapLinkPlugin, ValidationPlugin, VizPlugin

public interface PluginIF

INTERNAL: The common interface for all navigator plugin objects. This interface can either be implemented by the plugin, or a default implementation (DefaultPlugin) can be used.

Field Summary

static int	ACTIVATED
static int	DEACTIVATED
static int	ERROR

Method Summary

void	addGroup(java.lang.String groupId) INTERNAL: Add the specified group to groups this plugin belongs to.
java.lang.String	generateHTML(ContextTag context) INTERNAL: Called by the framework to make the plugin produce the HTML that is going to represent it on a web page in the web application.
java.lang.String	getDescription() INTERNAL: Gets the description of this plugin.
java.util.List	getGroups() INTERNAL: Returns the groups this plugin belongs to.
java.lang.String	getId() INTERNAL: Returns the ID of this plugin.
java.lang.String	getParameter(java.lang.String name) INTERNAL: Returns the value of the parameter.
java.lang.String	getPluginDirectory() INTERNAL: Returns the path to the plugin directory.
int	getState() INTERNAL: Returns the state of this plugin.
java.lang.String	getTarget() INTERNAL: Returns the URI frame target of this plugin.
java.lang.String	getTitle() INTERNAL: Returns the title of this plugin.
java.lang.String	getURI() INTERNAL: Returns the URI of this plugin.
void	init() INTERNAL: Called by the framework to finalize initialization.
void	resetGroups() INTERNAL: Reset all group settings for this plugin.
void	setDescription(java.lang.String description) INTERNAL: Sets the description of this plugin.
void	setGroups(java.util.List groups) INTERNAL: Sets the groups this plugin belongs to.
void	setId(java.lang.String id) INTERNAL: Sets the ID of this plugin.
void	setParameter(java.lang.String name, java.lang.String value) INTERNAL: Called by the framework to give the plugin the value of a configuration parameter.
void	setPluginDirectory(java.lang.String path) INTERNAL: Called by the framework to give the plugin the directory its plugin.xml file was found in.
void	setState(int state) INTERNAL: Sets the state of this plugin.
void	setTarget(java.lang.String target) INTERNAL: Sets the URI frame target of this plugin.
void	setTitle(java.lang.String title) INTERNAL: Sets the title of this plugin.
void	setURI(java.lang.String uri) INTERNAL: Sets the URI of this plugin.

Field Detail

ACTIVATED

static final int ACTIVATED

See Also:

Constant Field Values

DEACTIVATED

static final int DEACTIVATED

See Also:

Constant Field Values

ERROR

static final int ERROR

See Also:

Constant Field Values

Method Detail

generateHTML

java.lang.String generateHTML(ContextTag context)

INTERNAL: Called by the framework to make the plugin produce the HTML that is going to represent it on a web page in the web application.

Returns:

An HTML string to be written into the page. If the returned string is null it means that the plugin does not wish to be displayed on this page.

init

void init()

INTERNAL: Called by the framework to finalize initialization. Called when there are no more parameters.

getId

java.lang.String getId()

INTERNAL: Returns the ID of this plugin.

setId

void setId(java.lang.String id)

INTERNAL: Sets the ID of this plugin.

getGroups

java.util.List getGroups()

INTERNAL: Returns the groups this plugin belongs to. Each group is represented by a string containing the group id.

resetGroups

void resetGroups()

INTERNAL: Reset all group settings for this plugin. After this operation this plugin will belong to no group.

addGroup

void addGroup(java.lang.String groupId)

INTERNAL: Add the specified group to groups this plugin belongs to.

setGroups

void setGroups(java.util.List groups)

INTERNAL: Sets the groups this plugin belongs to.

getTitle

java.lang.String getTitle()

INTERNAL: Returns the title of this plugin.

setTitle

void setTitle(java.lang.String title)

INTERNAL: Sets the title of this plugin.

getDescription

java.lang.String getDescription()

INTERNAL: Gets the description of this plugin.

setDescription

void setDescription(java.lang.String description)

INTERNAL: Sets the description of this plugin.

getURI

java.lang.String getURI()

INTERNAL: Returns the URI of this plugin.

setURI

void setURI(java.lang.String uri)

INTERNAL: Sets the URI of this plugin.

Note: This has not to contain the web application context path.

Example: plugins/hello/hello.jsp

getTarget

java.lang.String getTarget()

INTERNAL: Returns the URI frame target of this plugin.

setTarget

void setTarget(java.lang.String target)

INTERNAL: Sets the URI frame target of this plugin.

getState

int getState()

INTERNAL: Returns the state of this plugin.

setState

void setState(int state)

INTERNAL: Sets the state of this plugin.

getParameter

java.lang.String getParameter(java.lang.String name)

INTERNAL: Returns the value of the parameter.

setParameter

void setParameter(java.lang.String name,
                  java.lang.String value)

INTERNAL: Called by the framework to give the plugin the value of a configuration parameter.

getPluginDirectory

java.lang.String getPluginDirectory()

INTERNAL: Returns the path to the plugin directory. This is the path in the file system the server is running in, if the web application is deployed as an unexploded WAR.

setPluginDirectory

void setPluginDirectory(java.lang.String path)

INTERNAL: Called by the framework to give the plugin the directory its plugin.xml file was found in. This is useful for plugins which wish to use other files found in the same directory.