org.dmd.dms.util

Class SchemaDocHtmlFormatter

java.lang.Object

org.dmd.dms.util.SchemaDocHtmlFormatter

public class SchemaDocHtmlFormatter
extends Object

This class generates HTML from Dark Matter Schema (DMS) definitions stored in a SchemaDefinition object.

Although DMS is readable text, it's not particularly easy to navigate in its textual state. However, when presented in HTML format, the descriptions are much more user friendly.

Constructor Summary

Constructors

Constructor and Description
SchemaDocHtmlFormatter(String org, String user, String email) Constructs a new IMD HTML formatter.

Method Summary

Modifier and Type	Method and Description
String	formatTable(Iterator<DmsDefinition> it, int size, int cols) Formats a table of generic objects.
void	generateIndex(String dir)
Iterator<DmsDefinition>	sort(Iterator<DmsDefinition> it) Sorts generic objects - schema definitions on the basis of their names.

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaDocHtmlFormatter

public SchemaDocHtmlFormatter(String org,
                              String user,
                              String email)

Constructs a new IMD HTML formatter.

Method Detail

sort

public Iterator<DmsDefinition> sort(Iterator<DmsDefinition> it)

Sorts generic objects - schema definitions on the basis of their names.

formatTable

public String formatTable(Iterator<DmsDefinition> it,
                          int size,
                          int cols)

Formats a table of generic objects.

Parameters:

it - An iterator over a set of generic objects (definitions)

size - The number of elements in the iterator.

cols - The number of columns in the table.

generateIndex

public void generateIndex(String dir)