Monitor (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- workbench.im.Monitor

```
public class Monitor
extends Object
```
Version:

$Id: Monitor.java 9109 2015-07-29 22:39:46Z brutzman $

Constructor Summary

Constructors
Constructor and Description
`Monitor(String sJID, String sSubject, String sBody)` Constructor
`Monitor(String sJID, String sSubject, String sBody, String dtStart, String dtEnd)` Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addWatchEvent(WatchEvent oWatch)` add regular expression
`void`	`clearKeywordBody()` clear list of Message Body keywords
`void`	`clearKeywordSubject()` clear list of Message Subject keywords
`String`	`getJID()` get Jabber user ID
`ArrayList`	`getKeywordBody()` get list of keywords in message body
`ArrayList`	`getKeywordSubject()` get list of Message Subject keywords
`ArrayList`	`getWatchEventList()` get list of watch events
`boolean`	`inKeywordBody(String sLine)` determine whether there is a match for list of Message Body keywords in the specified line List of words="mine, ship" Line = "Spotted a mine at location [x,y,z]"
`boolean`	`inKeywordBody(String sJID, String sLine)` determine whether there is a match for list of Message Body keywords in the specified line List of words="mine, ship" Line = "Spotted a mine at location [x,y,z]"
`boolean`	`inKeywordSubject(String sLine)` determine whether there is a match for list of Message Subject keywords in the specified line e.g.
`boolean`	`inKeywordSubject(String sJID, String sLine)` determine whether there is a match for list of Message Subject keywords in the specified line e.g.
`WatchEvent`	`inRegExp(String sLine)` check whether the line matches one of the regular expression
`void`	`setJID(String sJID)` set JID
`void`	`setKeywordBody(ArrayList<String> lst)` pass in list of Message Body keywords
`void`	`setKeywordBody(String sKey)` extract list of Message Body keywords in string delimited by "," and put in ArrayList
`void`	`setKeywordSubject(ArrayList<String> lst)` pass in list of Message Subject keywords
`void`	`setKeywordSubject(String sKey)` extract list of Subject keywords in string delimited by "," and put in ArrayLisy
`String`	`toString()` display contents of object
`static void`	`writeErr(String aStr)` write a error messgae to console
`static void`	`writeLn()` write a line to console
`static void`	`writeLn(String aStr)` write a line to console

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

- Constructor Detail
  - Monitor
```
public Monitor(String sJID,
               String sSubject,
               String sBody)
```
    Constructor
    
    Parameters:
    
    sJID - Jabber User ID
    
    sSubject - Message Subject keywords
    
    sBody - Message Body keywords
  - Monitor
```
public Monitor(String sJID,
               String sSubject,
               String sBody,
               String dtStart,
               String dtEnd)
```
    Constructor
    
    Parameters:
    
    sJID - Jabber User ID
    
    sSubject - Message Subject keywords
    
    sBody - Message Body keywords
    
    dtStart - start from, in "yyyymmddhhmmss" format
    
    dtEnd - stop at, in "yyyymmddhhmmss" format
- Method Detail
  - getJID
```
public String getJID()
```
    get Jabber user ID
    
    Returns:
    
    String value
  - setJID
```
public void setJID(String sJID)
```
    set JID
    
    Parameters:
    
    sJID - Jabber user ID
  - addWatchEvent
```
public void addWatchEvent(WatchEvent oWatch)
```
    add regular expression
    
    Parameters:
    
    oWatch - a Watch Event
  - getWatchEventList
```
public ArrayList getWatchEventList()
```
    get list of watch events
    
    Returns:
    
    a list
  - clearKeywordBody
```
public void clearKeywordBody()
```
    clear list of Message Body keywords
  - getKeywordBody
```
public ArrayList getKeywordBody()
```
    get list of keywords in message body
    
    Returns:
    
    array list
  - inKeywordBody
```
public boolean inKeywordBody(String sJID,
                             String sLine)
```
    determine whether there is a match for list of Message Body keywords in the specified line List of words="mine, ship" Line = "Spotted a mine at location [x,y,z]"
    
    Parameters:
    
    sJID - Jabber user ID
    
    sLine - sentence to be checked
    
    Returns:
    
    true if found, otherwise false
  - inKeywordBody
```
public boolean inKeywordBody(String sLine)
```
    determine whether there is a match for list of Message Body keywords in the specified line List of words="mine, ship" Line = "Spotted a mine at location [x,y,z]"
    
    Parameters:
    
    sLine - sentence to be checked
    
    Returns:
    
    true if found, otherwise false
  - setKeywordBody
```
public void setKeywordBody(String sKey)
```
    extract list of Message Body keywords in string delimited by "," and put in ArrayList
    
    Parameters:
    
    sKey - string of keywords
  - setKeywordBody
```
public void setKeywordBody(ArrayList<String> lst)
```
    pass in list of Message Body keywords
    
    Parameters:
    
    lst - list of keywords
  - clearKeywordSubject
```
public void clearKeywordSubject()
```
    clear list of Message Subject keywords
  - getKeywordSubject
```
public ArrayList getKeywordSubject()
```
    get list of Message Subject keywords
    
    Returns:
    
    array list
  - inKeywordSubject
```
public boolean inKeywordSubject(String sJID,
                                String sLine)
```
    determine whether there is a match for list of Message Subject keywords in the specified line e.g. List of words="mine, ship" Line = "Spotted a mine at location [x,y,z]", returns true
    
    Parameters:
    
    sJID - Jabber user ID
    
    sLine - sentence to be checked
    
    Returns:
    
    true if found, otherwise false
  - inKeywordSubject
```
public boolean inKeywordSubject(String sLine)
```
    determine whether there is a match for list of Message Subject keywords in the specified line e.g. List of words="mine, ship" Line = "Spotted a mine at location [x,y,z]", returns true
    
    Parameters:
    
    sLine - sentence to be checked
    
    Returns:
    
    true if found, otherwise false
  - inRegExp
```
public WatchEvent inRegExp(String sLine)
```
    check whether the line matches one of the regular expression
    
    Parameters:
    
    sLine - source string to be matched
    
    Returns:
    
    Matcher
  - setKeywordSubject
```
public void setKeywordSubject(String sKey)
```
    extract list of Subject keywords in string delimited by "," and put in ArrayLisy
    
    Parameters:
    
    sKey - string of keywords
  - setKeywordSubject
```
public void setKeywordSubject(ArrayList<String> lst)
```
    pass in list of Message Subject keywords
    
    Parameters:
    
    lst - list of keywords
  - toString
```
public String toString()
```
    display contents of object
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    string value
  - writeErr
```
public static void writeErr(String aStr)
```
    write a error messgae to console
    
    Parameters:
    
    aStr - line to be written to console
  - writeLn
```
public static void writeLn(String aStr)
```
    write a line to console
    
    Parameters:
    
    aStr - line to be written to console
  - writeLn
```
public static void writeLn()
```
    write a line to console

Class Monitor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Monitor

Monitor

Method Detail

getJID

setJID

addWatchEvent

getWatchEventList

clearKeywordBody

getKeywordBody

inKeywordBody

inKeywordBody

setKeywordBody

setKeywordBody

clearKeywordSubject

getKeywordSubject

inKeywordSubject

inKeywordSubject

inRegExp

setKeywordSubject

setKeywordSubject

toString

writeErr

writeLn

writeLn