net.sf.djdoc.bo
Class BunchEntity

java.lang.Object
  net.sf.djdoc.bo.BunchVO
      net.sf.djdoc.bo.BunchEntity

All Implemented Interfaces:

java.lang.Comparable, Bunch, BusinessObject, Hittable

public class BunchEntity
extends BunchVO
implements BusinessObject

The BunchEntity is a persistence capable (via Hibernate) class. In addition to the "basic" properties of the BunchVO class it extends, it has a collection valued persistent property of all the package's items (interfaces, classes etc.), a collection valued persistent property of all the package's hits and an object valued property of the API the package belongs to.

Field Summary

Fields inherited from interface net.sf.djdoc.bo.Hittable

FAVORITE, NATURAL, RECENT

Constructor Summary

BunchEntity()

Method Summary

void	addItem(Item item) "Member accessor method" of the set of items of this BunchEntity; adds an Item to that set.
static BunchEntity	findByApiAndName(ApiEntity api, java.lang.String bunchName) "Finder" method retrieving a particular BunchEntity from the database by the API it is part of and by its name.
Api	getApi() Getter method for this BunchEntity's Api.
java.util.Set<BunchHitEntity>	getBunchHits() Getter method for the set of BunchHitEntity objects of this BunchEntity.
int	getId() Getter method for this BunchEntity's internal ID.
java.util.Set<Item>	getItems() Getter method for the set of items of this BunchEntity object.
void	setApi(Api api) Setter method for this BunchEntity's Api.
void	setBunchHits(java.util.Set<BunchHitEntity> bunchHits) Setter method for the set of BunchHitEntity objects of this BunchEntity.
void	setId(int id) Getter method for this BunchEntity's internal ID.
void	setItems(java.util.Set<Item> items) Setter method for the set of items of this BunchEntity object.

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

compareTo, getHitCount, getHitDate, getName, hit, setHitCount, setHitDate, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

BunchEntity

public BunchEntity()

Method Detail

findByApiAndName

public static BunchEntity findByApiAndName(ApiEntity api,
                                           java.lang.String bunchName)

"Finder" method retrieving a particular BunchEntity from the database by the API it is part of and by its name.

Parameters:

api - The ApiEntity of the BunchEntity to be found

bunchName - The name of the BunchEntity to be found

Returns:

The BunchEntity with the given API and name

getId

public int getId()

Getter method for this BunchEntity's internal ID.

Specified by:

getId in interface BusinessObject

Returns:

The internal ID of this BunchEntity

setId

public void setId(int id)

Getter method for this BunchEntity's internal ID.

Parameters:

id - The internal ID of this BunchEntity

getApi

public Api getApi()

Getter method for this BunchEntity's Api.

Returns:

The Api object of this BunchEntity

setApi

public void setApi(Api api)

Setter method for this BunchEntity's Api.

Parameters:

api - The Api object of this BunchEntity

getItems

public java.util.Set<Item> getItems()

Getter method for the set of items of this BunchEntity object.

Returns:

This BunchEntity's item set

setItems

public void setItems(java.util.Set<Item> items)

Setter method for the set of items of this BunchEntity object.

Parameters:

items - This BunchEntity's item set

addItem

public void addItem(Item item)

"Member accessor method" of the set of items of this BunchEntity; adds an Item to that set.

Parameters:

item - The item to be added to this BunchEntity

getBunchHits

public java.util.Set<BunchHitEntity> getBunchHits()

Getter method for the set of BunchHitEntity objects of this BunchEntity.

Returns:

This BunchEntity's BunchHitEntity set

setBunchHits

public void setBunchHits(java.util.Set<BunchHitEntity> bunchHits)

Setter method for the set of BunchHitEntity objects of this BunchEntity.

Parameters:

bunchHits - This BunchEntity's BunchHitEntity set