Package org.hibernate.tool.internal.export.doc

Class DocExporter

java.lang.Object

org.hibernate.tool.internal.export.common.AbstractExporter

org.hibernate.tool.internal.export.doc.DocExporter

All Implemented Interfaces:

Exporter, ExporterConstants

public class DocExporter
extends AbstractExporter

Exporter implementation that creates Hibernate Documentation. Creates Tables and Classes Details

Author:

Ricardo C. Moral, Amit Bhayani

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	IS_LINUX
static final String	OS_NAME

Fields inherited from class org.hibernate.tool.internal.export.common.AbstractExporter

log

Fields inherited from interface org.hibernate.tool.api.export.ExporterConstants

ARTIFACT_COLLECTOR, CREATE_DATABASE, DELIMITER, DESTINATION_FOLDER, DROP_DATABASE, EXPORT_TO_CONSOLE, EXPORT_TO_DATABASE, FILE_PATTERN, FOR_EACH, FORMAT, HALT_ON_ERROR, METADATA_DESCRIPTOR, OUTPUT_FILE_NAME, QUERY_LIST, SCHEMA_UPDATE, TEMPLATE_NAME, TEMPLATE_PATH

Constructor Summary

Constructors

Constructor	Description
DocExporter()

Method Summary

Modifier and Type	Method	Description
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<String,Object> parameters, String templateName, File outputFile)	Run templates.
protected void	setupContext()

Methods inherited from class org.hibernate.tool.internal.export.common.AbstractExporter

buildMetadata, cleanUpContext, getArtifactCollector, getCfg2HbmTool, getCfg2JavaTool, getFileForClassName, getMetadata, getMetadataDescriptor, getOutputDirectory, getProperties, getTemplateHelper, setTemplateHelper, setupTemplates, start

Methods inherited from class java.lang.Object

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

Field Details

OS_NAME

public static final String OS_NAME

IS_LINUX

public static final boolean IS_LINUX

Constructor Details

DocExporter

public DocExporter()

Method Details

doStart

public void doStart()

Specified by:

doStart in class AbstractExporter

setupContext

protected void setupContext()

Overrides:

setupContext in class AbstractExporter

generateCommmonAndAssets

public void generateCommmonAndAssets()

Generate common files and copy assets.

generateTablesIndex

public void generateTablesIndex()

Generate the index file of the table documentation.

generateEntitiesIndex

public void generateEntitiesIndex()

Generate the index file of the class documentation

generateTablesSummary

public void generateTablesSummary(boolean graphsGenerated)

Generate a file with an summary of all the tables.

Parameters:

graphsGenerated -

generatePackageSummary

public void generatePackageSummary(boolean graphsGenerated)

Generate summary (summaty.html) to show all the packages

generateTablesDetails

public void generateTablesDetails()

Generate one file per table with detail information.

generateEntitiesDetails

public void generateEntitiesDetails()

generates one html file for each class containing detail information of class

generateEntitiesAllPackagesList

public void generateEntitiesAllPackagesList()

Generates the html file containig list of packages (allpackages.html)

generateEntitiesAllEntitiesList

public void generateEntitiesAllEntitiesList()

Generates the html file containing list of classes (allclases.html)

generateEntitiesPackageEntityList

public void generateEntitiesPackageEntityList()

generates the list of classes sepcific to package

generateEntitiesPackageDetailedInfo

public void generateEntitiesPackageDetailedInfo()

Generates the html file containing list of classes and interfaces for given package

generateTablesAllSchemasList

public void generateTablesAllSchemasList()

Generate a file with a list of all the schemas in the configuration.

generateTablesAllTablesList

public void generateTablesAllTablesList()

Generate a file with a list of all the tables in the configuration.

generateTablesSchemaTableList

public void generateTablesSchemaTableList()

generateTablesSchemaDetailedInfo

public void generateTablesSchemaDetailedInfo()

Generate two files per schema. One with a summary of the tables in the schema and another one with a list of tables.

processTemplate

protected void processTemplate(Map<String,Object> parameters,
 String templateName,
 File outputFile)

Run templates.

Parameters:

parameters - the parameters to pass to the templates template.

templateName - the template to use.

outputFile - the output file.

getName

public String getName()

Overrides:

getName in class AbstractExporter