lumis.portal.documentation

Class DocumentationManager

java.lang.Object

lumis.portal.documentation.DocumentationManager

All Implemented Interfaces:

IDocumentationManager

public class DocumentationManager
extends Object
implements IDocumentationManager

Implements the documentation manager interface.

Since:

9.0.0

Version:

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

Constructor Summary

Constructors

Constructor and Description
DocumentationManager()

Method Summary

Modifier and Type	Method and Description
void	generateDocumentation(String sourceRootPath, boolean reGenerateImages, Locale locale, boolean insertStringHolders) Generates documentation for one or more services and static directories specified in a documentationdefinition.xml file
void	generateServiceDocumentation(String serviceId, boolean reGenerateImages, Locale locale, boolean insertStringHolders) Generates documentation for a given service.
void	generateStaticDocumentation(String sourceRootPath, Locale locale) Generates documentation given a root directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentationManager

public DocumentationManager()

Method Detail

generateDocumentation

public void generateDocumentation(String sourceRootPath,
                                  boolean reGenerateImages,
                                  Locale locale,
                                  boolean insertStringHolders)
                           throws PortalException

Description copied from interface: IDocumentationManager

Generates documentation for one or more services and static directories specified in a documentationdefinition.xml file

Specified by:

generateDocumentation in interface IDocumentationManager

Parameters:

sourceRootPath - the root path that should contain a documentationdefinition.xml file

reGenerateImages - true if during generation of documentation, autogeneration of service images should also be executed.

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

insertStringHolders - if true, will generate the string id of non-localized strings for ease of translation

Throws:

PortalException

generateStaticDocumentation

public void generateStaticDocumentation(String sourceRootPath,
                                        Locale locale)
                                 throws PortalException

Description copied from interface: IDocumentationManager

Generates documentation given a root directory. The root directory should have a sub-directory named with the locale that the documentation manager is trying to generate.

Specified by:

generateStaticDocumentation in interface IDocumentationManager

Parameters:

sourceRootPath - the root directory generally ending with documentationfiles directory.

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

Throws:

PortalException

generateServiceDocumentation

public void generateServiceDocumentation(String serviceId,
                                         boolean reGenerateImages,
                                         Locale locale,
                                         boolean insertStringHolders)
                                  throws PortalException

Description copied from interface: IDocumentationManager

Generates documentation for a given service.

Specified by:

generateServiceDocumentation in interface IDocumentationManager

Parameters:

serviceId - the identifier of the service

reGenerateImages - true if during generation of documentation, autogeneration of images should also be executed.

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

insertStringHolders - if true, will generate the string id of non-localized strings for ease of translation

Throws:

PortalException