net.sf.djdoc.bo
Class ApiEntity

java.lang.Object
  net.sf.djdoc.bo.ApiVO
      net.sf.djdoc.bo.ApiEntity

All Implemented Interfaces:

Api, BusinessObject

public class ApiEntity
extends ApiVO
implements BusinessObject

The ApiEntity is a persistence capable (via Hibernate) class. In addition to the "basic" properties of the ApiVO class it extends, it has a collection valued persistent property of all the API's packages.

Constructor Summary

ApiEntity()
Public no-argument constructor; used by Hibernate framework for retrieving existing APIs from the database.

ApiEntity(java.io.File file)
Public constructor, used by DJDoc application for initializing new ApiEntity objects.

Method Summary

void	addBunch(Bunch bunch) "Member accessor method" of the set of packages of this ApiEntity; adds a package to that set.
static ApiEntity	findByName(java.lang.String name) "Finder" method retrieving a particular ApiEntity from the database by its name.
java.util.Set<Bunch>	getBunches() Getter method for the set of packages of this ApiEntity object.
int	getId() Getter method for this ApiEntity's internal ID.
static java.util.List<ApiEntity>	selectAllApis() "Selector" method retrieving all ApiEntity objects from the database.
void	setBunches(java.util.Set<Bunch> bunches) Setter method for the set of packages of this ApiEntity object.
void	setId(int id) Setter method for this ApiEntity's internal ID.

Methods inherited from class net.sf.djdoc.bo.ApiVO

getDescription, getName, getPath, getStylesheetName, getTitle, setDescription, setName, setPath, setStylesheetName, setTitle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiEntity

public ApiEntity()

Public no-argument constructor; used by Hibernate framework for retrieving existing APIs from the database.

ApiEntity

public ApiEntity(java.io.File file)
          throws ConfigurationException

Public constructor, used by DJDoc application for initializing new ApiEntity objects.

Parameters:

file - The name of the API configuration file

Throws:

ConfigurationException - If the initialization of the ApiEntity fails, a ConfigurationExeption is thrown; see Configuration.configure(File, ApiEntity)

Method Detail

selectAllApis

public static java.util.List<ApiEntity> selectAllApis()

"Selector" method retrieving all ApiEntity objects from the database.

Returns:

A List of all ApiEntity objects in the database

findByName

public static ApiEntity findByName(java.lang.String name)

"Finder" method retrieving a particular ApiEntity from the database by its name.

Parameters:

name - The name of the ApiEntity to be found

Returns:

The ApiEntity with the given name

getId

public int getId()

Getter method for this ApiEntity's internal ID.

Specified by:

getId in interface BusinessObject

Returns:

The internal ID of this ApiEntity

setId

public void setId(int id)

Setter method for this ApiEntity's internal ID.

Parameters:

id - The internal ID of this ApiEntity

getBunches

public java.util.Set<Bunch> getBunches()

Getter method for the set of packages of this ApiEntity object.

Returns:

This ApiEntity's package set

setBunches

public void setBunches(java.util.Set<Bunch> bunches)

Setter method for the set of packages of this ApiEntity object.

Parameters:

bunches - This ApiEntity's package set

addBunch

public void addBunch(Bunch bunch)

"Member accessor method" of the set of packages of this ApiEntity; adds a package to that set.

Parameters:

bunch - The package to be added to this ApiEntity