net.sourceforge.schemaspy.view
Class HtmlFormatter

java.lang.Object
  net.sourceforge.schemaspy.view.HtmlFormatter

Direct Known Subclasses:

HtmlAnomaliesPage, HtmlColumnsPage, HtmlConstraintsPage, HtmlGraphFormatter, HtmlMainIndexPage, HtmlMultipleSchemasIndexPage, HtmlTablePage

public class HtmlFormatter
extends Object

Field Summary

protected boolean	displayTableComments
protected boolean	encodeComments

Constructor Summary

protected

HtmlFormatter()

Method Summary

protected String	getDescription(Database db, Table table, String text, boolean hoverHelp)
protected String	getPathToRoot() Override if your output doesn't live in the root directory.
protected boolean	isAnomaliesPage() Override and return true if you're the anomalies page
protected boolean	isColumnsPage() Override and return true if you're the columns page
protected boolean	isConstraintsPage() Override and return true if you're the constraints page
protected boolean	isMainIndex() Override and return true if you're the main index page.
protected boolean	isOneOfMultipleSchemas() Nasty way of dealing with 'global' variables.
protected boolean	isOrphansPage() Override and return true if you're the orphans page.
protected boolean	isRelationshipsPage() Override and return true if you're the relationships page.
protected boolean	sourceForgeLogoEnabled()
protected void	writeExcludedColumns(Set excludedColumns, LineWriter html)
protected void	writeFeedMe(LineWriter html)
protected void	writeFooter(LineWriter html)
protected void	writeGeneratedBy(String connectTime, LineWriter html)
protected void	writeHeader(Database db, Table table, String text, boolean showOrphans, LineWriter out)
protected void	writeInvalidGraphvizInstallation(LineWriter html)
protected void	writeLegend(boolean tableDetails, boolean graphDetails, LineWriter out)
protected void	writeLegend(boolean tableDetails, LineWriter out)
protected void	writeTableOfContents(boolean showOrphans, LineWriter html)

Methods inherited from class java.lang.Object

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

Field Detail

encodeComments

protected final boolean encodeComments

displayTableComments

protected final boolean displayTableComments

Constructor Detail

HtmlFormatter

protected HtmlFormatter()

Method Detail

writeHeader

protected void writeHeader(Database db,
                           Table table,
                           String text,
                           boolean showOrphans,
                           LineWriter out)
                    throws IOException

Throws:

IOException

writeGeneratedBy

protected void writeGeneratedBy(String connectTime,
                                LineWriter html)
                         throws IOException

Throws:

IOException

writeTableOfContents

protected void writeTableOfContents(boolean showOrphans,
                                    LineWriter html)
                             throws IOException

Throws:

IOException

getDescription

protected String getDescription(Database db,
                                Table table,
                                String text,
                                boolean hoverHelp)

sourceForgeLogoEnabled

protected boolean sourceForgeLogoEnabled()

writeLegend

protected void writeLegend(boolean tableDetails,
                           LineWriter out)
                    throws IOException

Throws:

IOException

writeLegend

protected void writeLegend(boolean tableDetails,
                           boolean graphDetails,
                           LineWriter out)
                    throws IOException

Throws:

IOException

writeFeedMe

protected void writeFeedMe(LineWriter html)
                    throws IOException

Throws:

IOException

writeExcludedColumns

protected void writeExcludedColumns(Set excludedColumns,
                                    LineWriter html)
                             throws IOException

Throws:

IOException

writeInvalidGraphvizInstallation

protected void writeInvalidGraphvizInstallation(LineWriter html)
                                         throws IOException

Throws:

IOException

writeFooter

protected void writeFooter(LineWriter html)
                    throws IOException

Throws:

IOException

getPathToRoot

protected String getPathToRoot()

Override if your output doesn't live in the root directory. If non blank must end with a trailing slash.

Returns:

String

isMainIndex

protected boolean isMainIndex()

Override and return true if you're the main index page.

Returns:

boolean

isRelationshipsPage

protected boolean isRelationshipsPage()

Override and return true if you're the relationships page.

Returns:

boolean

isOrphansPage

protected boolean isOrphansPage()

Override and return true if you're the orphans page.

Returns:

boolean

isConstraintsPage

protected boolean isConstraintsPage()

Override and return true if you're the constraints page

Returns:

boolean

isAnomaliesPage

protected boolean isAnomaliesPage()

Override and return true if you're the anomalies page

Returns:

boolean

isColumnsPage

protected boolean isColumnsPage()

Override and return true if you're the columns page

Returns:

boolean

isOneOfMultipleSchemas

protected boolean isOneOfMultipleSchemas()

Nasty way of dealing with 'global' variables. Returns true if we're evaluating a bunch of schemas in one go and at this point we're evaluating a specific schema.

Returns:

boolean