Package lumis.portal.presentation

Class AbstractHtmlProcessor

java.lang.Object

lumis.portal.presentation.AbstractHtmlProcessor

All Implemented Interfaces:

IHtmlProcessor

Direct Known Subclasses:

HtmlInjector, ScriptingHtmlProcessor

public abstract class AbstractHtmlProcessor
extends java.lang.Object
implements IHtmlProcessor

Abstract IHtmlProcessor.

Since:

16.0.0

Version:

$Revision$ $Date$

Constructor Summary

Constructors

Constructor	Description
AbstractHtmlProcessor()

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	getPropertyValue(java.lang.String propertyName, IPageWebResourceRenderRequest request)	Returns the property value for the given request.
protected java.util.List<java.lang.String>	getPropertyValues(java.lang.String propertyName, IPageWebResourceRenderRequest request)	Returns the property values for the given request.
protected java.lang.String	getServiceInstanceId()	Returns this processor's service instance identifier.
protected java.lang.String	getServiceInstancePropertyValue(java.lang.String propertyName)	Returns the first value for the specified property name in the property bag of this HTML processor's service instance.
protected java.util.List<java.lang.String>	getServiceInstancePropertyValues(java.lang.String propertyName)	Returns the values for the specified property name in the property bag of this HTML processor's service instance.
void	init(java.lang.String serviceInstanceId)	Initializes this HTML processor with the given service instance identifier.

Methods inherited from class java.lang.Object

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

Methods inherited from interface lumis.portal.presentation.IHtmlProcessor

process

Constructor Detail

AbstractHtmlProcessor

public AbstractHtmlProcessor()

Method Detail

init

public void init(java.lang.String serviceInstanceId)
          throws PortalException

Description copied from interface: IHtmlProcessor

Initializes this HTML processor with the given service instance identifier.

Specified by:

init in interface IHtmlProcessor

Parameters:

serviceInstanceId - the service instance identifier.

Throws:

PortalException

getServiceInstanceId

protected java.lang.String getServiceInstanceId()

Returns this processor's service instance identifier.

Returns:

this processor's service instance identifier

Since:

16.0.0

getPropertyValues

protected java.util.List<java.lang.String> getPropertyValues(java.lang.String propertyName,
                                                             IPageWebResourceRenderRequest request)
                                                      throws PortalException

Returns the property values for the given request.

Parameters:

propertyName - the property name

request - the request

Returns:

the property values for the given request

Throws:

PortalException

Since:

16.0.0

getPropertyValue

protected java.lang.String getPropertyValue(java.lang.String propertyName,
                                            IPageWebResourceRenderRequest request)
                                     throws PortalException

Returns the property value for the given request.

Parameters:

propertyName - the property name

request - the request

Returns:

the property value for the given request

Throws:

PortalException

Since:

16.0.0

getServiceInstancePropertyValues

protected java.util.List<java.lang.String> getServiceInstancePropertyValues(java.lang.String propertyName)
                                                                     throws PortalException

Returns the values for the specified property name in the property bag of this HTML processor's service instance.

Parameters:

propertyName - the property name.

Returns:

the values, or an empty list if no such property was found.

Throws:

PortalException

Since:

16.0.0

getServiceInstancePropertyValue

protected java.lang.String getServiceInstancePropertyValue(java.lang.String propertyName)
                                                    throws PortalException

Returns the first value for the specified property name in the property bag of this HTML processor's service instance.

Parameters:

propertyName - the property name

Returns:

the property value or null if it was not found or if it is empty.

Throws:

PortalException

Since:

16.0.0