lumis.portal.documentation.template.standard

Class StandardDocumentationTemplate

java.lang.Object

lumis.portal.documentation.template.standard.StandardDocumentationTemplate

All Implemented Interfaces:

IDocumentationTemplate

public class StandardDocumentationTemplate
extends Object
implements IDocumentationTemplate

Since:

9.0.0

Version:

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

Nested Class Summary

Nested classes/interfaces inherited from interface lumis.portal.documentation.IDocumentationTemplate

IDocumentationTemplate.DocumentationSection, IDocumentationTemplate.DocumentationSectionEntry

Constructor Summary

Constructors

Constructor and Description
StandardDocumentationTemplate(Locale locale)

Method Summary

Modifier and Type	Method and Description
IDocumentationTemplate.DocumentationSection	addDocumentationSection(String sectionId, boolean isServiceSection, Map<String,String> properties) Adds a new section to the documentation.
void	addServiceImage(String filePath, String legend) Used to notify the template that the given image should be viewed in the list of images of the service.
protected void	copyServiceStaticFiles()
void	copyStaticFiles(String rootPath) copies static files from the given path to the destination documentation directory.
protected void	copyTemplateStaticFiles()
boolean	doesFileExist(String filePath) Returns true if the file exists in the documentation directory.
void	endServiceAndInterfacesDocumentation(String serviceId) Identifies that service and interface documentation generation is complete.
void	endServiceDocumentation(String serviceId) Notifies the template that documentation of a new service ended.
void	endServiceInterfaceDocumentation(String serviceInterfaceId) Notifies that the documentation generation of service interface is complete.
void	endServiceInterfacesDocumentation(String serviceId) Notifies the template that documentation of service interfaces has ended.
protected void	generateSectionsXml(StringBuilder xmlString, List<IDocumentationTemplate.DocumentationSection> sections)
static PortalFilePath	getDocumentationRoot(Locale locale)
IDocumentationTemplate.DocumentationSection	getDocumentationSection(String sectionId, boolean isServiceSection)
void	saveFile(InputStream stream, String filePath) Notifies the template that a new file was generated and should be saved in the given path within the documentation directory.
void	setServiceDetailedDescription(String serviceDetailedDescription) HTML description of the service.
void	setServiceImage(String serviceImage) Notifies the path to the service image and may be used for rendering documentation.
void	setServiceInterfaceDetailedDescription(String detailedDescription) Detailed description is assumed to be HTML format.
void	setServiceInterfaceName(String name)
void	setServiceInterfaceSummary(String summary) Summary is assumed to be simple text and not HTML.
void	setServiceName(String serviceName) Identifies the service name that may be used for generation.
void	setServiceSummary(String serviceSummary) Specifies the service summary to be displayed appropriately.
protected int	simpleCopyStaticFiles(String rootPath)
void	startServiceAndInterfacesDocumentation(String serviceId) Notifies the template that documentation of a new service and its interfaces has started.
void	startServiceDocumentation(String serviceId) Notifies the template that documentation of a new service started.
void	startServiceInterfaceDocumentation(String serviceInterfaceId) Notifies that the documentation generation of service interface is starting.
void	startServiceInterfacesDocumentation(String serviceId) Notifies the template that documentation of service interfaces has started.

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardDocumentationTemplate

public StandardDocumentationTemplate(Locale locale)

Method Detail

startServiceAndInterfacesDocumentation

public void startServiceAndInterfacesDocumentation(String serviceId)
                                            throws PortalException

Description copied from interface: IDocumentationTemplate

Notifies the template that documentation of a new service and its interfaces has started. This method may be used for initialization purposes.

Specified by:

startServiceAndInterfacesDocumentation in interface IDocumentationTemplate

Throws:

PortalException

copyStaticFiles

public void copyStaticFiles(String rootPath)
                     throws PortalException

Description copied from interface: IDocumentationTemplate

copies static files from the given path to the destination documentation directory.

Specified by:

copyStaticFiles in interface IDocumentationTemplate

Parameters:

rootPath - origin path.

Throws:

PortalException

getDocumentationRoot

public static PortalFilePath getDocumentationRoot(Locale locale)
                                           throws PortalException

Throws:

PortalException

simpleCopyStaticFiles

protected int simpleCopyStaticFiles(String rootPath)
                             throws PortalException

Throws:

PortalException

copyTemplateStaticFiles

protected void copyTemplateStaticFiles()
                                throws PortalException

Throws:

PortalException

copyServiceStaticFiles

protected void copyServiceStaticFiles()
                               throws PortalException

Throws:

PortalException

startServiceDocumentation

public void startServiceDocumentation(String serviceId)

Description copied from interface: IDocumentationTemplate

Notifies the template that documentation of a new service started. This method may be used for initialization purposes.

Specified by:

startServiceDocumentation in interface IDocumentationTemplate

endServiceDocumentation

public void endServiceDocumentation(String serviceId)

Description copied from interface: IDocumentationTemplate

Notifies the template that documentation of a new service ended. The interfaces however have not yet been documented.

Specified by:

endServiceDocumentation in interface IDocumentationTemplate

setServiceName

public void setServiceName(String serviceName)

Description copied from interface: IDocumentationTemplate

Identifies the service name that may be used for generation.

Specified by:

setServiceName in interface IDocumentationTemplate

setServiceSummary

public void setServiceSummary(String serviceSummary)

Description copied from interface: IDocumentationTemplate

Specifies the service summary to be displayed appropriately. Summary is assumed to be text and not HTML.

Specified by:

setServiceSummary in interface IDocumentationTemplate

setServiceImage

public void setServiceImage(String serviceImage)

Description copied from interface: IDocumentationTemplate

Notifies the path to the service image and may be used for rendering documentation.

Specified by:

setServiceImage in interface IDocumentationTemplate

setServiceDetailedDescription

public void setServiceDetailedDescription(String serviceDetailedDescription)

Description copied from interface: IDocumentationTemplate

HTML description of the service.

Specified by:

setServiceDetailedDescription in interface IDocumentationTemplate

startServiceInterfacesDocumentation

public void startServiceInterfacesDocumentation(String serviceId)

Description copied from interface: IDocumentationTemplate

Notifies the template that documentation of service interfaces has started. This method may be used for initialization purposes.

Specified by:

startServiceInterfacesDocumentation in interface IDocumentationTemplate

startServiceInterfaceDocumentation

public void startServiceInterfaceDocumentation(String serviceInterfaceId)

Description copied from interface: IDocumentationTemplate

Notifies that the documentation generation of service interface is starting.

Specified by:

startServiceInterfaceDocumentation in interface IDocumentationTemplate

setServiceInterfaceName

public void setServiceInterfaceName(String name)

Specified by:

setServiceInterfaceName in interface IDocumentationTemplate

setServiceInterfaceSummary

public void setServiceInterfaceSummary(String summary)

Description copied from interface: IDocumentationTemplate

Summary is assumed to be simple text and not HTML.

Specified by:

setServiceInterfaceSummary in interface IDocumentationTemplate

setServiceInterfaceDetailedDescription

public void setServiceInterfaceDetailedDescription(String detailedDescription)

Description copied from interface: IDocumentationTemplate

Detailed description is assumed to be HTML format.

Specified by:

setServiceInterfaceDetailedDescription in interface IDocumentationTemplate

endServiceInterfaceDocumentation

public void endServiceInterfaceDocumentation(String serviceInterfaceId)
                                      throws PortalException

Description copied from interface: IDocumentationTemplate

Notifies that the documentation generation of service interface is complete.

Specified by:

endServiceInterfaceDocumentation in interface IDocumentationTemplate

Throws:

PortalException

generateSectionsXml

protected void generateSectionsXml(StringBuilder xmlString,
                                   List<IDocumentationTemplate.DocumentationSection> sections)

endServiceInterfacesDocumentation

public void endServiceInterfacesDocumentation(String serviceId)

Description copied from interface: IDocumentationTemplate

Notifies the template that documentation of service interfaces has ended. May use this method for cleanup purposes.

Specified by:

endServiceInterfacesDocumentation in interface IDocumentationTemplate

endServiceAndInterfacesDocumentation

public void endServiceAndInterfacesDocumentation(String serviceId)
                                          throws PortalException

Description copied from interface: IDocumentationTemplate

Identifies that service and interface documentation generation is complete. The template may now finalize generation of documentation files.

Specified by:

endServiceAndInterfacesDocumentation in interface IDocumentationTemplate

Throws:

PortalException

addServiceImage

public void addServiceImage(String filePath,
                            String legend)
                     throws PortalException

Description copied from interface: IDocumentationTemplate

Used to notify the template that the given image should be viewed in the list of images of the service.

Specified by:

addServiceImage in interface IDocumentationTemplate

Parameters:

filePath - relative path to the image.

legend - text that should be used to label the image.

Throws:

PortalException

doesFileExist

public boolean doesFileExist(String filePath)
                      throws PortalException

Description copied from interface: IDocumentationTemplate

Returns true if the file exists in the documentation directory.

Specified by:

doesFileExist in interface IDocumentationTemplate

Returns:

Throws:

PortalException

saveFile

public void saveFile(InputStream stream,
                     String filePath)
              throws PortalException

Description copied from interface: IDocumentationTemplate

Notifies the template that a new file was generated and should be saved in the given path within the documentation directory.

Specified by:

saveFile in interface IDocumentationTemplate

Parameters:

stream - input stream to the new file.

filePath - the destination path where the file should be saved in the documentation directory.

Throws:

PortalException

addDocumentationSection

public IDocumentationTemplate.DocumentationSection addDocumentationSection(String sectionId,
                                                                           boolean isServiceSection,
                                                                           Map<String,String> properties)
                                                                    throws PortalException

Description copied from interface: IDocumentationTemplate

Adds a new section to the documentation.

Specified by:

addDocumentationSection in interface IDocumentationTemplate

Parameters:

sectionId - identifier for the section.

isServiceSection - identifies if is a service section.

properties - proprties of the section that will be made available to the xls for rendering.

Returns:

Throws:

PortalException

getDocumentationSection

public IDocumentationTemplate.DocumentationSection getDocumentationSection(String sectionId,
                                                                           boolean isServiceSection)
                                                                    throws PortalException

Specified by:

getDocumentationSection in interface IDocumentationTemplate

Throws:

PortalException