ExpressionScript

java.lang.Object
- com.accela.aa.emse.dom.ExpressionScript

All Implemented Interfaces:: java.io.Serializable

public class ExpressionScript
extends java.lang.Object
implements java.io.Serializable

 
  Accela Automation
  File: ExpressionScript.java
 
  Accela, Inc.
  Copyright (C): 2007-2014
 
  Description:
  TODO
 
  Notes:
        $Id: ExpressionScript.java 128065 2009-04-23 02:14:37Z ..\hikelee.li $ 
 
  Revision History
  <Date>,         <Who>,                    <What>
  Nov 27, 2007                  hikelee.li                              Initial.

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

HttpClientScript httpClient

ProxyInvoker proxyInvoker

Fields
Modifier and Type	Field and Description
`HttpClientScript`	`httpClient`
`ProxyInvoker`	`proxyInvoker`

Constructor Summary

Constructors
Constructor and Description

ExpressionScript(ExpressionScriptModel scriptModel)
Specific which portlets which are used by expression are displayed in web page now

Constructors
Constructor and Description
`ExpressionScript(ExpressionScriptModel scriptModel)` Specific which portlets which are used by expression are displayed in web page now

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`addDate(java.lang.String startDate, long addDays)` Add or subtract date for some days
`void`	`addMessage(java.lang.String message)` Add the message for page form
`void`	`addVariblesFromDB(java.lang.Long viewID, java.lang.String querySQL, java.util.List<java.lang.String> params)` Add referenced portlet field variables into expression input parameters
`void`	`callEMSEScript(java.util.Hashtable<java.lang.String,java.util.Hashtable<java.lang.String,java.lang.Object>> calledEMSE)` Call EMSE Script with script name and script parameters
`void`	`checkDateUseLocaleDatePattern(java.lang.String date, java.lang.String errorMsg)` Check the date string whether is valid date format or not according current language date pattern, if it's not a valid date format, throw a exception.
`void`	`cleanEvn()` Clean JS engine's context to avoid memory leak.
`java.util.List<java.lang.Object>`	`createParamList()` Create a new lookup table query parameter.
`java.util.Map<java.lang.String,java.lang.Object>`	`createParamMap()` Create a new Hashtable use as the parameters Map; For example, it can be used for EMSE Script input parameters initial
`long`	`diffDate(java.lang.String startDate, java.lang.String endDate)` Calculate how many days data1 before data2
`java.lang.String`	`executeAggregateFunction(java.lang.String functionName, java.util.List<java.lang.Object> values)` Calculation the aggregate function for running total column
`java.lang.String`	`formatDate(java.lang.String dateString, java.lang.String pattern)` Parser date string into given formatted string This method use to convert inputed date string to given formatted string.
`java.lang.String`	`getCurrentDatePattern()` Get current agency date format pattern according the I18N setting
`java.lang.String`	`getExpressionName()` Get current running Expression Name
`java.util.Map<java.lang.String,java.lang.String>`	`getOutputMap()` Get a new HashMap for look up output params; Key is asi field appears in asi portlet Value is corresponding look up table column var output=expression.getOutputMap(); output.put('field1','code:sub:column2')
`ScriptRoot`	`getScriptRoot()` Get EMSE ScriptRoot to support EMSE
`java.lang.String`	`getScriptText()` Get current running Expression script text
`long`	`getSourceSeqNbr(java.lang.String serviceProvCode)` Get agency source sequence number by agency code
`int`	`getTotalRowCount()` Get table total row count
`com.accela.aa.aamain.expression.ExpressionFieldModel`	`getValue(int rowIndex, java.lang.String variableKey)` Get a table cell by row index and column name
`com.accela.aa.aamain.expression.ExpressionFieldModel`	`getValue(java.lang.String variableKey)` Get expression field by variableKey
`ScriptResult`	`includeScript(java.lang.String scriptID)` Allows a user to execute another script within the same context.
`void`	`initEnv(org.mozilla.javascript.Context cx, org.mozilla.javascript.Scriptable scope)` Initialize JS engine environment for invoking sub script in a context.
`java.lang.String`	`lookup(java.lang.String sqlStr, java.util.List<java.lang.String> sqlParams)` Execute lookup() function
`java.lang.String`	`parseDate(java.lang.String dateString)` Parser date string into java.util.Date This method use to generate the reference portlet data search SQL statement, if the field type is HTML_TEXTBOX_OF_DATE, we need parse the field value date string to a date object with current agency date pattern setting, then parse the date object format to "MM/dd/yyyy" and use it as the SQL parameter.
`void`	`print(java.lang.String info)` Print debug information
`void`	`setReturn(com.accela.aa.aamain.expression.ExpressionFieldModel model)` Set field as a return field
`void`	`setReturn(int rowIndex, com.accela.aa.aamain.expression.ExpressionFieldModel model)` Set field as a return field

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - proxyInvoker
```
public final transient ProxyInvoker proxyInvoker
```
  - httpClient
```
public final transient HttpClientScript httpClient
```
- Constructor Detail
  - ExpressionScript
```
public ExpressionScript(ExpressionScriptModel scriptModel)
                 throws com.accela.aa.exception.AAException
```
    Specific which portlets which are used by expression are displayed in web page now
    
    Parameters:
    scriptModel - The initialled Expression runtime envrioment
    
    Throws:
    
    com.accela.aa.exception.AAException
- Method Detail
  - initEnv
```
public void initEnv(org.mozilla.javascript.Context cx,
           org.mozilla.javascript.Scriptable scope)
```
    Initialize JS engine environment for invoking sub script in a context. Please don't invoke it, it is only used for EMSE engine.
    
    Parameters:
    cx -
    scope -
  - cleanEvn
```
public void cleanEvn()
```
    Clean JS engine's context to avoid memory leak. Please don't invoke it, it is only used for EMSE engine.
  - includeScript
```
public ScriptResult includeScript(java.lang.String scriptID)
```
    Allows a user to execute another script within the same context. It is a real include mode.
    
    Parameters:
    scriptID - the 'code' for the script (not the 'name')
    
    Throws:
    
    java.lang.Exception - the exception
  - addVariblesFromDB
```
public void addVariblesFromDB(java.lang.Long viewID,
                     java.lang.String querySQL,
                     java.util.List<java.lang.String> params)
                       throws com.accela.aa.exception.AAException,
                              java.rmi.RemoteException
```
    Add referenced portlet field variables into expression input parameters
    
    Parameters:
    viewID -
    querySQL -
    params -
    
    Throws:
    
    com.accela.aa.exception.AAException
    
    java.rmi.RemoteException
  - getValue
```
public com.accela.aa.aamain.expression.ExpressionFieldModel getValue(int rowIndex,
                                                            java.lang.String variableKey)
```
    Get a table cell by row index and column name
    
    Parameters:
    rowIndex - - row index
    variableKey - - column name
    
    Returns:
    ExpressionFieldModel
  - getValue
```
public com.accela.aa.aamain.expression.ExpressionFieldModel getValue(java.lang.String variableKey)
```
    Get expression field by variableKey
    
    Parameters:
    variableKey - String
    
    Returns:
    ExpressionFieldModel
  - getTotalRowCount
```
public int getTotalRowCount()
```
    Get table total row count
    
    Returns:
    Total Row Count
  - addMessage
```
public void addMessage(java.lang.String message)
```
    Add the message for page form
    
    Parameters:
    message -
  - setReturn
```
public void setReturn(int rowIndex,
             com.accela.aa.aamain.expression.ExpressionFieldModel model)
```
    Set field as a return field
    
    Parameters:
    rowIndex - table row index
    model - current variable reference ExpressionFieldModel Object
  - setReturn
```
public void setReturn(com.accela.aa.aamain.expression.ExpressionFieldModel model)
```
    Set field as a return field
    
    Parameters:
    model - current variable reference ExpressionFieldModel Object
  - getOutputMap
```
public java.util.Map<java.lang.String,java.lang.String> getOutputMap()
```
    Get a new HashMap for look up output params; Key is asi field appears in asi portlet Value is corresponding look up table column var output=expression.getOutputMap(); output.put('field1','code:sub:column2')
  - createParamList
```
public java.util.List<java.lang.Object> createParamList()
```
    Create a new lookup table query parameter.
    
    Returns:
    List of parameter
  - createParamMap
```
public java.util.Map<java.lang.String,java.lang.Object> createParamMap()
```
    Create a new Hashtable use as the parameters Map; For example, it can be used for EMSE Script input parameters initial
    
    Returns:
    Parameter Map
  - callEMSEScript
```
public void callEMSEScript(java.util.Hashtable<java.lang.String,java.util.Hashtable<java.lang.String,java.lang.Object>> calledEMSE)
```
    Call EMSE Script with script name and script parameters
    
    Parameters:
    calledEMSE -
    
    Throws:
    
    java.rmi.RemoteException
    
    com.accela.aa.exception.AAException
  - lookup
```
public java.lang.String lookup(java.lang.String sqlStr,
                      java.util.List<java.lang.String> sqlParams)
```
    Execute lookup() function
    
    Parameters:
    sqlStr - String
    sqlParams - List of String
    
    Returns:
    Lookup Result
  - executeAggregateFunction
```
public java.lang.String executeAggregateFunction(java.lang.String functionName,
                                        java.util.List<java.lang.Object> values)
                                          throws com.accela.aa.exception.AAException,
                                                 java.rmi.RemoteException
```
    Calculation the aggregate function for running total column
    
    Parameters:
    functionName - String
    values - List of Object
    
    Returns:
    execute result
    
    Throws:
    
    com.accela.aa.exception.AAException
    
    java.rmi.RemoteException
  - getSourceSeqNbr
```
public long getSourceSeqNbr(java.lang.String serviceProvCode)
                     throws java.rmi.RemoteException,
                            com.accela.aa.exception.AAException
```
    Get agency source sequence number by agency code
    
    Parameters:
    serviceProvCode -
    
    Returns:
    Source Sequence Number
    
    Throws:
    
    java.rmi.RemoteException
    
    com.accela.aa.exception.AAException
  - addDate
```
public java.lang.String addDate(java.lang.String startDate,
                       long addDays)
                         throws com.accela.aa.exception.AAException
```
    Add or subtract date for some days
    
    Parameters:
    startDate - The date to be added. Date format MM/DD/YYYY, for example 04/29/2008
    addDays - How many days to be added
    
    Returns:
    Added date
    
    Throws:
    
    com.accela.aa.exception.AAException
  - diffDate
```
public long diffDate(java.lang.String startDate,
            java.lang.String endDate)
              throws com.accela.aa.exception.AAException
```
    Calculate how many days data1 before data2
    
    Parameters:
    startDate - - Date formate MM/DD/YYYY, for example: 04/29/2008
    endDate - - Date formate MM/DD/YYYY, for example: 04/29/2008
    
    Returns:
    date1 - date2
    
    Throws:
    
    java.lang.Exception
    
    com.accela.aa.exception.AAException
  - checkDateUseLocaleDatePattern
```
public void checkDateUseLocaleDatePattern(java.lang.String date,
                                 java.lang.String errorMsg)
                                   throws com.accela.aa.exception.AAException
```
    Check the date string whether is valid date format or not according current language date pattern, if it's not a valid date format, throw a exception.
    
    Parameters:
    date -
    errorMsg -
    
    Throws:
    
    com.accela.aa.exception.AAException
  - formatDate
```
public java.lang.String formatDate(java.lang.String dateString,
                          java.lang.String pattern)
                            throws java.text.ParseException
```
    Parser date string into given formatted string This method use to convert inputed date string to given formatted string. It is originally used for bug33067 so that it can be used to compare dates in JavaScript
    
    Parameters:
    dateString -
    pattern - format string. It is yyyy/MM/dd for bug 33067
    
    Returns:
    formatted string
    
    Throws:
    
    java.text.ParseException
  - parseDate
```
public java.lang.String parseDate(java.lang.String dateString)
                           throws java.text.ParseException
```
    Parser date string into java.util.Date This method use to generate the reference portlet data search SQL statement, if the field type is HTML_TEXTBOX_OF_DATE, we need parse the field value date string to a date object with current agency date pattern setting, then parse the date object format to "MM/dd/yyyy" and use it as the SQL parameter. Because all I18N language date infomation save to pattern "MM/dd/yyyy".
    
    Parameters:
    dateString -
    
    Returns:
    String of entered date
    
    Throws:
    
    java.text.ParseException
  - getCurrentDatePattern
```
public java.lang.String getCurrentDatePattern()
```
    Get current agency date format pattern according the I18N setting
    
    Returns:
    Current Date Pattern
  - print
```
public void print(java.lang.String info)
```
    Print debug information
    
    Parameters:
    info -
  - getScriptRoot
```
public ScriptRoot getScriptRoot()
                         throws com.accela.aa.exception.AAException
```
    Get EMSE ScriptRoot to support EMSE
    
    Returns:
    Script Root
    
    Throws:
    
    com.accela.aa.exception.AAException
  - getScriptText
```
public java.lang.String getScriptText()
```
    Get current running Expression script text
    
    Returns:
    Script Text
  - getExpressionName
```
public java.lang.String getExpressionName()
```
    Get current running Expression Name
    
    Returns:
    Expression Name

Class ExpressionScript

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

proxyInvoker

httpClient

Constructor Detail

ExpressionScript

Method Detail

initEnv

cleanEvn

includeScript

addVariblesFromDB

getValue

getValue

getTotalRowCount

addMessage

setReturn

setReturn

getOutputMap

createParamList

createParamMap

callEMSEScript

lookup

executeAggregateFunction

getSourceSeqNbr

addDate

diffDate

checkDateUseLocaleDatePattern

formatDate

parseDate

getCurrentDatePattern

print

getScriptRoot

getScriptText

getExpressionName