com.sapportals.wcm.rendering.property

Class PropertyRendererFactory

java.lang.Object
  extended bycom.sapportals.wcm.rendering.property.PropertyRendererFactory
All Implemented Interfaces:
IFactoryInfoProvider

public final class PropertyRendererFactory
extends Object
implements IFactoryInfoProvider


Nested Class Summary
 
Nested classes inherited from class com.sapportals.wcm.rendering.base.IFactoryInfoProvider
IFactoryInfoProvider.MappingInformation
 
Field Summary
static String KEY_ALIAS
           
static String KEY_CLASS
           
static String LINE_BREAK
          constant used to separate debugging information
 
Method Summary
 void configEvent(ConfigEvent parm1)
          is called by the configuration, if configuration for the factory was changed.
 String getConfigListenerId()
          Gets the configListenerId attribute of the PropertyRendererFactory object
 String getFactoryName()
           
static PropertyRendererFactory getInstance()
          Gets the instance attribute of the PropertyRendererFactory class.
 long getLastReloadTime()
           
 List getMappings(Locale locale)
           
 Object getRenderer(IMetaName name, PropertyDisplayMode mode)
           
 Status getStatus()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LINE_BREAK

public static final String LINE_BREAK
constant used to separate debugging information


KEY_ALIAS

public static final String KEY_ALIAS
See Also:
Constant Field Values

KEY_CLASS

public static final String KEY_CLASS
See Also:
Constant Field Values
Method Detail

getInstance

public static PropertyRendererFactory getInstance()
Gets the instance attribute of the PropertyRendererFactory class.

Returns:
the only available instance of this factory in the VM.

getConfigListenerId

public String getConfigListenerId()
Gets the configListenerId attribute of the PropertyRendererFactory object

Returns:
The configListenerId value

configEvent

public void configEvent(ConfigEvent parm1)
is called by the configuration, if configuration for the factory was changed. If the event is of type ConfigEvent.CONFIGURABLE_LOADED or ConfigEvent.CONFIGMANAGER_TERMINATED , the factory deletes all its entries and reloads the configuration, creating all propertyRenderers anew.

Parameters:
parm1 - the event raised by the configuration

getMappings

public List getMappings(Locale locale)
Specified by:
getMappings in interface IFactoryInfoProvider
Parameters:
locale - defines the language to use, if the factory offers translated information, must not be null
Returns:
a list that must only contain IFactoryInfoProvider.MappingInformation, must not be null

getStatus

public Status getStatus()
Specified by:
getStatus in interface IFactoryInfoProvider
Returns:
the aggregated status of the factory. If, e.g., there have been errors creating a class defined in the config, the factory should return Status.ERROR

getRenderer

public Object getRenderer(IMetaName name,
                          PropertyDisplayMode mode)

getFactoryName

public String getFactoryName()
Specified by:
getFactoryName in interface IFactoryInfoProvider
Returns:
a human-readable name of the factory, must not be null

getLastReloadTime

public long getLastReloadTime()
Specified by:
getLastReloadTime in interface IFactoryInfoProvider
Returns:
the time of the last reload of the config by this factory. Expects a format such as returned by System.currentTimeMillis(). An implementing class might also return -1 to indicate, that no information is available.


Copyright 2006 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.