netcharts.pro.common.page
Class NFPageOutput

java.lang.Object
  netcharts.pro.common.page.NFPageOutput

All Implemented Interfaces:

NFPageExtension

Direct Known Subclasses:

NFRasterPageOutput, NFSVGPageOutput

public abstract class NFPageOutput
extends java.lang.Object
implements NFPageExtension

NFPageOutput is the base class for page content generation. Each category of output (e.g. raster images, vector based, etc.) should have a subclass implementation of NFPageOutput.

Method Summary

java.lang.String	getMimeType() Returns the MIME type of the output.
java.lang.String	getPage(HttpServletRequest request, NFGraph graph, NFPageParams params) Generates the page and image content based on the chart instance and page parameters.
java.lang.String	getPage(NFGraph graph, NFPageParams params, NFServerGeneratedImage sgi) Generates the page content based on the chart instance, page parameters, and generated image.
java.lang.String	getScript(NFPageParams params) Returns the user interactivity script.

Methods inherited from class java.lang.Object

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

Methods inherited from interface netcharts.pro.common.page.NFPageExtension

getPageParamsInstance

Method Detail

getMimeType

public java.lang.String getMimeType()

Returns the MIME type of the output.

Returns:

The MIME type of the output

getPage

public java.lang.String getPage(HttpServletRequest request,
                                NFGraph graph,
                                NFPageParams params)
                         throws java.lang.Exception

Description copied from interface: NFPageExtension

Generates the page and image content based on the chart instance and page parameters.

Specified by:

getPage in interface NFPageExtension

Parameters:

request - The HTTP request associated with the response to include the content within.

graph - The graph object associated with the content.

params - The set of parameters defining how the page and image should be generated.

Returns:

The page content based on the chart instance and page generation parameters.

Throws:

java.lang.Exception

getPage

public java.lang.String getPage(NFGraph graph,
                                NFPageParams params,
                                NFServerGeneratedImage sgi)
                         throws java.lang.Exception

Generates the page content based on the chart instance, page parameters, and generated image.

Parameters:

graph - The chart instance for which to generate the page content.

params - The set of parameters defining how the page content should be generated.

sgi - The generated image of the chart.

Returns:

The page content to include in the web page to display the generated image.

Throws:

java.lang.Exception

getScript

public java.lang.String getScript(NFPageParams params)

Returns the user interactivity script.

Specified by:

getScript in interface NFPageExtension