2.17.2: 2011-06-17

net.sf.basedb.core.data
Class PluginTypeData

java.lang.Object
  extended by net.sf.basedb.core.data.BasicData
      extended by net.sf.basedb.core.data.PluginTypeData
All Implemented Interfaces:
IdentifiableData, NameableData, RegisteredData, RemovableData

public class PluginTypeData
extends BasicData
implements NameableData, RemovableData, RegisteredData

This class represent an interface that a plugin can implement.

Version:
2.0
Author:
Nicklas
See Also:
PluginType, Plugins
Last modified
$Date: 2009-04-06 14:52:39 +0200 (Mon, 06 Apr 2009) $
Hibernate: class
table="`PluginTypes`" lazy="false"

Field Summary
private  String description
           
private  Date entryDate
           
private  String interfaceName
           
private  String jarPath
           
static int MAX_INTERFACENAME_LENGTH
          The maximum length of the interface name that can be stored in the database.
static int MAX_JARPATH_LENGTH
           
private  String name
           
private  Set<PluginDefinitionData> plugins
           
private  boolean removed
           
 
Fields inherited from interface net.sf.basedb.core.data.NameableData
MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH
 
Constructor Summary
PluginTypeData()
           
 
Method Summary
 String getDescription()
          Get the description for the item.
 Date getEntryDate()
          Get the date this item was added to the database.
 String getInterfaceName()
          Get the interface name a plugin must implement to be of this type.
 String getJarPath()
          Get the path to the JAR file where the interface class is located.
 String getName()
          Get the name of the item.
(package private)  Set<PluginDefinitionData> getPlugins()
          The plugin implementing this interface.
 boolean isRemoved()
          Check if the removed flag is set for this item.
 void setDescription(String description)
          Set the description for the item.
 void setEntryDate(Date entryDate)
           
 void setInterfaceName(String interfaceName)
           
 void setJarPath(String jarPath)
           
 void setName(String name)
          Set the name of the item.
(package private)  void setPlugins(Set<PluginDefinitionData> plugins)
           
 void setRemoved(boolean removed)
          Set the removed flag for this item.
 
Methods inherited from class net.sf.basedb.core.data.BasicData
equals, getId, getVersion, hashCode, setId, setVersion, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface net.sf.basedb.core.data.IdentifiableData
getId, getVersion
 

Field Detail

name

private String name

description

private String description

removed

private boolean removed

entryDate

private Date entryDate

MAX_INTERFACENAME_LENGTH

public static final int MAX_INTERFACENAME_LENGTH
The maximum length of the interface name that can be stored in the database.

See Also:
Constant Field Values

interfaceName

private String interfaceName

MAX_JARPATH_LENGTH

public static final int MAX_JARPATH_LENGTH
See Also:
Constant Field Values

jarPath

private String jarPath

plugins

private Set<PluginDefinitionData> plugins
Constructor Detail

PluginTypeData

public PluginTypeData()
Method Detail

getName

public String getName()
Description copied from interface: NameableData
Get the name of the item.

Specified by:
getName in interface NameableData
Returns:
A String with the name of the item

setName

public void setName(String name)
Description copied from interface: NameableData
Set the name of the item. The name cannot be null and mustn't be longer than the value specified by the MAX_NAME_LENGTH constant.

Specified by:
setName in interface NameableData
Parameters:
name - The new name for the item

getDescription

public String getDescription()
Description copied from interface: NameableData
Get the description for the item.

Specified by:
getDescription in interface NameableData
Returns:
A String with a description of the item

setDescription

public void setDescription(String description)
Description copied from interface: NameableData
Set the description for the item. The description can be null but mustn't be longer than the value specified by the MAX_DESCRIPTION_LENGTH constant.

Specified by:
setDescription in interface NameableData
Parameters:
description - The new description for the item

isRemoved

public boolean isRemoved()
Description copied from interface: RemovableData
Check if the removed flag is set for this item.

Specified by:
isRemoved in interface RemovableData
Returns:
TRUE if the item is flagged as removed, FALSE otherwise

setRemoved

public void setRemoved(boolean removed)
Description copied from interface: RemovableData
Set the removed flag for this item.

Specified by:
setRemoved in interface RemovableData
Parameters:
removed - TRUE if the item should be flagged as removed, FALSE otherwise

getEntryDate

public Date getEntryDate()
Description copied from interface: RegisteredData
Get the date this item was added to the database. The value is generated at creation time and can't be modified later.

Specified by:
getEntryDate in interface RegisteredData

setEntryDate

public void setEntryDate(Date entryDate)

getInterfaceName

public String getInterfaceName()
Get the interface name a plugin must implement to be of this type. The specified interface must extend the Plugin interface.

Hibernate: property
column="`interface_name`" type="string" length="255" not-null="true" unique="true"

setInterfaceName

public void setInterfaceName(String interfaceName)

getJarPath

public String getJarPath()
Get the path to the JAR file where the interface class is located. If the value is null the interface must be in the classpath.

Hibernate: property
column="`jar_path`" type="text" not-null="false"

setJarPath

public void setJarPath(String jarPath)

getPlugins

Set<PluginDefinitionData> getPlugins()
The plugin implementing this interface. This is the inverse end.

See Also:
PluginDefinitionData.getPluginTypes()
Hibernate: set
table="`PluginDefinitionTypes`" lazy="true"
Hibernate: collection-key
column="`plugintype_id`"
Hibernate: collection-many-to-many
column="`plugindefinition_id`" class="net.sf.basedb.core.data.PluginDefinitionData"

setPlugins

void setPlugins(Set<PluginDefinitionData> plugins)

2.17.2: 2011-06-17