er.directtoweb
Class ERDirectToWeb

java.lang.Object
  er.directtoweb.ERDirectToWeb

public class ERDirectToWeb

extends Object

Principle class of the ERDirectToWeb framework. This class is loaded when the NSBundle of this framework is loaded. When loaded this class configures the directtoweb runtime to use the ERD2WModel and ERD2WFactory subclasses instead of the default implementations. See each class for a description of the additions/improvements made to the base implementation. This class also has a bunch of utility methods that are used throughout this framework.

Nested Class Summary

static class	ERDirectToWeb._Observer
static class	ERDirectToWeb.D2WException Subclass of NSForwardException that can hold a d2wContext.
static class	ERDirectToWeb.Observer

Field Summary

static ERXLogger	componentNameLog
static String	D2WDEBUGGING_ENABLED_KEY
static String	D2WDISPLAY_COMPONENTNAMES_KEY
static String	D2WDISPLAY_PROPERTYKEYS_KEY
static ERXLogger	debugLog
static ERXLogger	log logging support
static ERXLogger	propertyKeyLog
static ERXLogger	trace

Constructor Summary

ERDirectToWeb()

Method Summary

static boolean	booleanForKey(D2WContext context, String key)
static void	configureTraceRuleFiring()
static void	configureTraceRuleFiringRapidTurnAround()
static NSMutableArray	convertedPropertyKeyArray(NSArray keyArray, char startChar, char endChar) Converts a given array of keys to a format usable for section and tab display.
static String	convertedPropertyKeyFromString(String s, char start, char end) Checks if a given property key is in the format (foo) or [foo] and returns the stripped string.
static String	createConfigurationForEntityNamed(String entityName)
static WOComponent	csvExportPageForD2WContext(D2WContext context, WOSession session) Deprecated. use ERD2WFactory.erFactory().csvExportPageForD2WContext(D2WContext context, WOSession session)
static boolean	d2wComponentNameDebuggingEnabled(WOSession s)
static D2WContext	d2wContext()
static Object	d2wContextValueForKey(String key, String entityName)
static Object	d2wContextValueForKey(String key, String entityName, NSDictionary extraValuesForContext)
static boolean	d2wDebuggingEnabled(WOSession s)
static boolean	d2wPropertyKeyDebuggingEnabled(WOSession s)
static NSArray	displayableArrayForKeyPathArray(NSArray array, String entityForReportName, String language)
static String	displayNameForPropertyKey(String key, String entityName, String language)
static WOComponent	errorPageForException(Throwable e, WOSession session) Deprecated. use ERD2WFactory.erFactory().errorPageForException(Throwable e, WOSession session)
static WOComponent	pageForTaskSubTaskAndEntityNamed(String task, String subtask, String entityName, WOSession session) Deprecated. use ERD2WFactory.erFactory().pageForTaskSubTaskAndEntityNamed(String task, String subtask, String entityName, WOSession session)
static WOComponent	printerFriendlyPageForD2WContext(D2WContext context, WOSession session) Deprecated. use ERD2WFactory.erFactory().printerFriendlyPageForD2WContext(D2WContext context, WOSession session)
static QueryPageInterface	queryPageWithFetchSpecificationForEntityNamed(String fsName, String entityName, WOSession session) Deprecated. use ERD2WFactory.erFactory().queryPageWithFetchSpecificationForEntityNamed(String fsName, String entityName, WOSession session)
static void	reportException(Exception ex, D2WContext d2wContext)
static String	resolveUnit(String userInfoUnitString, EOEnterpriseObject object, String prefixKeyPath)
static void	setD2wComponentNameDebuggingEnabled(WOSession s, boolean enabled)
static void	setD2wDebuggingEnabled(WOSession s, boolean enabled)
static void	setD2wPropertyKeyDebuggingEnabled(WOSession s, boolean enabled)
static String	userInfoUnit(EOEnterpriseObject object, String key)
static void	warmUpRuleCache()

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final ERXLogger log

logging support

D2WDEBUGGING_ENABLED_KEY

public static final String D2WDEBUGGING_ENABLED_KEY

See Also:

Constant Field Values

D2WDISPLAY_COMPONENTNAMES_KEY

public static final String D2WDISPLAY_COMPONENTNAMES_KEY

See Also:

Constant Field Values

D2WDISPLAY_PROPERTYKEYS_KEY

public static final String D2WDISPLAY_PROPERTYKEYS_KEY

See Also:

Constant Field Values

debugLog

public static final ERXLogger debugLog

componentNameLog

public static final ERXLogger componentNameLog

propertyKeyLog

public static final ERXLogger propertyKeyLog

trace

public static ERXLogger trace

Constructor Detail

ERDirectToWeb

public ERDirectToWeb()

Method Detail

setD2wDebuggingEnabled

public static void setD2wDebuggingEnabled(WOSession s,
                                          boolean enabled)

d2wDebuggingEnabled

public static boolean d2wDebuggingEnabled(WOSession s)

setD2wComponentNameDebuggingEnabled

public static void setD2wComponentNameDebuggingEnabled(WOSession s,
                                                       boolean enabled)

d2wComponentNameDebuggingEnabled

public static boolean d2wComponentNameDebuggingEnabled(WOSession s)

setD2wPropertyKeyDebuggingEnabled

public static void setD2wPropertyKeyDebuggingEnabled(WOSession s,
                                                     boolean enabled)

d2wPropertyKeyDebuggingEnabled

public static boolean d2wPropertyKeyDebuggingEnabled(WOSession s)

resolveUnit

public static String resolveUnit(String userInfoUnitString,
                                 EOEnterpriseObject object,
                                 String prefixKeyPath)

convertedPropertyKeyFromString

public static String convertedPropertyKeyFromString(String s,
                                                    char start,
                                                    char end)

Checks if a given property key is in the format (foo) or [foo] and returns the stripped string.

Parameters:

s - the String to convert

start - the start char

Returns:

stripped String or null if the string does not start with start and ends with end.

convertedPropertyKeyArray

public static NSMutableArray convertedPropertyKeyArray(NSArray keyArray,
                                                       char startChar,
                                                       char endChar)

Converts a given array of keys to a format usable for section and tab display. For example ("(foo)", bar, baz) is transformed to a list of ERD2WContainers usable for section display. The format ((foo, bar, baz)) is also understood.

Parameters:

keyArray - the NSArray to convert

Returns:

nested NSMutableArray.

booleanForKey

public static boolean booleanForKey(D2WContext context,
                                    String key)

userInfoUnit

public static String userInfoUnit(EOEnterpriseObject object,
                                  String key)

printerFriendlyPageForD2WContext

public static WOComponent printerFriendlyPageForD2WContext(D2WContext context,
                                                           WOSession session)

Deprecated. use ERD2WFactory.erFactory().printerFriendlyPageForD2WContext(D2WContext context, WOSession session)

csvExportPageForD2WContext

public static WOComponent csvExportPageForD2WContext(D2WContext context,
                                                     WOSession session)

Deprecated. use ERD2WFactory.erFactory().csvExportPageForD2WContext(D2WContext context, WOSession session)

pageForTaskSubTaskAndEntityNamed

public static WOComponent pageForTaskSubTaskAndEntityNamed(String task,
                                                           String subtask,
                                                           String entityName,
                                                           WOSession session)

Deprecated. use ERD2WFactory.erFactory().pageForTaskSubTaskAndEntityNamed(String task, String subtask, String entityName, WOSession session)

queryPageWithFetchSpecificationForEntityNamed

public static QueryPageInterface queryPageWithFetchSpecificationForEntityNamed(String fsName,
                                                                               String entityName,
                                                                               WOSession session)

Deprecated. use ERD2WFactory.erFactory().queryPageWithFetchSpecificationForEntityNamed(String fsName, String entityName, WOSession session)

errorPageForException

public static WOComponent errorPageForException(Throwable e,
                                                WOSession session)

Deprecated. use ERD2WFactory.erFactory().errorPageForException(Throwable e, WOSession session)

reportException

public static void reportException(Exception ex,
                                   D2WContext d2wContext)

displayNameForPropertyKey

public static String displayNameForPropertyKey(String key,
                                               String entityName,
                                               String language)

d2wContext

public static D2WContext d2wContext()

d2wContextValueForKey

public static Object d2wContextValueForKey(String key,
                                           String entityName)

d2wContextValueForKey

public static Object d2wContextValueForKey(String key,
                                           String entityName,
                                           NSDictionary extraValuesForContext)

createConfigurationForEntityNamed

public static String createConfigurationForEntityNamed(String entityName)

warmUpRuleCache

public static void warmUpRuleCache()

configureTraceRuleFiringRapidTurnAround

public static void configureTraceRuleFiringRapidTurnAround()

configureTraceRuleFiring

public static void configureTraceRuleFiring()

displayableArrayForKeyPathArray

public static NSArray displayableArrayForKeyPathArray(NSArray array,
                                                      String entityForReportName,
                                                      String language)