er.directtoweb
Class ERD2WModel

java.lang.Object
  com.webobjects.directtoweb.D2WModel
      er.directtoweb.ERD2WModel

All Implemented Interfaces:

EOKeyValueArchiving

public class ERD2WModel
extends com.webobjects.directtoweb.D2WModel

Overhaul of the caching system.

Nested Class Summary

Nested classes/interfaces inherited from interface com.webobjects.eocontrol.EOKeyValueArchiving

EOKeyValueArchiving._NullValueSupport, EOKeyValueArchiving._NumberSupport, EOKeyValueArchiving._TimestampSupport, EOKeyValueArchiving.Awaking, EOKeyValueArchiving.FinishInitialization, EOKeyValueArchiving.Support

Field Summary

protected File	_currentFile
protected Hashtable	_filePathRuleTraceCache
protected Hashtable	_uniqueAndQualifiers
protected Hashtable	_uniqueAssignments
protected Hashtable	_uniqueKeyValueQualifiers
protected Hashtable	_uniqueNotQualifiers
protected Hashtable	_uniqueOrQualifiers
protected static String	ATTRIBUTE_PREFIX
protected static String	ENTITY_PREFIX
static Logger	log logging support
static String	ModelWillReset
protected static String	RELATIONSHIP_PREFIX
static Logger	ruleDecodeLog logs rules being decoded
static Logger	ruleTraceEnabledLog main category for enabling or disabling tracing of rules
protected int	totalQualifiers
protected int	uniquedQualifiers
static String	WillSortRules

Fields inherited from class com.webobjects.directtoweb.D2WModel

_PageWrapperNameKey, _tasks, ActionsKey, AllMarker, AllowCollapsingKey, AlternateRowColorKey, AttributeKey, AttributeTypeKey, BackgroundColorForPageKey, BackgroundColorForTableKey, BoldKey, ColorKey, ComponentAvailableKey, ComponentNameKey, ComponentsToShowAtEndKey, CustomTypeKey, DisplayNameForPropertyKey, DisplayPropertyKeysKey, DummyTrueKey, DynamicPageKey, EntityKey, FormatterKey, FrameKey, FramesActiveKey, IsGeneratingKey, ItalicKey, KeyPathTypeKey, KeyWhenRelationshipKey, LengthKey, LookKey, NoneMarker, One, PageAvailableKey, PageNameKey, PropertyIsKeyPathKey, PropertyKey, PropertyKeyKey, PropertyKeyPortionInModelKey, PropertyTypeKey, ReadOnlyEntityNamesKey, RelationshipKey, RelationshipTypeKey, RequiresEntityKey, SessionKey, ShowBannerKey, StartupEntityNameKey, StartupTaskKey, TargetKey, TaskKey, VisibleEntityNamesKey, WebAssistantPageNameKey, Zero

Fields inherited from interface com.webobjects.eocontrol.EOKeyValueArchiving

_CLASS

Constructor Summary

protected	ERD2WModel(EOKeyValueUnarchiver unarchiver)
protected	ERD2WModel(File file)
protected	ERD2WModel(NSArray rules) Main constructor.
	ERD2WModel(URL url)

Method Summary

protected void	_addKeyToVector(String key, Vector vector)
protected NSSet	_addKeyToVectorKeysToTakeLiterally()
void	_diagnoseCache()
protected boolean	_shouldUseCacheForFiringRuleForKeyPathInContext(String keyPath, com.webobjects.directtoweb.D2WContext context)
void	addRule(com.webobjects.directtoweb.Rule rule)
void	addRules(NSArray rules)
protected EOAndQualifier	andQualifierInCache(EOAndQualifier q)
void	applicationDidFinishLaunching(NSNotification n)
void	applicationWillDispatchRequest(NSNotification n)
protected com.webobjects.directtoweb.Assignment	assignmentContainedInVector(com.webobjects.directtoweb.Assignment a1, Vector v)
NSArray	availablePageConfigurations()
NSArray	availableTasks()
protected Hashtable	cacheFromBytes(byte[] bytes)
protected byte[]	cacheToBytes(Hashtable cache)
NSArray	canidateRuleSetForRHSInContext(String rhs, com.webobjects.directtoweb.D2WContext context)
void	clearD2WRuleCache()
void	clearD2WRuleCache(NSNotification n)
protected File	currentFile()
protected Object	decodeObject(Object o)
protected String	descriptionForRule(com.webobjects.directtoweb.Rule r)
protected String	descriptionForRuleSet(NSArray set)
protected static NSDictionary	dictionaryFromPathUrl(URL url)
void	dumpCache(String fileName) Means to dump the cache.
protected Object	encodeObject(Object o)
static ERD2WModel	erDefaultModel() Gets the default D2W model cast as an ERD2WModel.
protected Object	fireRuleForKeyPathInContext(String keyPath, com.webobjects.directtoweb.D2WContext context)
protected Object	fireSystemRuleForKeyPathInContext(String keyPath, com.webobjects.directtoweb.D2WContext context)
protected void	flushUniqueCache()
protected void	invalidateCaches()
protected EOKeyValueQualifier	keyValueQualifierInCache(EOKeyValueQualifier q)
protected void	mergeFile(File modelFile)
protected void	mergePathURL(URL modelURL)
Vector	modelFilesInBundles()
Vector	modelFilesPathURLsInBundles() Overridden to support additional d2wmodel files.
String	nameForSet(NSSet set)
protected EONotQualifier	notQualifierInCache(EONotQualifier q)
protected EOOrQualifier	orQualifierInCache(EOOrQualifier q)
void	prepareDataStructures()
protected EOQualifier	qualifierContainedInEnumeration(EOQualifierEvaluation q1, Enumeration e)
protected EOQualifier	qualifierInCache(EOQualifier q)
protected ERXMultiKey	readEntry(Hashtable cache, ObjectInputStream in)
void	removeRule(com.webobjects.directtoweb.Rule rule)
void	resetModel()
void	restoreCache(String fileName) Means to restore the cache.
NSArray	rules()
protected void	setCurrentFile(File currentFile)
protected void	sortRules()
protected void	uniqueQualifiers(NSArray rules)
protected void	uniqueRuleAssignments(NSArray rules)
protected boolean	writeEntry(ERXMultiKey key, Object value, ObjectOutputStream out)

Methods inherited from class com.webobjects.directtoweb.D2WModel

_fireRule, addRuleToItsBucket, addRuleTrace, candidates, canSaveUserModel, checkPossibilityToSaveUserModel, checkRules, clientConfiguration, clientConfigurationFilesInBundles, clientConfigurationFilesPathURLsInBundles, componentDefinitions, createWebAssistantRulesWithSettings, dataTypesInvolved, defaultModel, dirty, dynamicPages, editors, encodeWebAssistantRulesWithKeyValueArchiver, encodeWithKeyValueArchiver, fireAllRulesForKeyPathInContext, inferrableKeys, initializeClientConfiguration, isPageStatic, loadRules, nameFromFrameworkBundle, newSettings, pageRuleKeysForPage, pageRuleKeysFromClientConfiguration, propertyRuleKeysForComponents, propertyRuleKeysFromClientConfiguration, removeAllWebAssistantRules, removeDynamicPage, removeWebAssistantRulesWithSameContextAsSettings, revertWebAssistantRules, saveWebAssistantRulesIntoUsedModelFile, setDefaultModel, setDirty, setRules, tasks, taskVector, toFile, toString, typeForRuleKey, updateUserSettingsForNewPageAvailableRule, userClientConfigurationFile, userClientConfigurationFilePathURL, userModelFile, userModelFilePathURL, webAssistantRulesForSave

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final Logger log

logging support

ruleDecodeLog

public static final Logger ruleDecodeLog

logs rules being decoded

ruleTraceEnabledLog

public static final Logger ruleTraceEnabledLog

main category for enabling or disabling tracing of rules

WillSortRules

public static final String WillSortRules

See Also:

Constant Field Values

ModelWillReset

public static final String ModelWillReset

See Also:

Constant Field Values

_filePathRuleTraceCache

protected Hashtable _filePathRuleTraceCache

_currentFile

protected File _currentFile

_uniqueAssignments

protected Hashtable _uniqueAssignments

uniquedQualifiers

protected int uniquedQualifiers

totalQualifiers

protected int totalQualifiers

_uniqueAndQualifiers

protected Hashtable _uniqueAndQualifiers

_uniqueOrQualifiers

protected Hashtable _uniqueOrQualifiers

_uniqueNotQualifiers

protected Hashtable _uniqueNotQualifiers

_uniqueKeyValueQualifiers

protected Hashtable _uniqueKeyValueQualifiers

ENTITY_PREFIX

protected static final String ENTITY_PREFIX

See Also:

Constant Field Values

RELATIONSHIP_PREFIX

protected static final String RELATIONSHIP_PREFIX

See Also:

Constant Field Values

ATTRIBUTE_PREFIX

protected static final String ATTRIBUTE_PREFIX

See Also:

Constant Field Values

Constructor Detail

ERD2WModel

protected ERD2WModel(NSArray rules)

Main constructor. Builds a model for a given set of rules.

Parameters:

rules - array of rules

ERD2WModel

protected ERD2WModel(File file)

ERD2WModel

public ERD2WModel(URL url)

ERD2WModel

protected ERD2WModel(EOKeyValueUnarchiver unarchiver)

Method Detail

erDefaultModel

public static ERD2WModel erDefaultModel()

Gets the default D2W model cast as an ERD2WModel.

Returns:

the default ERD2Model

clearD2WRuleCache

public void clearD2WRuleCache()

availableTasks

public NSArray availableTasks()

availablePageConfigurations

public NSArray availablePageConfigurations()

sortRules

protected void sortRules()

Overrides:

sortRules in class com.webobjects.directtoweb.D2WModel

applicationWillDispatchRequest

public void applicationWillDispatchRequest(NSNotification n)

applicationDidFinishLaunching

public void applicationDidFinishLaunching(NSNotification n)

clearD2WRuleCache

public void clearD2WRuleCache(NSNotification n)

rules

public NSArray rules()

Overrides:

rules in class com.webobjects.directtoweb.D2WModel

addRule

public void addRule(com.webobjects.directtoweb.Rule rule)

Overrides:

addRule in class com.webobjects.directtoweb.D2WModel

removeRule

public void removeRule(com.webobjects.directtoweb.Rule rule)

Overrides:

removeRule in class com.webobjects.directtoweb.D2WModel

descriptionForRuleSet

protected String descriptionForRuleSet(NSArray set)

descriptionForRule

protected String descriptionForRule(com.webobjects.directtoweb.Rule r)

addRules

public void addRules(NSArray rules)

Overrides:

addRules in class com.webobjects.directtoweb.D2WModel

fireSystemRuleForKeyPathInContext

protected Object fireSystemRuleForKeyPathInContext(String keyPath,
                                                   com.webobjects.directtoweb.D2WContext context)

Overrides:

fireSystemRuleForKeyPathInContext in class com.webobjects.directtoweb.D2WModel

fireRuleForKeyPathInContext

protected Object fireRuleForKeyPathInContext(String keyPath,
                                             com.webobjects.directtoweb.D2WContext context)

Overrides:

fireRuleForKeyPathInContext in class com.webobjects.directtoweb.D2WModel

_shouldUseCacheForFiringRuleForKeyPathInContext

protected boolean _shouldUseCacheForFiringRuleForKeyPathInContext(String keyPath,
                                                                  com.webobjects.directtoweb.D2WContext context)

dumpCache

public void dumpCache(String fileName)

Means to dump the cache. You shouldn't use this unless you know what you are doing.

restoreCache

public void restoreCache(String fileName)

Means to restore the cache. You shouldn't use this unless you know what you are doing.

canidateRuleSetForRHSInContext

public NSArray canidateRuleSetForRHSInContext(String rhs,
                                              com.webobjects.directtoweb.D2WContext context)

_addKeyToVectorKeysToTakeLiterally

protected NSSet _addKeyToVectorKeysToTakeLiterally()

_addKeyToVector

protected void _addKeyToVector(String key,
                               Vector vector)

prepareDataStructures

public void prepareDataStructures()

invalidateCaches

protected void invalidateCaches()

Overrides:

invalidateCaches in class com.webobjects.directtoweb.D2WModel

resetModel

public void resetModel()

setCurrentFile

protected void setCurrentFile(File currentFile)

currentFile

protected File currentFile()

dictionaryFromPathUrl

protected static NSDictionary dictionaryFromPathUrl(URL url)

mergePathURL

protected void mergePathURL(URL modelURL)

Overrides:

mergePathURL in class com.webobjects.directtoweb.D2WModel

mergeFile

protected void mergeFile(File modelFile)

Overrides:

mergeFile in class com.webobjects.directtoweb.D2WModel

uniqueRuleAssignments

protected void uniqueRuleAssignments(NSArray rules)

assignmentContainedInVector

protected com.webobjects.directtoweb.Assignment assignmentContainedInVector(com.webobjects.directtoweb.Assignment a1,
                                                                            Vector v)

uniqueQualifiers

protected void uniqueQualifiers(NSArray rules)

modelFilesInBundles

public Vector modelFilesInBundles()

Overrides:

modelFilesInBundles in class com.webobjects.directtoweb.D2WModel

modelFilesPathURLsInBundles

public Vector modelFilesPathURLsInBundles()

Overridden to support additional d2wmodel files. Provide an array of filenames (including extension) in the property 'er.directtoweb.ERD2WModel.additionalModelNames', these files should get loaded and added to the rules set during application startup.

Overrides:

modelFilesPathURLsInBundles in class com.webobjects.directtoweb.D2WModel

qualifierContainedInEnumeration

protected EOQualifier qualifierContainedInEnumeration(EOQualifierEvaluation q1,
                                                      Enumeration e)

qualifierInCache

protected EOQualifier qualifierInCache(EOQualifier q)

andQualifierInCache

protected EOAndQualifier andQualifierInCache(EOAndQualifier q)

orQualifierInCache

protected EOOrQualifier orQualifierInCache(EOOrQualifier q)

notQualifierInCache

protected EONotQualifier notQualifierInCache(EONotQualifier q)

keyValueQualifierInCache

protected EOKeyValueQualifier keyValueQualifierInCache(EOKeyValueQualifier q)

flushUniqueCache

protected void flushUniqueCache()

nameForSet

public String nameForSet(NSSet set)

encodeObject

protected Object encodeObject(Object o)

decodeObject

protected Object decodeObject(Object o)

writeEntry

protected boolean writeEntry(ERXMultiKey key,
                             Object value,
                             ObjectOutputStream out)
                      throws IOException

Throws:

IOException

readEntry

protected ERXMultiKey readEntry(Hashtable cache,
                                ObjectInputStream in)
                         throws IOException,
                                ClassNotFoundException

Throws:

IOException

ClassNotFoundException

cacheToBytes

protected byte[] cacheToBytes(Hashtable cache)

cacheFromBytes

protected Hashtable cacheFromBytes(byte[] bytes)

_diagnoseCache

public void _diagnoseCache()