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, org.mozilla.javascript.SymbolScriptable

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

Nested Class Summary

Nested classes/interfaces inherited from class org.mozilla.javascript.ScriptableObject

org.mozilla.javascript.ScriptableObject.KeyComparator

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
java.lang.String	jsFunction_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
JSDictionary	jsFunction_createDictionaryFromFile(java.lang.String theName, java.lang.String theDescription, boolean theIsDynamic, IFileObject theFile) Creates a dictionary (either regular or dynamic) with the specified name from the specified file.
void	jsFunction_createDynamicRow(JSDictionary theDictionary, org.mozilla.javascript.NativeArray theWordsList) Creates a new row from the specified words in the specified dynamic dictionary.
boolean	jsFunction_createEmptyDictionary(java.lang.String theDictionaryName) Creates an empty dictionary with the specified name.
void	jsFunction_deleteDictionary(JSDictionary theDictionary) Deletes the specified dictionary, either regular or dynamic.
void	jsFunction_deleteDynamicRow(JSDictionary theDictionary, org.mozilla.javascript.NativeArray theWordsList) Removes the specified row from the specified dynamic dictionary.
boolean	jsFunction_dictionaryExists(java.lang.String theDictionaryName) Returns true if the specified dictionary exists.
java.lang.Integer	jsFunction_findDictionaryIdByUUID(java.lang.String theUUID) Method returns the dictionary id associated with the word found by using this UUID
JSWord[]	jsFunction_findJSWords(java.lang.String theDictionaryName, java.lang.String theValue, int theNumberOfResults, boolean theExactMatch) Given the value, find any JSWords that match in the given dictionary.
org.mozilla.javascript.NativeArray	jsFunction_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.
org.mozilla.javascript.NativeObject	jsFunction_getDictionaryByName(java.lang.String theName) Deprecated. Use jsFunction_getJSDictionaryByName(java.lang.String)
java.lang.String	jsFunction_getDictionaryName(int theId) Returns the dictionary name for the specified id.
java.lang.String[]	jsFunction_getDynamicColumns(JSDictionary theDictionary, boolean theToLowercase) Returns the array of table columns for the dynamic dictionary, in either natural or lower case.
java.lang.String[]	jsFunction_getDynamicHeaders(JSDictionary theDictionary) Returns the array of column headers (original CSV column names) for the dynamic dictionary.
org.mozilla.javascript.NativeArray	jsFunction_getDynamicWords(JSDictionary theDictionary, int theOffset, int theLimit, org.mozilla.javascript.NativeArray theColumnFilters, java.lang.String theSortColumn, java.lang.String theSolrDir) Returns the specified page of words for the specified dynamic dictionary table, column filters, and sort.
JSDictionary	jsFunction_getJSDictionaryByName(java.lang.String theName) Gets all the information about a dictionary by name.
java.lang.String	jsFunction_getSynonyms(java.lang.String theDictionaryName, java.lang.String theWord, boolean theExactMatch) Returns the synonyms for the specified word in the specified dictionary.
java.lang.String	jsFunction_getThesaurus(java.lang.String theDictionaryName, java.lang.String theWord, boolean theExactMatch) Returns the thesuarus for the specified word in the specified dictionary.
org.mozilla.javascript.NativeArray	jsFunction_getWordsForSynonym(java.lang.String theDictionaryName, java.lang.String theSynonym) Returns an array of words from the specified dictionary that have the given synonym.
org.mozilla.javascript.NativeArray	jsFunction_listDictionaries() Lists all the dictionaries (dictionary names).
org.mozilla.javascript.NativeArray	jsFunction_listDictionaryNames() Lists all the dictionaries (dictionary names).
org.mozilla.javascript.NativeArray	jsFunction_listWords(java.lang.String theDictionaryName) Returns the array of words in the specified dictionary.
void	jsFunction_rebuildNormalizedSynonyms() Rebuild the j101t_synonyms_norm table from the contents of j72t_synonyms
boolean	jsFunction_removeWord(java.lang.String theDictionaryName, java.lang.String theWord) Removes the specified word from the specified dictionary.
void	jsFunction_renameWordByName(java.lang.String theDictionaryName, java.lang.String theWord, java.lang.String theNewWord) Renames the specified word in the specified dictionary.
void	jsFunction_renameWordByUUID(java.lang.String theUUID, java.lang.String theNewWord) Renames the word in a particular dictionary, as specified by the UUID.
void	jsFunction_updateDynamicWord(JSDictionary theDictionary, int theColumnIndex, java.lang.String theNewWord, org.mozilla.javascript.NativeArray theWordsList) Updates the specified dynamic dictionary row at the specified index with the specified word.
void	jsFunction_updateWord(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 does not exist, nothing happens
void	jsFunction_updateWordByUUID(java.lang.String theUUID, java.lang.String theSynonyms, java.lang.String theThesaurus) Update a word's related content (synonyms, thesaurus) by looking up by UUID

Methods inherited from class org.mozilla.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, equivalentValues, get, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassName, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, has, hasInstance, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, put, putConst, putConstProperty, putProperty, putProperty, putProperty, querySlot, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setCommonDescriptorProperties, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

clone, equals, finalize, 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

jsFunction_listDictionaries

public org.mozilla.javascript.NativeArray jsFunction_listDictionaries()

Lists all the dictionaries (dictionary names).

Returns:

a native array of the dictionary names.

jsFunction_listDictionaryNames

public org.mozilla.javascript.NativeArray jsFunction_listDictionaryNames()

Lists all the dictionaries (dictionary names).

Returns:

a native array of the dictionary names.

jsFunction_rebuildNormalizedSynonyms

public void jsFunction_rebuildNormalizedSynonyms()

Rebuild the j101t_synonyms_norm table from the contents of j72t_synonyms

jsFunction_dictionaryExists

public boolean jsFunction_dictionaryExists(java.lang.String theDictionaryName)

Returns true if the specified dictionary exists.

Parameters:

theDictionaryName - the dictionary name

Returns:

true if found, false otherwise

jsFunction_createEmptyDictionary

public boolean jsFunction_createEmptyDictionary(java.lang.String theDictionaryName)

Creates an empty dictionary with the specified name.

Parameters:

theDictionaryName -

Returns:

true if the dictionary was created, false otherwise.

jsFunction_findDictionaryIdByUUID

public java.lang.Integer jsFunction_findDictionaryIdByUUID(java.lang.String theUUID)

Method returns the dictionary id associated with the word found by using this UUID

Parameters:

theUUID - the UUID of the word

Returns:

dictionary id of the dictionary associated with the word, or -1

jsFunction_addWord

public java.lang.String jsFunction_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)

Returns:

UUID of the created word or null;

jsFunction_renameWordByName

public void jsFunction_renameWordByName(java.lang.String theDictionaryName,
                                        java.lang.String theWord,
                                        java.lang.String theNewWord)

Renames the specified word in the specified dictionary.

Parameters:

theDictionaryName - the dictionary.

theWord - the word to rename.

theNewWord - the new (renamed) word.

jsFunction_renameWordByUUID

public void jsFunction_renameWordByUUID(java.lang.String theUUID,
                                        java.lang.String theNewWord)

Renames the word in a particular dictionary, as specified by the UUID.

Parameters:

theUUID - the UUID of the word in a particular dictionary to rename.

theNewWord - the new (renamed) word.

jsFunction_updateWordByUUID

public void jsFunction_updateWordByUUID(java.lang.String theUUID,
                                        java.lang.String theSynonyms,
                                        java.lang.String theThesaurus)

Update a word's related content (synonyms, thesaurus) by looking up by UUID

Parameters:

theUUID - the UUID to update

theSynonyms - the synonyms to overwrite (may be null)

theThesaurus - the thesaurus to overwrite (may be null)

jsFunction_updateWord

public void jsFunction_updateWord(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 does not exist, 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)

jsFunction_removeWord

public boolean jsFunction_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

Returns:

true if delete occurs

jsFunction_findWords

public org.mozilla.javascript.NativeArray jsFunction_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 (name or ID)

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:

array of matching words (strings). (Excludes synonyms and thesaurus.)

jsFunction_findJSWords

public JSWord[] jsFunction_findJSWords(java.lang.String theDictionaryName,
                                       java.lang.String theValue,
                                       int theNumberOfResults,
                                       boolean theExactMatch)

Given the value, find any JSWords 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 (name or ID)

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:

array of matching words (JSWords). (Includes synonyms and thesaurus.)

jsFunction_getWordsForSynonym

public org.mozilla.javascript.NativeArray jsFunction_getWordsForSynonym(java.lang.String theDictionaryName,
                                                                        java.lang.String theSynonym)

Returns an array of words from the specified dictionary that have the given synonym.

Parameters:

theSynonym - the synonym.

Returns:

{array} of matching words (strings).

jsFunction_listWords

public org.mozilla.javascript.NativeArray jsFunction_listWords(java.lang.String theDictionaryName)

Returns the array of words in the specified dictionary.

Parameters:

theDictionaryName - the dictionary.

Returns:

array of words (strings).

jsFunction_getSynonyms

public java.lang.String jsFunction_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

jsFunction_getThesaurus

public java.lang.String jsFunction_getThesaurus(java.lang.String theDictionaryName,
                                                java.lang.String theWord,
                                                boolean theExactMatch)

Returns the thesuarus 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

jsFunction_getDictionaryName

public java.lang.String jsFunction_getDictionaryName(int theId)

Returns the dictionary name for the specified id.

Parameters:

theId - the dictionary id.

Returns:

the dictionary name, or empty string if not found.

jsFunction_getDictionaryByName

public org.mozilla.javascript.NativeObject jsFunction_getDictionaryByName(java.lang.String theName)

Deprecated. Use jsFunction_getJSDictionaryByName(java.lang.String)

Gets all the information about a dictionary by name.

Parameters:

theName - the name to query.

Returns:

a js object of the dictionary including id, name, description, and hierarchy sync.

See Also:

JSDictionaryManager.jsFunction_getJSDictionaryByName(java.lang.String)

jsFunction_getJSDictionaryByName

public JSDictionary jsFunction_getJSDictionaryByName(java.lang.String theName)

Gets all the information about a dictionary by name.

Parameters:

theName - the name to query.

Returns:

a JSDictionary, if found, otherwise returns null.

jsFunction_createDictionaryFromFile

public JSDictionary jsFunction_createDictionaryFromFile(java.lang.String theName,
                                                        java.lang.String theDescription,
                                                        boolean theIsDynamic,
                                                        IFileObject theFile)

Creates a dictionary (either regular or dynamic) with the specified name from the specified file.

Parameters:

theName - the dictionary name.

theDescription - the dictionary name.

theIsDynamic - is this a dynamic dictionary?

theFile - the file (CSV, XLS, XLSX) to create the dictionary from.

Returns:

the JSDictionary instance, if created, otherwise null.

jsFunction_deleteDictionary

public void jsFunction_deleteDictionary(JSDictionary theDictionary)

Deletes the specified dictionary, either regular or dynamic.

Parameters:

theDictionary - the dictionary.

jsFunction_getDynamicColumns

public java.lang.String[] jsFunction_getDynamicColumns(JSDictionary theDictionary,
                                                       boolean theToLowercase)

Returns the array of table columns for the dynamic dictionary, in either natural or lower case.

Parameters:

theDictionary - the dynamic dictionary.

theToLowercase - convert to all lowercase (vs natural case)?

Returns:

the array, or the empty array not found.

jsFunction_getDynamicHeaders

public java.lang.String[] jsFunction_getDynamicHeaders(JSDictionary theDictionary)

Returns the array of column headers (original CSV column names) for the dynamic dictionary.

Parameters:

theDictionary - the dynamic dictionary.

Returns:

the array, or the empty array if not found.

jsFunction_getDynamicWords

public org.mozilla.javascript.NativeArray jsFunction_getDynamicWords(JSDictionary theDictionary,
                                                                     int theOffset,
                                                                     int theLimit,
                                                                     org.mozilla.javascript.NativeArray theColumnFilters,
                                                                     java.lang.String theSortColumn,
                                                                     java.lang.String theSolrDir)

Returns the specified page of words for the specified dynamic dictionary table, column filters, and sort.

Parameters:

theDictionary - the dynamic dictionary.

theOffset - the page number (0-based).

theLimit - the page size.

theColumnFilters - the column filters. (No filtering/return all columns, if null/not defined.)

theSortColumn - the sort column. (The first column, if null/not defined.)

theSolrDir - the sort direction ("ASC" or "DESC"). ("ASC", if null/not defined.)

Returns:

the page of dynamic dictionary rows (of words).

jsFunction_deleteDynamicRow

public void jsFunction_deleteDynamicRow(JSDictionary theDictionary,
                                        org.mozilla.javascript.NativeArray theWordsList)

Removes the specified row from the specified dynamic dictionary.

Parameters:

theDictionary - the dynamic dictionary.

theWordsList - the words of the row to delete.

jsFunction_createDynamicRow

public void jsFunction_createDynamicRow(JSDictionary theDictionary,
                                        org.mozilla.javascript.NativeArray theWordsList)

Creates a new row from the specified words in the specified dynamic dictionary.

Parameters:

theDictionary - the dynamic dictionary.

theWordsList - the words of the row to create.

jsFunction_updateDynamicWord

public void jsFunction_updateDynamicWord(JSDictionary theDictionary,
                                         int theColumnIndex,
                                         java.lang.String theNewWord,
                                         org.mozilla.javascript.NativeArray theWordsList)

Updates the specified dynamic dictionary row at the specified index with the specified word.

Parameters:

theDictionary - the dictionary.

theColumnIndex - the column index to update.

theNewWord - the new word.

theWordsList - the existing words of the row to update (to search on).