ConfigApp (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- workbench.main.ConfigApp

All Implemented Interfaces:

Serializable, Cloneable
```
public class ConfigApp
extends Object
implements Serializable, Cloneable
```
Filename : ConfigApp.java Description : Application configuration data structure. Used by configurable toolbar Created Date : 23 November 2003 Revised Date : 23 November 2003 Course : Thesis Program : AUV Workbench 1.0 Compiler : JDK 1.4.2 onwards Platform : Windows 2000/Windows XP

Version:

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

Author:

Lee, Chin Siong Daryl

See Also:

Mission, SystemUtilities, Serialized Form

Constructor Summary

Constructors
Constructor and Description
`ConfigApp(String sName, String sTooltip, String sImage, String sContentType, boolean bShow)` constructor - without specifying command and default parameter
`ConfigApp(String sName, String sTooltip, String sImage, String sContentType, boolean bShow, String workingDir)`
`ConfigApp(String sName, String sTooltip, String sImage, String sCommand, String sDefaultParam, String sContentType, boolean bShow)` constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCommand(String sCommand)` add a command to the list
`String`	`getBackupURL()`
`String`	`getImagePath()`
`String`	`getName()`
`boolean`	`getShow()`
`String`	`getTooltip()`
`boolean`	`olderrunApp()` run/execute application, the first command that can be found shall be executed.
`boolean`	`oldrunApp(String[] parameters, boolean waitFor, String workingDirOverride)` run/execute application, the first command that can be found shall be executed.
`boolean`	`runApp()`
`boolean`	`runApp(String[] parameters)`
`boolean`	`runApp(String[] parameters, boolean waitFor)`
`boolean`	`runApp(String[] parameters, boolean waitFor, String workingDirOverride)`
`void`	`setBackupURL(String url)`
`void`	`setConfigParam(String sP)`
`void`	`setParam(String sParam)` set parameter to be passed upon application invocation
`String`	`toString()` get Mission Point information
`boolean`	`verifyAndOpenFile(String sFile)` verify the content type of the file before trying to open it e.g. if current ConfigApp object has "image/bmp" and "image/gif" content type, if a file "c:/hello.bmp" is passed in, it returns true and try to invoke the application (stored in _lstCommands)

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

- Constructor Detail
  - ConfigApp
```
public ConfigApp(String sName,
                 String sTooltip,
                 String sImage,
                 String sCommand,
                 String sDefaultParam,
                 String sContentType,
                 boolean bShow)
```
    constructor
    
    Parameters:
    
    sName - name of application
    
    sTooltip - tooltip
    
    sImage - location of image
    
    sCommand - command to be invoked
    
    sDefaultParam - default file parameter to be passed in as a parameter when application is invoked.
    
    sContentType - content type (delimited by commas)
    
    bShow - to determine whether to add to toolbar
  - ConfigApp
```
public ConfigApp(String sName,
                 String sTooltip,
                 String sImage,
                 String sContentType,
                 boolean bShow)
```
    constructor - without specifying command and default parameter
    
    Parameters:
    
    sName - name of application
    
    sTooltip - tootip
    
    sImage - location of image
    
    sContentType - content type (delimited by commas)
    
    bShow - to determine whether to add to toolbar
  - ConfigApp
```
public ConfigApp(String sName,
                 String sTooltip,
                 String sImage,
                 String sContentType,
                 boolean bShow,
                 String workingDir)
```
    Parameters:
    
    sName -
    
    sTooltip -
    
    sImage -
    
    sContentType -
    
    bShow -
    
    workingDir -
- Method Detail
  - addCommand
```
public void addCommand(String sCommand)
```
    add a command to the list
    
    Parameters:
    
    sCommand - command to be added
  - olderrunApp
```
public boolean olderrunApp()
```
    run/execute application, the first command that can be found shall be executed.
    
    Returns:
    
    true if successfully executed, otherwise false
  - runApp
```
public boolean runApp()
```
    Returns:
    
    success or failure
  - runApp
```
public boolean runApp(String[] parameters)
```
    Parameters:
    
    parameters - list of parameter string values to be appended to executable, e.g. a file path/name
    
    Returns:
    
    success or failure
  - runApp
```
public boolean runApp(String[] parameters,
                      boolean waitFor)
```
    Parameters:
    
    parameters - list of parameter string values to be appended to executable, e.g. a file path/name
    
    waitFor -
    
    Returns:
    
    success or failure
  - oldrunApp
```
public boolean oldrunApp(String[] parameters,
                         boolean waitFor,
                         String workingDirOverride)
```
    run/execute application, the first command that can be found shall be executed.
    
    Parameters:
    
    parameters - list of parameter string values to be appended to executable, e.g. a file path/name
    
    waitFor -
    
    workingDirOverride -
    
    Returns:
    
    true if successfully executed, otherwise false
  - runApp
```
public boolean runApp(String[] parameters,
                      boolean waitFor,
                      String workingDirOverride)
```
    Parameters:
    
    parameters - list of parameter string values to be appended to executable, e.g. a file path/name
    
    waitFor -
    
    workingDirOverride -
    
    Returns:
    
    success or failure
  - verifyAndOpenFile
```
public boolean verifyAndOpenFile(String sFile)
```
    verify the content type of the file before trying to open it e.g. if current ConfigApp object has "image/bmp" and "image/gif" content type, if a file "c:/hello.bmp" is passed in, it returns true and try to invoke the application (stored in _lstCommands)
    
    Parameters:
    
    sFile - file to be opened
    
    Returns:
    
    true if successfully open, otherwise false
  - toString
```
public String toString()
```
    get Mission Point information
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String value
  - getBackupURL
```
public String getBackupURL()
```
    Returns:
    
    string for backup url
  - getImagePath
```
public String getImagePath()
```
    Returns:
    
    image path
  - getName
```
public String getName()
```
    Returns:
    
    name of app: text to be displayed in JList toolbar
  - getShow
```
public boolean getShow()
```
    Returns:
    
    whether to display or not, mainly for adding a button to the toolbar
  - getTooltip
```
public String getTooltip()
```
    Returns:
    
    text to be displayed in tooltip
  - setBackupURL
```
public void setBackupURL(String url)
```
    Parameters:
    
    url - string for backup url
  - setParam
```
public void setParam(String sParam)
```
    set parameter to be passed upon application invocation
    
    Parameters:
    
    sParam -
  - setConfigParam
```
public void setConfigParam(String sP)
```
    Parameters:
    
    sP -

Class ConfigApp

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConfigApp

ConfigApp

ConfigApp

Method Detail

addCommand

olderrunApp

runApp

runApp

runApp

oldrunApp

runApp

verifyAndOpenFile

toString

getBackupURL

getImagePath

getName

getShow

getTooltip

setBackupURL

setParam

setConfigParam