lumis.portal.documentation.generator

Class GenericServiceDocumentationGenerator

java.lang.Object

lumis.portal.documentation.generator.GenericServiceDocumentationGenerator

All Implemented Interfaces:

IServiceDocumentationGenerator

Direct Known Subclasses:

DouiServiceDocumentationGenerator

public class GenericServiceDocumentationGenerator
extends Object
implements IServiceDocumentationGenerator

Generates documentation for services.

Since:

9.0.0

Version:

$Revision: 19136 $ $Date: 2016-06-02 21:14:45 +0000 (Thu, 02 Jun 2016) $

Field Summary

Fields

Modifier and Type	Field and Description
protected IResource	docResource

Constructor Summary

Constructors

Constructor and Description
GenericServiceDocumentationGenerator()

Method Summary

Modifier and Type	Method and Description
protected String	documentationGetServiceDescription(ServiceConfig serviceConfig, IResource resource, Locale locale, IDocumentationTemplate template, ITransaction transaction) Returns the HTML detailed description of the service.
protected String	documentationGetServiceName(ServiceConfig serviceConfig, IResource resource, Locale locale, IDocumentationTemplate template, ITransaction transaction)
protected String	documentationGetServiceSummary(ServiceConfig serviceConfig, IResource resource, Locale locale, IDocumentationTemplate template, ITransaction transaction)
protected void	documentationSetTemplateSections(ServiceConfig serviceConfig, IResource resource, Locale locale, IDocumentationTemplate template, ITransaction transaction) Generates the documentation sections for the service principal documentation.
void	generateDocumentationForService(String serviceId, Locale locale, IDocumentationTemplate template) Generates HTML documentation for the service.
void	generateDocumentationForServiceInterface(String interfaceId, Locale locale, boolean reGenerateImages, IDocumentationTemplate template) Generates HTML documentation for the given service interface.
protected String	getDefaultServiceDetailedDescription(ServiceConfig serviceConfig, IResource resource, Locale locale, IDocumentationTemplate template, ITransaction transaction) Used by inherited Classes (ex.
protected IServiceInterfaceDocumentationGenerator	getServiceInterfaceDocumentationGenerator(IServiceInterface si)

Methods inherited from class java.lang.Object

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

Field Detail

docResource

protected IResource docResource

Constructor Detail

GenericServiceDocumentationGenerator

public GenericServiceDocumentationGenerator()

Method Detail

generateDocumentationForService

public void generateDocumentationForService(String serviceId,
                                            Locale locale,
                                            IDocumentationTemplate template)
                                     throws PortalException

Description copied from interface: IServiceDocumentationGenerator

Generates HTML documentation for the service.

The HTML documentation should be generated in the root directory provided.

Specified by:

generateDocumentationForService in interface IServiceDocumentationGenerator

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

template - the template where the generated information should be sent to for rendering.

Throws:

PortalException

documentationGetServiceName

protected String documentationGetServiceName(ServiceConfig serviceConfig,
                                             IResource resource,
                                             Locale locale,
                                             IDocumentationTemplate template,
                                             ITransaction transaction)
                                      throws PortalException

Throws:

PortalException

documentationGetServiceSummary

protected String documentationGetServiceSummary(ServiceConfig serviceConfig,
                                                IResource resource,
                                                Locale locale,
                                                IDocumentationTemplate template,
                                                ITransaction transaction)
                                         throws PortalException

Throws:

PortalException

documentationGetServiceDescription

protected String documentationGetServiceDescription(ServiceConfig serviceConfig,
                                                    IResource resource,
                                                    Locale locale,
                                                    IDocumentationTemplate template,
                                                    ITransaction transaction)
                                             throws PortalException

Returns the HTML detailed description of the service.

Parameters:

serviceConfig - the service for which detailed documentation should be generated.

resource - used to translate strings.

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

template - the documentation template used to generate documentation files.

transaction -

Returns:

Throws:

PortalException

Since:

9.0.0

documentationSetTemplateSections

protected void documentationSetTemplateSections(ServiceConfig serviceConfig,
                                                IResource resource,
                                                Locale locale,
                                                IDocumentationTemplate template,
                                                ITransaction transaction)
                                         throws PortalException

Generates the documentation sections for the service principal documentation.

Parameters:

serviceConfig -

resource - used to translate strings.

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

template - the documentation template used to generate documentation files.

transaction -

Throws:

PortalException

Since:

9.0.0

getDefaultServiceDetailedDescription

protected String getDefaultServiceDetailedDescription(ServiceConfig serviceConfig,
                                                      IResource resource,
                                                      Locale locale,
                                                      IDocumentationTemplate template,
                                                      ITransaction transaction)
                                               throws ManagerException,
                                                      PortalException

Used by inherited Classes (ex. doui/content) to customize default description.

Parameters:

serviceConfig -

resource - used to translate strings.

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

template - the documentation template used to generate documentation files.

transaction -

Returns:

Throws:

ManagerException

PortalException

Since:

9.0.0

generateDocumentationForServiceInterface

public void generateDocumentationForServiceInterface(String interfaceId,
                                                     Locale locale,
                                                     boolean reGenerateImages,
                                                     IDocumentationTemplate template)
                                              throws PortalException

Description copied from interface: IServiceDocumentationGenerator

Generates HTML documentation for the given service interface.

Specified by:

generateDocumentationForServiceInterface in interface IServiceDocumentationGenerator

Parameters:

interfaceId - the interface for which documentation should be generated

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

reGenerateImages - flags whether images should be generated. This may cause documentation take longer to generate.

template - the template where the generated information should be sent to for rendering.

Throws:

PortalException

getServiceInterfaceDocumentationGenerator

protected IServiceInterfaceDocumentationGenerator getServiceInterfaceDocumentationGenerator(IServiceInterface si)
                                                                                     throws PortalException

Throws:

PortalException