thredds.servlet

Class HtmlWriter

java.lang.Object

thredds.servlet.HtmlWriter

@Component
public class HtmlWriter
extends java.lang.Object

Provide methods to write HTML representations of a catalog, directory, or CDM dataset to an HTTP response.

HtmlWriter is implemented as a singleton. Before HtmlWriter can be used it must be initialized with init(...). The singleton instance can then be obtained with getInstance().

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	appendOldStyleHeader(java.lang.StringBuilder sb)
void	appendOldStyleHeader(java.lang.StringBuilder sb, java.lang.String webappName, java.lang.String webappUrl, java.lang.String logoAlt, java.lang.String logoUrl, java.lang.String installName, java.lang.String installUrl, java.lang.String hostName, java.lang.String hostUrl)
void	appendSimpleFooter(java.lang.StringBuilder sb)
void	appendTableHeader(java.lang.StringBuilder stringBuilder, boolean includeInstall, boolean includeWebapp, boolean includeLogos)
java.lang.String	getGoogleTrackingContent()
java.lang.String	getHtmlDoctypeAndOpenTag()
static HtmlWriter	getInstance()
java.lang.String	getOldStyleHeader()
java.lang.String	getTdsCatalogCssLink()
java.lang.String	getTdsPageCssLink()
java.lang.String	getUserCSS()
java.lang.String	getUserHead()
java.lang.String	getXHtmlDoctypeAndOpenTag()
void	showCDM(javax.servlet.http.HttpServletResponse res, ucar.nc2.dataset.NetcdfDataset ds) Show CDM compliance (coordinate systems, etc) of a NetcdfDataset.
int	showDataset(java.lang.String catURL, thredds.catalog.InvDatasetImpl dataset, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, boolean isLocalCatalog)
int	writeCatalog(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, thredds.catalog.InvCatalogImpl cat, boolean isLocalCatalog) Write an InvCatalogImpl to the HttpServletResponse, return the size in bytes of the catalog written to the response.
int	writeDirectory(javax.servlet.http.HttpServletResponse res, java.io.File dir, java.lang.String path) Write a file directory.

Methods inherited from class java.lang.Object

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

Method Detail

afterPropertiesSet

@PostConstruct
public void afterPropertiesSet()

getInstance

public static HtmlWriter getInstance()

getHtmlDoctypeAndOpenTag

public java.lang.String getHtmlDoctypeAndOpenTag()

getXHtmlDoctypeAndOpenTag

public java.lang.String getXHtmlDoctypeAndOpenTag()

getUserCSS

public java.lang.String getUserCSS()

getGoogleTrackingContent

public java.lang.String getGoogleTrackingContent()

getTdsCatalogCssLink

public java.lang.String getTdsCatalogCssLink()

getTdsPageCssLink

public java.lang.String getTdsPageCssLink()

getUserHead

public java.lang.String getUserHead()

getOldStyleHeader

public java.lang.String getOldStyleHeader()

appendOldStyleHeader

public void appendOldStyleHeader(java.lang.StringBuilder sb)

appendOldStyleHeader

public void appendOldStyleHeader(java.lang.StringBuilder sb,
                                 java.lang.String webappName,
                                 java.lang.String webappUrl,
                                 java.lang.String logoAlt,
                                 java.lang.String logoUrl,
                                 java.lang.String installName,
                                 java.lang.String installUrl,
                                 java.lang.String hostName,
                                 java.lang.String hostUrl)

appendTableHeader

public void appendTableHeader(java.lang.StringBuilder stringBuilder,
                              boolean includeInstall,
                              boolean includeWebapp,
                              boolean includeLogos)

appendSimpleFooter

public void appendSimpleFooter(java.lang.StringBuilder sb)

writeDirectory

public int writeDirectory(javax.servlet.http.HttpServletResponse res,
                          java.io.File dir,
                          java.lang.String path)
                   throws java.io.IOException

Write a file directory.

Parameters:

res - the HttpServletResponse on which to write the file directory response.

dir - directory

path - the URL path reletive to the base

Returns:

the number of characters (Unicode code units) in the response.

Throws:

java.io.IOException - if an I/O exception occurs.

writeCatalog

public int writeCatalog(javax.servlet.http.HttpServletRequest req,
                        javax.servlet.http.HttpServletResponse res,
                        thredds.catalog.InvCatalogImpl cat,
                        boolean isLocalCatalog)
                 throws java.io.IOException

Write an InvCatalogImpl to the HttpServletResponse, return the size in bytes of the catalog written to the response.

Parameters:

req - the HttpServletRequest

res - the HttpServletResponse.

cat - the InvCatalogImpl to write to the HttpServletResponse.

isLocalCatalog - indicates whether this catalog is local to this server.

Returns:

the size in bytes of the catalog written to the HttpServletResponse.

Throws:

java.io.IOException - if problems writing the response.

showDataset

public int showDataset(java.lang.String catURL,
                       thredds.catalog.InvDatasetImpl dataset,
                       javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response,
                       boolean isLocalCatalog)
                throws java.io.IOException

Throws:

java.io.IOException

showCDM

public void showCDM(javax.servlet.http.HttpServletResponse res,
                    ucar.nc2.dataset.NetcdfDataset ds)
             throws java.io.IOException

Show CDM compliance (coordinate systems, etc) of a NetcdfDataset.

Parameters:

ds - dataset to write

Throws:

java.io.IOException