DefaultPlugin (Ontopia)

java.lang.Object
- net.ontopia.topicmaps.nav2.plugins.DefaultPlugin

All Implemented Interfaces:

PluginIF

Direct Known Subclasses:

FulltextPlugin, GooglePlugin, RDF2TMPlugin, ReloadPlugin, TextPlugin, TopicMapLinkPlugin, ValidationPlugin, VizPlugin
```
public class DefaultPlugin
extends Object
implements PluginIF
```
INTERNAL: This is the plugin implementation that is used if no other implementation is requested in the plugin.xml file.

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`description`
`protected String`	`directory`
`protected List`	`groups`
`protected String`	`id`
`protected Map`	`params`
`static String`	`RP_TOPIC_ID`
`static String`	`RP_TOPICMAP_ID`
`protected int`	`state`
`protected String`	`target`
`protected String`	`title`
`protected String`	`uri`

Fields inherited from interface net.ontopia.topicmaps.nav2.plugins.PluginIF
ACTIVATED, DEACTIVATED, ERROR

Constructor Summary

Constructors
Constructor and Description

DefaultPlugin()

Constructors
Constructor and Description
`DefaultPlugin()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addGroup(String groupId)` INTERNAL: Add the specified group to groups this plugin belongs to.
`boolean`	`equals(Object obj)`
`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.
`String`	`getDescription()` INTERNAL: Gets the description of this plugin.
`List`	`getGroups()` INTERNAL: Returns the groups this plugin belongs to.
`String`	`getId()` INTERNAL: Returns the ID of this plugin.
`String`	`getParameter(String name)` INTERNAL: Returns the value of the parameter.
`String`	`getPluginDirectory()` INTERNAL: Returns the path to the plugin directory.
`int`	`getState()` INTERNAL: Returns the state of this plugin.
`protected String`	`getStateAsString()`
`String`	`getTarget()` INTERNAL: Returns the URI frame target of this plugin.
`String`	`getTitle()` INTERNAL: Returns the title of this plugin.
`String`	`getURI()` INTERNAL: Returns the URI of this plugin.
`int`	`hashCode()`
`void`	`init()` INTERNAL: Called by the framework to finalize initialization.
`void`	`resetGroups()` INTERNAL: Reset all group settings for this plugin.
`void`	`setDescription(String description)` INTERNAL: Sets the description of this plugin.
`void`	`setGroups(List groups)` INTERNAL: Sets the groups this plugin belongs to.
`void`	`setId(String id)` INTERNAL: Sets the ID of this plugin.
`void`	`setParameter(String name, String value)` INTERNAL: Called by the framework to give the plugin the value of a configuration parameter.
`void`	`setPluginDirectory(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(String target)` INTERNAL: Sets the URI frame target of this plugin.
`void`	`setTitle(String title)` INTERNAL: Sets the title of this plugin.
`void`	`setURI(String uri)` INTERNAL: Sets the URI of this plugin.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - state
```
protected int state
```
  - title
```
protected String title
```
  - description
```
protected String description
```
  - uri
```
protected String uri
```
  - target
```
protected String target
```
  - id
```
protected String id
```
  - directory
```
protected String directory
```
  - params
```
protected Map params
```
  - groups
```
protected List groups
```
  - RP_TOPICMAP_ID
```
public static final String RP_TOPICMAP_ID
```
    See Also:
    
    Constant Field Values
  - RP_TOPIC_ID
```
public static final String RP_TOPIC_ID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DefaultPlugin
```
public DefaultPlugin()
```
- Method Detail
  - init
```
public void init()
```
    Description copied from interface: PluginIF
    
    INTERNAL: Called by the framework to finalize initialization. Called when there are no more parameters.
    
    Specified by:
    
    init in interface PluginIF
  - generateHTML
```
public String generateHTML(ContextTag context)
```
    Description copied from interface: PluginIF
    
    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.
    
    Specified by:
    
    generateHTML in interface PluginIF
    
    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.
  - getId
```
public String getId()
```
    Description copied from interface: PluginIF
    
    INTERNAL: Returns the ID of this plugin.
    
    Specified by:
    
    getId in interface PluginIF
  - setId
```
public void setId(String id)
```
    Description copied from interface: PluginIF
    
    INTERNAL: Sets the ID of this plugin.
    
    Specified by:
    
    setId in interface PluginIF
  - resetGroups
```
public void resetGroups()
```
    Description copied from interface: PluginIF
    
    INTERNAL: Reset all group settings for this plugin. After this operation this plugin will belong to no group.
    
    Specified by:
    
    resetGroups in interface PluginIF
  - getGroups
```
public List getGroups()
```
    Description copied from interface: PluginIF
    
    INTERNAL: Returns the groups this plugin belongs to. Each group is represented by a string containing the group id.
    
    Specified by:
    
    getGroups in interface PluginIF
  - addGroup
```
public void addGroup(String groupId)
```
    Description copied from interface: PluginIF
    
    INTERNAL: Add the specified group to groups this plugin belongs to.
    
    Specified by:
    
    addGroup in interface PluginIF
  - setGroups
```
public void setGroups(List groups)
```
    Description copied from interface: PluginIF
    
    INTERNAL: Sets the groups this plugin belongs to.
    
    Specified by:
    
    setGroups in interface PluginIF
  - getTitle
```
public String getTitle()
```
    Description copied from interface: PluginIF
    
    INTERNAL: Returns the title of this plugin.
    
    Specified by:
    
    getTitle in interface PluginIF
  - setTitle
```
public void setTitle(String title)
```
    Description copied from interface: PluginIF
    
    INTERNAL: Sets the title of this plugin.
    
    Specified by:
    
    setTitle in interface PluginIF
  - getDescription
```
public String getDescription()
```
    Description copied from interface: PluginIF
    
    INTERNAL: Gets the description of this plugin.
    
    Specified by:
    
    getDescription in interface PluginIF
  - setDescription
```
public void setDescription(String description)
```
    Description copied from interface: PluginIF
    
    INTERNAL: Sets the description of this plugin.
    
    Specified by:
    
    setDescription in interface PluginIF
  - getURI
```
public String getURI()
```
    Description copied from interface: PluginIF
    
    INTERNAL: Returns the URI of this plugin.
    
    Specified by:
    
    getURI in interface PluginIF
  - setURI
```
public void setURI(String uri)
```
    Description copied from interface: PluginIF
    
    INTERNAL: Sets the URI of this plugin.
    Note: This has not to contain the web application context path.
    Example: plugins/hello/hello.jsp
    
    Specified by:
    
    setURI in interface PluginIF
  - getTarget
```
public String getTarget()
```
    Description copied from interface: PluginIF
    
    INTERNAL: Returns the URI frame target of this plugin.
    
    Specified by:
    
    getTarget in interface PluginIF
  - setTarget
```
public void setTarget(String target)
```
    Description copied from interface: PluginIF
    
    INTERNAL: Sets the URI frame target of this plugin.
    
    Specified by:
    
    setTarget in interface PluginIF
  - getState
```
public int getState()
```
    Description copied from interface: PluginIF
    
    INTERNAL: Returns the state of this plugin.
    
    Specified by:
    
    getState in interface PluginIF
  - setState
```
public void setState(int state)
```
    Description copied from interface: PluginIF
    
    INTERNAL: Sets the state of this plugin.
    
    Specified by:
    
    setState in interface PluginIF
  - getParameter
```
public String getParameter(String name)
```
    Description copied from interface: PluginIF
    
    INTERNAL: Returns the value of the parameter.
    
    Specified by:
    
    getParameter in interface PluginIF
  - setParameter
```
public void setParameter(String name,
                         String value)
```
    Description copied from interface: PluginIF
    
    INTERNAL: Called by the framework to give the plugin the value of a configuration parameter.
    
    Specified by:
    
    setParameter in interface PluginIF
  - getPluginDirectory
```
public String getPluginDirectory()
```
    Description copied from interface: PluginIF
    
    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.
    
    Specified by:
    
    getPluginDirectory in interface PluginIF
  - setPluginDirectory
```
public void setPluginDirectory(String path)
```
    Description copied from interface: PluginIF
    
    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.
    
    Specified by:
    
    setPluginDirectory in interface PluginIF
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getStateAsString
```
protected String getStateAsString()
```

Class DefaultPlugin

Field Summary

Fields inherited from interface net.ontopia.topicmaps.nav2.plugins.PluginIF

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

state

title

description

uri

target

id

directory

params

groups

RP_TOPICMAP_ID

RP_TOPIC_ID

Constructor Detail

DefaultPlugin

Method Detail

init

generateHTML

getId

setId

resetGroups

getGroups

addGroup

setGroups

getTitle

setTitle

getDescription

setDescription

getURI

setURI

getTarget

setTarget

getState

setState

getParameter

setParameter

getPluginDirectory

setPluginDirectory

hashCode

equals

toString

getStateAsString