|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.hibernate.tool.hbm2x.AbstractExporter
org.hibernate.tool.hbm2x.DocExporter
public class DocExporter
Exporter implementation that creates Hibernate Documentation. Creates Tables and Classes Details
Field Summary | |
---|---|
static boolean |
IS_LINUX
|
static String |
OS_NAME
|
Fields inherited from class org.hibernate.tool.hbm2x.AbstractExporter |
---|
log, templatePaths |
Constructor Summary | |
---|---|
DocExporter()
|
|
DocExporter(org.hibernate.cfg.Configuration cfg,
File outputdir)
Creates a new object. |
Method Summary | |
---|---|
void |
doStart()
|
void |
generateCommmonAndAssets()
Generate common files and copy assets. |
void |
generateEntitiesAllEntitiesList()
Generates the html file containing list of classes (allclases.html) |
void |
generateEntitiesAllPackagesList()
Generates the html file containig list of packages (allpackages.html) |
void |
generateEntitiesDetails()
generates one html file for each class containing detail information of class |
void |
generateEntitiesIndex()
Generate the index file of the class documentation |
void |
generateEntitiesPackageDetailedInfo()
Generates the html file containing list of classes and interfaces for given package |
void |
generateEntitiesPackageEntityList()
generates the list of classes sepcific to package |
void |
generatePackageSummary(boolean graphsGenerated)
Generate summary (summaty.html) to show all the packages |
void |
generateTablesAllSchemasList()
Generate a file with a list of all the schemas in the configuration. |
void |
generateTablesAllTablesList()
Generate a file with a list of all the tables in the configuration. |
void |
generateTablesDetails()
Generate one file per table with detail information. |
void |
generateTablesIndex()
Generate the index file of the table documentation. |
void |
generateTablesSchemaDetailedInfo()
Generate two files per schema. |
void |
generateTablesSchemaTableList()
|
void |
generateTablesSummary(boolean graphsGenerated)
Generate a file with an summary of all the tables. |
String |
getName()
|
protected void |
processTemplate(Map parameters,
String templateName,
File outputFile)
Run templates. |
protected void |
setupContext()
Setup the context variables used by the exporter. |
Methods inherited from class org.hibernate.tool.hbm2x.AbstractExporter |
---|
cleanUpContext, getArtifactCollector, getCfg2HbmTool, getCfg2JavaTool, getConfiguration, getFileForClassName, getOutputDirectory, getProperties, getTemplateHelper, getTemplatePath, getTemplatePaths, setArtifactCollector, setConfiguration, setOutputDirectory, setProperties, setTemplateHelper, setTemplatePath, setupTemplates, start |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String OS_NAME
public static final boolean IS_LINUX
Constructor Detail |
---|
public DocExporter(org.hibernate.cfg.Configuration cfg, File outputdir)
cfg
- hibernate configuration.outputdir
- the output directory.templatePaths
- the template paths.public DocExporter()
Method Detail |
---|
public void doStart() throws ExporterException
doStart
in class AbstractExporter
ExporterException
protected void setupContext()
AbstractExporter
setupContext
in class AbstractExporter
public void generateCommmonAndAssets()
public void generateTablesIndex()
public void generateEntitiesIndex()
public void generateTablesSummary(boolean graphsGenerated)
graphsGenerated
- public void generatePackageSummary(boolean graphsGenerated)
public void generateTablesDetails()
public void generateEntitiesDetails()
public void generateEntitiesAllPackagesList()
public void generateEntitiesAllEntitiesList()
public void generateEntitiesPackageEntityList()
public void generateEntitiesPackageDetailedInfo()
public void generateTablesAllSchemasList()
public void generateTablesAllTablesList()
public void generateTablesSchemaTableList()
public void generateTablesSchemaDetailedInfo()
protected void processTemplate(Map parameters, String templateName, File outputFile)
parameters
- the parameters to pass to the templates template.templateName
- the template to use.outputFile
- the output file.public String getName()
getName
in class AbstractExporter
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |