nu.staldal.lsp
Interface LSPPage

All Known Implementing Classes:

LSPPageBase

public interface LSPPage

A compiled LSP Page.

An LSP page instance may be reused and is thread safe.

Field Summary

static java.lang.String	LSP_VERSION_NAME Current version of LSP.
static int	LSP_VERSION_NUM Version number to check compatibility between runtime and compiled pages.

Method Summary

void	execute(org.xml.sax.ContentHandler ch, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.Object extContext) Execute this LSP page and sends the output as SAX2 events to the supplied ContentHandler.
java.lang.String[]	getCompileDependentFiles() Get a list of files which was imported with this page was compiled.
java.util.Properties	getOutputProperties() Output properties to use then this page is serialized.
java.lang.String	getPageName() Get the name of this page.
long	getTimeCompiled() When this page was compiled.
boolean	isCompileDynamic() Currently not used.

Field Detail

LSP_VERSION_NAME

static final java.lang.String LSP_VERSION_NAME

Current version of LSP.

See Also:

Constant Field Values

LSP_VERSION_NUM

static final int LSP_VERSION_NUM

Version number to check compatibility between runtime and compiled pages. Will only be bumped with incompatibility is introduced (not necessary with each release).

See Also:

Constant Field Values

Method Detail

getCompileDependentFiles

java.lang.String[] getCompileDependentFiles()

Get a list of files which was imported with this page was compiled.

Returns:

list of files which was imported with this page was compiled

isCompileDynamic

boolean isCompileDynamic()

Currently not used.

Returns:

true if the page is compile dynamic

getTimeCompiled

long getTimeCompiled()

When this page was compiled.

Returns:

when the page was compiled, in the same format as System.currentTimeMillis()

getPageName

java.lang.String getPageName()

Get the name of this page.

Returns:

the name of this page.

getOutputProperties

java.util.Properties getOutputProperties()

Output properties to use then this page is serialized. From <lsp:output>.

Returns:

output properties to use then this page is serialized

execute

void execute(org.xml.sax.ContentHandler ch,
             java.util.Map<java.lang.String,java.lang.Object> params,
             java.lang.Object extContext)
             throws org.xml.sax.SAXException

Execute this LSP page and sends the output as SAX2 events to the supplied ContentHandler. Does not output startDocument()/endDocument() events.

Parameters:

ch - SAX2 ContentHandler to send output to

params - Parameters to the LSP page

extContext - external context which will be passed to ExtLibs

Throws:

org.xml.sax.SAXException - may throw SAXException