lumis.doui.documentation.generator

Class DouiDocumentationUtil

java.lang.Object

lumis.doui.documentation.generator.DouiDocumentationUtil

Direct Known Subclasses:

ContentDocumentationUtil

public class DouiDocumentationUtil
extends Object

Utility methods used by the Doui documentation framework.

Since:

9.0.0

Version:

$Revision: 19135 $ $Date: 2016-06-02 21:12:21 +0000 (Thu, 02 Jun 2016) $

Constructor Summary

Constructors

Constructor and Description
DouiDocumentationUtil()

Method Summary

Modifier and Type	Method and Description
static void	documentationSetTemplateSectionFields(ServiceInterfaceConfig serviceInterfaceConfig, IResource resource, Locale locale, Node sourceNode, IDocumentationTemplate.DocumentationSection dataSection) Given a documentation source section, adds entries for each visible field.
static IDocumentationTemplate.DocumentationSection	renderSource(Node sourceNode, String parentId, IResource resource, Locale locale, IDocumentationTemplate template) Given a source node this method adds a new documentation section to the template related to the source.

Methods inherited from class java.lang.Object

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

Constructor Detail

DouiDocumentationUtil

public DouiDocumentationUtil()

Method Detail

renderSource

public static IDocumentationTemplate.DocumentationSection renderSource(Node sourceNode,
                                                                       String parentId,
                                                                       IResource resource,
                                                                       Locale locale,
                                                                       IDocumentationTemplate template)
                                                                throws PortalException

Given a source node this method adds a new documentation section to the template related to the source.

Parameters:

sourceNode - the source node for which documentation should be rendered.

resource - used to translate strings.

locale - the locale in which the documentation should be generated.

template - the template object responsible for actual rendering of html.

Returns:

the new source section created

Throws:

PortalException

Since:

9.0.0

documentationSetTemplateSectionFields

public static void documentationSetTemplateSectionFields(ServiceInterfaceConfig serviceInterfaceConfig,
                                                         IResource resource,
                                                         Locale locale,
                                                         Node sourceNode,
                                                         IDocumentationTemplate.DocumentationSection dataSection)
                                                  throws PortalException

Given a documentation source section, adds entries for each visible field.

Parameters:

serviceInterfaceConfig - the interface for which fields are being generated

resource - used to translate strings.

locale - the locale in which the documentation should be generated.

sourceNode - the source node for which field documentation should be rendered.

dataSection - the data section of a source for which fields will be added.

Throws:

PortalException

Since:

9.0.0