lumis.portal.documentation.generator

Class GenericServiceInterfaceDocumentationGenerator

java.lang.Object

lumis.portal.documentation.generator.GenericServiceInterfaceDocumentationGenerator

All Implemented Interfaces:

IServiceInterfaceDocumentationGenerator

Direct Known Subclasses:

DouiServiceInterfaceDocumentationGenerator

public class GenericServiceInterfaceDocumentationGenerator
extends Object
implements IServiceInterfaceDocumentationGenerator

Responsible for generating documentation for a given service.

Since:

9.0.0

Version:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	GenericServiceInterfaceDocumentationGenerator.ServiceInterfaceImage Object that represents a service image.

Field Summary

Fields

Modifier and Type	Field and Description
protected IResource	docResource
protected boolean	reGenerateImages
protected List<GenericServiceInterfaceDocumentationGenerator.ServiceInterfaceImage>	serviceInterfaceImages

Constructor Summary

Constructors

Constructor and Description
GenericServiceInterfaceDocumentationGenerator()

Method Summary

Modifier and Type	Method and Description
protected void	addServiceImageToTemplate(String pathToImage, ServiceInterfaceConfig serviceInterfaceConfig, Locale locale, IDocumentationTemplate template)
protected String	addServiceInstance(SessionConfig sessionConfig, String serviceId, String name, ITransaction transaction)
protected void	addToServiceInterfaceImages(String pathToImage)
protected GenericServiceInterfaceDocumentationGenerator.ServiceInterfaceImage	createNewServiceInterfaceImageEntry(String pathToImage)
protected String	documentationGetServiceInterfaceDescription(ServiceInterfaceConfig serviceInterfaceConfig, IResource resource, Locale locale, IDocumentationTemplate template)
protected String	documentationGetServiceInterfaceName(ServiceInterfaceConfig serviceInterfaceConfig, IResource resource, Locale locale, IDocumentationTemplate template)
protected String	documentationGetServiceInterfaceSummary(ServiceInterfaceConfig serviceInterfaceConfig, IResource resource, Locale locale, IDocumentationTemplate template)
protected void	documentationSetTemplateSections(ServiceInterfaceConfig serviceInterfaceConfig, IResource resource, Locale locale, IDocumentationTemplate template)
void	generateDocumentationForServiceInterface(String interfaceId, IResource docResource, Locale locale, boolean reGenerateImages, IDocumentationTemplate template) Generates HTML documentation for the service interface
protected String	generateDocumentationImageForServiceInterface(String imageSuffix, ServiceInterfaceConfig serviceInterfaceConfig, IResource resource, Locale locale, IDocumentationTemplate template)
protected String	generateDocumentationImagesForServiceInterface(ServiceInterfaceConfig serviceInterfaceConfig, IResource resource, Locale locale, IDocumentationTemplate template)
protected void	generateImage(ServiceInterfaceConfig serviceInterfaceConfig, File tempFile, String serviceInstanceId, IDocumentationTemplate template, Locale locale)
protected String	getDefaultServiceInterfaceDetailedDescription(ServiceInterfaceConfig serviceInterfaceConfig, IResource resource, Locale locale, IDocumentationTemplate template)
protected String	getImageUrl(String filePath, ServiceInterfaceConfig serviceInterfaceConfig, String serviceInstanceId, Locale locale, IDocumentationTemplate template)

Methods inherited from class java.lang.Object

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

Field Detail

docResource

protected IResource docResource

serviceInterfaceImages

protected List<GenericServiceInterfaceDocumentationGenerator.ServiceInterfaceImage> serviceInterfaceImages

reGenerateImages

protected boolean reGenerateImages

Constructor Detail

GenericServiceInterfaceDocumentationGenerator

public GenericServiceInterfaceDocumentationGenerator()

Method Detail

generateDocumentationForServiceInterface

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

Description copied from interface: IServiceInterfaceDocumentationGenerator

Generates HTML documentation for the service interface

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

Specified by:

generateDocumentationForServiceInterface in interface IServiceInterfaceDocumentationGenerator

reGenerateImages - TODO

Throws:

PortalException

documentationGetServiceInterfaceName

protected String documentationGetServiceInterfaceName(ServiceInterfaceConfig serviceInterfaceConfig,
                                                      IResource resource,
                                                      Locale locale,
                                                      IDocumentationTemplate template)
                                               throws PortalException

Throws:

PortalException

documentationGetServiceInterfaceSummary

protected String documentationGetServiceInterfaceSummary(ServiceInterfaceConfig serviceInterfaceConfig,
                                                         IResource resource,
                                                         Locale locale,
                                                         IDocumentationTemplate template)
                                                  throws PortalException

Throws:

PortalException

documentationGetServiceInterfaceDescription

protected String documentationGetServiceInterfaceDescription(ServiceInterfaceConfig serviceInterfaceConfig,
                                                             IResource resource,
                                                             Locale locale,
                                                             IDocumentationTemplate template)
                                                      throws PortalException

Throws:

PortalException

getDefaultServiceInterfaceDetailedDescription

protected String getDefaultServiceInterfaceDetailedDescription(ServiceInterfaceConfig serviceInterfaceConfig,
                                                               IResource resource,
                                                               Locale locale,
                                                               IDocumentationTemplate template)
                                                        throws ManagerException,
                                                               PortalException

Throws:

ManagerException

PortalException

documentationSetTemplateSections

protected void documentationSetTemplateSections(ServiceInterfaceConfig serviceInterfaceConfig,
                                                IResource resource,
                                                Locale locale,
                                                IDocumentationTemplate template)
                                         throws PortalException

Throws:

PortalException

generateDocumentationImagesForServiceInterface

protected String generateDocumentationImagesForServiceInterface(ServiceInterfaceConfig serviceInterfaceConfig,
                                                                IResource resource,
                                                                Locale locale,
                                                                IDocumentationTemplate template)
                                                         throws PortalException

Throws:

PortalException

addToServiceInterfaceImages

protected void addToServiceInterfaceImages(String pathToImage)

generateDocumentationImageForServiceInterface

protected String generateDocumentationImageForServiceInterface(String imageSuffix,
                                                               ServiceInterfaceConfig serviceInterfaceConfig,
                                                               IResource resource,
                                                               Locale locale,
                                                               IDocumentationTemplate template)
                                                        throws PortalException,
                                                               FileNotFoundException,
                                                               IOException

Throws:

PortalException

FileNotFoundException

IOException

generateImage

protected void generateImage(ServiceInterfaceConfig serviceInterfaceConfig,
                             File tempFile,
                             String serviceInstanceId,
                             IDocumentationTemplate template,
                             Locale locale)
                      throws PortalException,
                             IOException,
                             InterruptedException

Throws:

PortalException

IOException

InterruptedException

createNewServiceInterfaceImageEntry

protected GenericServiceInterfaceDocumentationGenerator.ServiceInterfaceImage createNewServiceInterfaceImageEntry(String pathToImage)

addServiceImageToTemplate

protected void addServiceImageToTemplate(String pathToImage,
                                         ServiceInterfaceConfig serviceInterfaceConfig,
                                         Locale locale,
                                         IDocumentationTemplate template)
                                  throws PortalException

Throws:

PortalException

getImageUrl

protected String getImageUrl(String filePath,
                             ServiceInterfaceConfig serviceInterfaceConfig,
                             String serviceInstanceId,
                             Locale locale,
                             IDocumentationTemplate template)
                      throws PortalException

Throws:

PortalException

addServiceInstance

protected String addServiceInstance(SessionConfig sessionConfig,
                                    String serviceId,
                                    String name,
                                    ITransaction transaction)
                             throws PortalException

Throws:

PortalException