com.xmlmind.xml.validate

Class DocumentationGeneratorBase

java.lang.Object

com.xmlmind.xml.validate.DocumentationGeneratorBase

All Implemented Interfaces:

NamespaceToPrefixes

Direct Known Subclasses:

DocumentationGenerator, DocumentationGenerator

public abstract class DocumentationGeneratorBase
extends Object
implements NamespaceToPrefixes

The base class of DocumentationGenerators. A DocumentationGenerator allows to generate a reference manual in HTML format for a SubDocumentType.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentationGeneratorBase.PageInfo Information about an HTML page generated by a DocumentationGenerator.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	addContentMeta
static byte	BOTH_NAVIGATION_BARS
static byte	BOTTOM_NAVIGATION_BAR
protected String	charset
protected String	css
protected static String	defaultNamespaceLabel
static String	INDEX_PAGE_NAME
protected static String	indexPageTitle
protected static String	namespacePrefixLabel
static String	NAMESPACES_PAGE_NAME
protected static String	namespacesPageTitle
protected static String	namespaceURILabel
protected byte	navigationBars
protected PrefixPreferences	prefixPreferences
static byte	TOP_NAVIGATION_BAR
protected PrefixPreferences	userPrefixPreferences

Fields inherited from interface com.xmlmind.xml.name.NamespaceToPrefixes

EMPTY_PREFIXES, XML_PREFIXES

Constructor Summary

Constructors

Constructor and Description
DocumentationGeneratorBase()

Method Summary

Modifier and Type	Method and Description
protected void	appendNavigationBar(boolean index, boolean namespaces, boolean bottom, StringBuilder page)
protected void	appendPageEnd(boolean index, boolean namespaces, StringBuilder page)
protected void	appendPageMiddle(boolean index, boolean namespaces, StringBuilder page)
protected void	appendPageStart(StringBuilder page)
abstract void	generateAll(File outDir)
abstract boolean	generateElementPage(ElementType elementType, DocumentationGeneratorBase.PageInfo info)
abstract void	generateIndexPage(DocumentationGeneratorBase.PageInfo info)
abstract void	generateNamespacesPage(DocumentationGeneratorBase.PageInfo info)
protected void	generateNamespacesPage(PrefixEntry[] extraPrefixes, DocumentationGeneratorBase.PageInfo info)
String	getCharset()
String	getCSS()
abstract ElementType	getElementType(String pageName)
int	getNavigationBars()
PrefixPreferences	getPrefixPreferences()
abstract SubDocumentType	getSubDocumentType()
abstract void	initSubDocumentType(SubDocumentType subDocType)
boolean	isContentMetaAdded()
String[]	namespaceToPrefixes(Namespace namespace) Returns the list of prefixes used to represent specified namespace.
void	setCharset(String charset)
void	setContentMetaAdded(boolean add)
void	setCSS(String css)
void	setNavigationBars(int bars)
void	setPrefixPreferences(PrefixPreferences map)

Methods inherited from class java.lang.Object

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

Field Detail

INDEX_PAGE_NAME

public static final String INDEX_PAGE_NAME

See Also:

Constant Field Values

NAMESPACES_PAGE_NAME

public static final String NAMESPACES_PAGE_NAME

See Also:

Constant Field Values

TOP_NAVIGATION_BAR

public static final byte TOP_NAVIGATION_BAR

See Also:

Constant Field Values

BOTTOM_NAVIGATION_BAR

public static final byte BOTTOM_NAVIGATION_BAR

See Also:

Constant Field Values

BOTH_NAVIGATION_BARS

public static final byte BOTH_NAVIGATION_BARS

See Also:

Constant Field Values

css

protected String css

addContentMeta

protected boolean addContentMeta

charset

protected String charset

userPrefixPreferences

protected PrefixPreferences userPrefixPreferences

prefixPreferences

protected PrefixPreferences prefixPreferences

navigationBars

protected byte navigationBars

indexPageTitle

protected static final String indexPageTitle

namespacesPageTitle

protected static final String namespacesPageTitle

namespacePrefixLabel

protected static final String namespacePrefixLabel

namespaceURILabel

protected static final String namespaceURILabel

defaultNamespaceLabel

protected static final String defaultNamespaceLabel

Constructor Detail

DocumentationGeneratorBase

public DocumentationGeneratorBase()

Method Detail

setCSS

public void setCSS(String css)

getCSS

public String getCSS()

setContentMetaAdded

public void setContentMetaAdded(boolean add)

isContentMetaAdded

public boolean isContentMetaAdded()

setCharset

public void setCharset(String charset)

getCharset

public String getCharset()

setPrefixPreferences

public void setPrefixPreferences(PrefixPreferences map)

getPrefixPreferences

public PrefixPreferences getPrefixPreferences()

setNavigationBars

public void setNavigationBars(int bars)

getNavigationBars

public int getNavigationBars()

initSubDocumentType

public abstract void initSubDocumentType(SubDocumentType subDocType)

getSubDocumentType

public abstract SubDocumentType getSubDocumentType()

generateAll

public abstract void generateAll(File outDir)
                          throws IOException

Throws:

IOException

generateIndexPage

public abstract void generateIndexPage(DocumentationGeneratorBase.PageInfo info)

generateNamespacesPage

public abstract void generateNamespacesPage(DocumentationGeneratorBase.PageInfo info)

getElementType

public abstract ElementType getElementType(String pageName)

generateElementPage

public abstract boolean generateElementPage(ElementType elementType,
                                            DocumentationGeneratorBase.PageInfo info)

generateNamespacesPage

protected void generateNamespacesPage(PrefixEntry[] extraPrefixes,
                                      DocumentationGeneratorBase.PageInfo info)

appendPageStart

protected void appendPageStart(StringBuilder page)

appendPageMiddle

protected void appendPageMiddle(boolean index,
                                boolean namespaces,
                                StringBuilder page)

appendPageEnd

protected void appendPageEnd(boolean index,
                             boolean namespaces,
                             StringBuilder page)

appendNavigationBar

protected void appendNavigationBar(boolean index,
                                   boolean namespaces,
                                   boolean bottom,
                                   StringBuilder page)

namespaceToPrefixes

public String[] namespaceToPrefixes(Namespace namespace)

Description copied from interface: NamespaceToPrefixes

Returns the list of prefixes used to represent specified namespace.

The returned list may contain the empty string which means that specified namespace is the default namespace.

Note:In principle, this method is not invoked for the absent namespace ("") and for "http://www.w3.org/XML/1998/namespace". However, it should return NamespaceToPrefixes.EMPTY_PREFIXES for the absent namespace and NamespaceToPrefixes.XML_PREFIXES for the "http://www.w3.org/XML/1998/namespace" namespace.

Specified by:

namespaceToPrefixes in interface NamespaceToPrefixes

Parameters:

namespace - the namespace represented by one or several prefixes

Returns:

the list of prefixes used to represent specified namespace or null if specified namespace is not represented by any prefix.