|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.hibernate.tool.hbm2x.doc.DocFileManager
public class DocFileManager
Class used to manage the files created during the documentation generation process. This manager is needed to manage references between files.
Constructor Summary | |
---|---|
DocFileManager(DocHelper docHelper,
File pRootFolder)
Constructor. |
Method Summary | |
---|---|
static void |
copy(ClassLoader loader,
String fileName,
File to)
Copy a File. |
DocFile |
getAllEntitiesDocFile()
Returns the DocFile responsible for generating allclasses.html |
DocFile |
getAllPackagesDocFile()
Returns the DocFile responsible for generating allpackages.html |
DocFile |
getAllSchemasDocFile()
Return the all schemas DocFile. |
DocFile |
getAllTablesDocFile()
Return the all tables DocFile. |
DocFolder |
getAssetsDocFolder()
Returns the DocFolder for the helper files. |
DocFile |
getClassIndexDocFile()
Returns the class index DocFile |
DocFile |
getClassSummaryFile()
Returns the summary index DocFile |
DocFile |
getCssStylesDocFile()
Returns the DocFile for the CSS definitions. |
DocFile |
getEntityDocFile(POJOClass pc)
Returns the DocFile responsible to generate the .html for each classes. |
DocFile |
getEntityDocFileByDeclarationName(POJOClass pc)
Get the DocFile corresponding to POJOClass. |
DocFile |
getExtendsImageDocFile()
Returns the DocFile for the extends Image. |
DocFile |
getHibernateImageDocFile()
Returns the DocFile for the Hibernate Image. |
DocFile |
getMainIndexDocFile()
Returns the DocFile for the main index. |
DocFile |
getPackageEntityListDocFile(String packageName)
Returns the DocFile responsible to generate classes.html corresponding to packageName passed |
DocFile |
getPackageSummaryDocFile(String packageName)
get DocFile responsible to generate summary.html for corresponding packageName passed |
String |
getRef(DocFile from,
DocFile to)
Return the relative reference between the specified files. |
DocFolder |
getRootDocFolder()
|
DocFile |
getSchemaSummaryDocFile(String schemaName)
Return the summary DocFile for the specified schema FQN. |
DocFile |
getSchemaTableListDocFile(String schemaName)
Return the Table List DocFile for the specified schema FQN. |
DocFile |
getTableDocFile(org.hibernate.mapping.Table table)
Return the DocFile for the specified Table. |
DocFile |
getTableIndexDocFile()
Return the table index DocFile. |
DocFile |
getTableSummaryDocFile()
Return the table summary DocFile. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DocFileManager(DocHelper docHelper, File pRootFolder)
docHelper
- the doc helper.pRootFolder
- the root folder for the documentation.Method Detail |
---|
public DocFolder getRootDocFolder()
public DocFolder getAssetsDocFolder()
public DocFile getCssStylesDocFile()
public DocFile getHibernateImageDocFile()
public DocFile getExtendsImageDocFile()
public DocFile getMainIndexDocFile()
public DocFile getTableIndexDocFile()
public DocFile getClassIndexDocFile()
public DocFile getClassSummaryFile()
public DocFile getAllPackagesDocFile()
public DocFile getAllEntitiesDocFile()
public DocFile getPackageEntityListDocFile(String packageName)
packageName
- Package name which acts as key to get DocFile value object from packageEntityListDocFile
public DocFile getTableSummaryDocFile()
public DocFile getAllSchemasDocFile()
public DocFile getAllTablesDocFile()
public DocFile getTableDocFile(org.hibernate.mapping.Table table)
table
- the Table.
public DocFile getEntityDocFileByDeclarationName(POJOClass pc)
pc
- DocFile corresponding to this POJOClass
public DocFile getEntityDocFile(POJOClass pc)
pc
- The DocFile corresponding to this pc is retrieved from entityDocFiles
public DocFile getSchemaSummaryDocFile(String schemaName)
schemaName
- the name of the schema.
public DocFile getPackageSummaryDocFile(String packageName)
packageName
- DocFile corresponding to this packagename is retrieved from packageSummaryDocFiles
public DocFile getSchemaTableListDocFile(String schemaName)
schemaName
- the name of the schema.
public String getRef(DocFile from, DocFile to)
from
- the origin.to
- the target.
IllegalArgumentException
- if any parameter is null.public static void copy(ClassLoader loader, String fileName, File to) throws IOException
fileName
- the name of the file to copy.to
- the target file.
IOException
- in case of error.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |