|
DJDoc v.1.0.0b-1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.djdoc.bo.ApiVO net.sf.djdoc.bo.ApiEntity
public class ApiEntity
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 |
---|
public ApiEntity()
public ApiEntity(java.io.File file) throws ConfigurationException
ApiEntity
objects.
file
- The name of the API configuration file
ConfigurationException
- If the initialization of the
ApiEntity
fails, a ConfigurationExeption
is
thrown; see Configuration.configure(File, ApiEntity)
Method Detail |
---|
public static java.util.List<ApiEntity> selectAllApis()
ApiEntity
objects from the
database.
List
of all ApiEntity
objects in the
databasepublic static ApiEntity findByName(java.lang.String name)
ApiEntity
from the
database by its name.
name
- The name of the ApiEntity
to be found
ApiEntity
with the given namepublic int getId()
ApiEntity
's internal ID.
getId
in interface BusinessObject
ApiEntity
public void setId(int id)
ApiEntity
's internal ID.
id
- The internal ID of this ApiEntity
public java.util.Set<Bunch> getBunches()
ApiEntity
object.
ApiEntity
's package setpublic void setBunches(java.util.Set<Bunch> bunches)
ApiEntity
object.
bunches
- This ApiEntity
's package setpublic void addBunch(Bunch bunch)
ApiEntity
; adds a package to that set.
bunch
- The package to be added to this ApiEntity
|
DJDoc v.1.0.0b-1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |