lumis.doui.documentation.generator

Class DouiServiceInterfaceDocumentationGenerator

java.lang.Object

lumis.portal.documentation.generator.GenericServiceInterfaceDocumentationGenerator

lumis.doui.documentation.generator.DouiServiceInterfaceDocumentationGenerator

All Implemented Interfaces:

IServiceInterfaceDocumentationGenerator

Direct Known Subclasses:

ContentServiceInterfaceDocumentationGenerator

public class DouiServiceInterfaceDocumentationGenerator
extends GenericServiceInterfaceDocumentationGenerator

Since:

9.0.0

Version:

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

Nested Class Summary

Nested classes/interfaces inherited from class lumis.portal.documentation.generator.GenericServiceInterfaceDocumentationGenerator

GenericServiceInterfaceDocumentationGenerator.ServiceInterfaceImage

Field Summary

Fields

Modifier and Type	Field and Description
protected String	appendToUrl
protected String	imageDescription
protected String	imageName
protected String	lastServiceInterfaceInstanceId
protected GenericServiceInterfaceDocumentationGenerator.ServiceInterfaceImage	lastSIImage
protected Set<String>	referencedProcessActions
protected boolean	renderedFirstImage
protected Document	xmlDoc
protected XPath	xPath

Fields inherited from class lumis.portal.documentation.generator.GenericServiceInterfaceDocumentationGenerator

docResource, reGenerateImages, serviceInterfaceImages

Constructor Summary

Constructors

Constructor and Description
DouiServiceInterfaceDocumentationGenerator()

Method Summary

Modifier and Type	Method and Description
protected void	addServiceImageToTemplate(String pathToImage, ServiceInterfaceConfig serviceInterfaceConfig, Locale locale, IDocumentationTemplate template)
protected GenericServiceInterfaceDocumentationGenerator.ServiceInterfaceImage	createNewServiceInterfaceImageEntry(String pathToImage)
protected IDocumentationTemplate.DocumentationSectionEntry	documentationSetTemplateSectionField(IResource resource, Locale locale, Node fieldNode)
protected void	documentationSetTemplateSectionFields(ServiceInterfaceConfig serviceInterfaceConfig, IResource resource, Locale locale, Node sourceNode, IDocumentationTemplate.DocumentationSection dataSection)
protected void	documentationSetTemplateSections(ServiceInterfaceConfig serviceInterfaceConfig, IResource resource, Locale locale, IDocumentationTemplate template)
protected String	generateControlsDocumentation(Node rootNode, DouiServiceInterfaceInstanceDefinition dsiid, IResource resource, Locale locale, XPath xPath, ServiceInterfaceConfig serviceInterfaceConfig)
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 void	generateLinksDocumentation(Node rootNode, DouiServiceInterfaceInstanceDefinition dsiid, IResource resource, Locale locale, XPath xPath, ServiceInterfaceConfig serviceInterfaceConfig, IDocumentationTemplate template)
protected DouiServiceInterfaceInstanceDefinition	getDouiServiceInterfaceInstanceDefinition(ServiceInterfaceConfig serviceInterfaceConfig, String originalServiceInstanceId)
protected String	getImageUrl(String filePath, ServiceInterfaceConfig serviceInterfaceConfig, String serviceInstanceId, Locale locale, IDocumentationTemplate template)
protected IDocumentationTemplate.DocumentationSection	getLinksDocumentationSection(IResource resource, Locale locale, ServiceInterfaceConfig serviceInterfaceConfig, IDocumentationTemplate template)
protected String	parseLocalizedString(IResource resource, String documentation)

Methods inherited from class lumis.portal.documentation.generator.GenericServiceInterfaceDocumentationGenerator

addServiceInstance, addToServiceInterfaceImages, documentationGetServiceInterfaceDescription, documentationGetServiceInterfaceName, documentationGetServiceInterfaceSummary, generateDocumentationForServiceInterface, generateDocumentationImageForServiceInterface, getDefaultServiceInterfaceDetailedDescription

Methods inherited from class java.lang.Object

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

Field Detail

appendToUrl

protected String appendToUrl

renderedFirstImage

protected boolean renderedFirstImage

imageName

protected String imageName

imageDescription

protected String imageDescription

lastSIImage

protected GenericServiceInterfaceDocumentationGenerator.ServiceInterfaceImage lastSIImage

lastServiceInterfaceInstanceId

protected String lastServiceInterfaceInstanceId

xmlDoc

protected Document xmlDoc

xPath

protected XPath xPath

referencedProcessActions

protected Set<String> referencedProcessActions

Constructor Detail

DouiServiceInterfaceDocumentationGenerator

public DouiServiceInterfaceDocumentationGenerator()

Method Detail

documentationSetTemplateSections

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

Overrides:

documentationSetTemplateSections in class GenericServiceInterfaceDocumentationGenerator

Throws:

PortalException

generateDocumentationImagesForServiceInterface

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

Overrides:

generateDocumentationImagesForServiceInterface in class GenericServiceInterfaceDocumentationGenerator

Throws:

PortalException

generateImage

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

Overrides:

generateImage in class GenericServiceInterfaceDocumentationGenerator

Throws:

PortalException

IOException

InterruptedException

generateLinksDocumentation

protected void generateLinksDocumentation(Node rootNode,
                                          DouiServiceInterfaceInstanceDefinition dsiid,
                                          IResource resource,
                                          Locale locale,
                                          XPath xPath,
                                          ServiceInterfaceConfig serviceInterfaceConfig,
                                          IDocumentationTemplate template)
                                   throws PortalException

Throws:

PortalException

getLinksDocumentationSection

protected IDocumentationTemplate.DocumentationSection getLinksDocumentationSection(IResource resource,
                                                                                   Locale locale,
                                                                                   ServiceInterfaceConfig serviceInterfaceConfig,
                                                                                   IDocumentationTemplate template)
                                                                            throws PortalException

Throws:

PortalException

generateControlsDocumentation

protected String generateControlsDocumentation(Node rootNode,
                                               DouiServiceInterfaceInstanceDefinition dsiid,
                                               IResource resource,
                                               Locale locale,
                                               XPath xPath,
                                               ServiceInterfaceConfig serviceInterfaceConfig)
                                        throws PortalException,
                                               XPathExpressionException,
                                               IOException

Throws:

PortalException

XPathExpressionException

IOException

parseLocalizedString

protected String parseLocalizedString(IResource resource,
                                      String documentation)
                               throws IOException

Throws:

IOException

createNewServiceInterfaceImageEntry

protected GenericServiceInterfaceDocumentationGenerator.ServiceInterfaceImage createNewServiceInterfaceImageEntry(String pathToImage)

Overrides:

createNewServiceInterfaceImageEntry in class GenericServiceInterfaceDocumentationGenerator

addServiceImageToTemplate

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

Overrides:

addServiceImageToTemplate in class GenericServiceInterfaceDocumentationGenerator

Throws:

PortalException

getImageUrl

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

Overrides:

getImageUrl in class GenericServiceInterfaceDocumentationGenerator

Throws:

PortalException

documentationSetTemplateSectionFields

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

Throws:

PortalException

documentationSetTemplateSectionField

protected IDocumentationTemplate.DocumentationSectionEntry documentationSetTemplateSectionField(IResource resource,
                                                                                                Locale locale,
                                                                                                Node fieldNode)
                                                                                         throws PortalException

Throws:

PortalException

getDouiServiceInterfaceInstanceDefinition

protected DouiServiceInterfaceInstanceDefinition getDouiServiceInterfaceInstanceDefinition(ServiceInterfaceConfig serviceInterfaceConfig,
                                                                                           String originalServiceInstanceId)
                                                                                    throws PortalException

Throws:

PortalException