com.brightech.mb.workflow.js

Class JSDictionaryManager

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.brightech.xmp.js.MBScriptableObject

com.brightech.xmp.js.ReleasableScriptableObject

com.brightech.mb.workflow.js.JSBaseScriptableObject

com.brightech.mb.workflow.js.JSDictionaryManager

All Implemented Interfaces:

java.io.Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.ContextFactory.Listener, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable

public class JSDictionaryManager
extends JSBaseScriptableObject

js workflow manager for dictionary related items. Is available in workflow context pre-initialized as "dictionaryManager"

See Also:

Serialized Form

Field Summary

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
JSDictionaryManager()

Method Summary

Modifier and Type	Method and Description
void	(JavaScript Function) addWord(java.lang.String theDictionaryName, java.lang.String theWord, java.lang.String theSynonyms, java.lang.String theThesaurus) Add a word to the dictionary, if dictionary not found or word exists, nothing happens
boolean	(JavaScript Function) createEmptyDictionary(java.lang.String theDictionaryName) Creates an empty dictionary with the specified name.
boolean	(JavaScript Function) dictionaryExists(java.lang.String theDictionaryName) Returns true if the specified dictionary exists.
org.mozilla.javascript.NativeArray	(JavaScript Function) findWords(java.lang.String theDictionaryName, java.lang.String theValue, int theNumberOfResults, boolean theExactMatch) Given the value, find any words that match in the given dictionary.
java.lang.String	(JavaScript Function) getSynonyms(java.lang.String theDictionaryName, java.lang.String theWord, boolean theExactMatch) Returns the synonyms for the specified word in the specified dictionary.
void	(JavaScript Function) removeWord(java.lang.String theDictionaryName, java.lang.String theWord) Removes the specified word from the specified dictionary.

Methods inherited from class org.mozilla.javascript.ScriptableObject

associateValue, avoidObjectDetection, callMethod, callMethod, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassName, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasInstance, hasProperty, hasProperty, isConst, isEmpty, isExtensible, isSealed, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mozilla.javascript.ContextFactory.Listener

contextCreated, contextReleased

Constructor Detail

JSDictionaryManager

public JSDictionaryManager()

Method Detail

(JavaScript Function) dictionaryExists

public boolean (JavaScript Function) dictionaryExists(java.lang.String theDictionaryName)

Returns true if the specified dictionary exists.

Parameters:

theDictionaryName - the dictionary name

Returns:

true if found, false otherwise

(JavaScript Function) createEmptyDictionary

public boolean (JavaScript Function) createEmptyDictionary(java.lang.String theDictionaryName)

Creates an empty dictionary with the specified name.

Parameters:

theDictionaryName -

Returns:

true if the dictionary was created, false otherwise.

(JavaScript Function) addWord

public void (JavaScript Function) addWord(java.lang.String theDictionaryName,
                               java.lang.String theWord,
                               java.lang.String theSynonyms,
                               java.lang.String theThesaurus)

Add a word to the dictionary, if dictionary not found or word exists, nothing happens

Parameters:

theDictionaryName - the dictionary name

theWord - the word to potentially add

theSynonyms - the synonyms (may be null)

theThesaurus - the thesaurus (may be null)

(JavaScript Function) removeWord

public void (JavaScript Function) removeWord(java.lang.String theDictionaryName,
                                  java.lang.String theWord)

Removes the specified word from the specified dictionary.

Parameters:

theDictionaryName - the dictionary name

theWord - the word to remove

(JavaScript Function) findWords

public org.mozilla.javascript.NativeArray (JavaScript Function) findWords(java.lang.String theDictionaryName,
                                                               java.lang.String theValue,
                                                               int theNumberOfResults,
                                                               boolean theExactMatch)

Given the value, find any words that match in the given dictionary. Replace an wildcards with sql wildcards and place one at the end of the query (see theExactMatch parameter).

Parameters:

theDictionaryName - the dictionary to search in

theValue - the value

theNumberOfResults - the limit of the number of results

theExactMatch - Specifies whether to do exact match (true) or include wildcard at end of word (false). Default is false. (Optional parameter.)

Returns:

(JavaScript Function) getSynonyms

public java.lang.String (JavaScript Function) getSynonyms(java.lang.String theDictionaryName,
                                               java.lang.String theWord,
                                               boolean theExactMatch)

Returns the synonyms for the specified word in the specified dictionary. If more than one word matches the word, the first is used.

Parameters:

theDictionaryName -

theWord -

theExactMatch - Specifies whether to do exact match (true) or include wildcard at end of word (false). Default is false. (Optional parameter.)

Returns:

returns the synonyms as CSV, if defined, or null if the word or dictionary doesn't exist