com.sapportals.portal.appintegrator.template_processor
Interface ITemplateProcessorService

public interface ITemplateProcessorService

Interface for Template Processor. A Template Processor is a substitution machine which replaces variables inside templates by values stored in contexts.
For further details

Version:

$Revision: #1 $

See Also:

Copyright (c) SAP Portals Europe GmbH 2001

Field Summary

static java.lang.String

KEY

Method Summary

java.lang.String	processTemplate(java.lang.String template, IAccessor ctxTree, java.util.Locale loc) processes a template by replacing *all* tag expressions of by the corresponding values of the contexts.
java.lang.String	processTemplate(java.lang.String template, com.sapportals.portal.prt.component.IPortalComponentRequest request) processes a template by replacing *all* tag expressions of by the corresponding values of the contexts.
java.lang.String	processTemplate(java.lang.String template, com.sapportals.portal.prt.component.IPortalComponentRequest request, IAccessor rootContext) processes a template by replacing *all* tag expressions of by the corresponding values of the contexts.

Field Detail

KEY

public static final java.lang.String KEY

Method Detail

processTemplate

public java.lang.String processTemplate(java.lang.String template,
                                        IAccessor ctxTree,
                                        java.util.Locale loc)
                                 throws TemplateParserException

processes a template by replacing *all* tag expressions of by the corresponding values of the contexts. The result of processing doesn't contain any tags. All escaped angle brackets are unescaped.

Parameters:

template - the template that is to be processed

ctxTree - root context of the context tree that contains the hierarchical hashtables.

loc - the locale

Returns:

the processed template

Throws:

TemplateParserException -

processTemplate

public java.lang.String processTemplate(java.lang.String template,
                                        com.sapportals.portal.prt.component.IPortalComponentRequest request,
                                        IAccessor rootContext)
                                 throws TemplateParserException

processes a template by replacing *all* tag expressions of by the corresponding values of the contexts. The result of processing doesn't contain any tags. All escaped angle brackets are unescaped. The context tree is calculated of the request and contains the following standard contexts: The context tree is calculated of the request and contains the following standard contexts (with the valid context selectors):

• the given ctxTree is accessible directly at the root (no context selector)
• Profile — the Component Profile (ie. the iView)
• Node — the POM Node
• System — the System Landscape service
• User — the User Management service
• Request — the Portal Component Request (for URL querystring etc.)
• LAF — the Look And Feel Service

Parameters:

template - the template that is to be processed

request - the portal component request.

rootContext - the root context the is direct accessible as flat context

Returns:

the processed template

Throws:

TemplateParserException -

processTemplate

public java.lang.String processTemplate(java.lang.String template,
                                        com.sapportals.portal.prt.component.IPortalComponentRequest request)
                                 throws TemplateParserException

processes a template by replacing *all* tag expressions of by the corresponding values of the contexts. The result of processing doesn't contain any tags. All escaped angle brackets are unescaped. The context tree is calculated of the request and contains the following standard contexts (with the valid context selectors):

• Profile — the Component Profile (ie. the iView) – this context is also available direct at the root (without context select)
• Node — the POM Node
• System — the System Landscape service
• User — the User Management service
• Request — the Portal Component Request (for URL querystring etc.)
• LAF — the Look And Feel Service

Parameters:

template - the template that is to be processed

request - the portal component request.

Returns:

the processed template

Throws:

TemplateParserException -