Project (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- workbench.main.Project

```
public class Project
extends Object
```
Defines an object with information about and access to the opened project in the AUV Workbench. Uses Apache Commons Configuration to handle all project-specific files, except the project file itself, which is accessed through jdom. An AUVW project is a directory, and is identified by the presence of a project file of a standard name, and subdirectories of standard names. MOVES Institute
Naval Postgraduate School, Monterey, CA
www.nps.edu

Since:

Apr 24, 2007, 3:59:55 PM

Version:

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

Author:

Mike Bailey

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CEVARS_DIR`
`static String`	`CONFIGURATION_DIR`
`static String`	`CONFIGURATION_ELEMENT`
`static String`	`DESCRIPTION_ELEMENT`
`static String`	`EASTING_ELEMENT`
`static String`	`GEO_HANDLE_ELEMENT`
`static String`	`GEO_LAT_ELEMENT`
`static String`	`GEO_LON_ELEMENT`
`static String`	`GEO_SCALE_ELEMENT`
`static String`	`GEO_UNITS_ATTRIBUTE`
`static String`	`GEOLOCATION_ELEMENT`
`static String`	`IMAGES_DIR`
`static String`	`LOCALEIMAGERY_ELEMENT`
`static String`	`MISSIONOFFSET_ELEMENT`
`static String`	`MISSIONS_DIR`
`static String`	`MO_UNITS_ATTRIBUTE`
`static String`	`MO_UNITS_ATTRIBUTE_DEFAULT`
`static String`	`NORTHING_ELEMENT`
`static String`	`OPENMISSION_ELEMENT`
`static String`	`PROJECT_COMMONS_CONFIGURATION_FILENAME` PROJECT_COMMONS_CONFIGURATION_FILENAME is loaded from local project directory CONFIGURATION_DIR, and is not the same as master or template version in AUV Workbench configuration/ subdirectory
`static String`	`PROJECT_FILENAME`
`static String`	`RESULTS_DIR`
`static String`	`X3D_DIR`
`static String`	`X3D_ELEMENT`

Constructor Summary

Constructors
Constructor and Description
`Project(File projectDir, Component mainFrame)` Create a Project instance to represent an existing project
`Project(File projectDir, Component mainFrame, boolean create)` Create a Project instance to represent an existing project

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMission(String missionPath)` Copy a mission file from another location to this project mission directory.
`static File`	`chooseNewProjectPath(Component parent, String startingDirPath)`
`static File`	`chooseProjectDirectory(Component parentComponent, String startingDirPath)` Provide file chooser to select project directory
`void`	`closeProject()`
`void`	`deleteProjectConfiguration()` Used before restoring default configuration files
`protected void`	`doCheckUpdatedConfigurationTemplates()` This will replace the project configuration files with template version configuration files
`String[]`	`getAllMissions()` Just return a list of the missions directory
`File`	`getCevarsDirectory()`
`File`	`getConfigDirectory()`
`String`	`getDescription()`
`String[]`	`getGeoOrigin()`
`File`	`getImagesDirectory()`
`String`	`getLocaleImageryPath()`
`String[]`	`getMissionOffset()`
`File`	`getMissionsDirectory()`
`String[]`	`getOpenMissions()`
`File`	`getProjectDirectory()`
`File`	`getProjectFile()`
`File`	`getResultsDirectory()`
`File`	`getX3dDirectory()`
`static boolean`	`isAuvwProject(File f)` Report if directory f is an AUV Workbench Project
`boolean`	`isMissionOpened(String missionPath)` Indicate a mission is already open
`static File`	`newProjectFromArchive(Component parent, String startingDirPath)`
`static File`	`openArchiveDirectory(Component parent, String startingDirPath)` Returns a pointer to a valid project folder on the local machine for compressing
`void`	`setDescription(String newDescription)`
`void`	`setGeoOrigin(String han, String lat, String lon, String scale, String wrl)`
`void`	`setLocalImageryPath(String path)`
`void`	`setMissionOffset(String north, String east, String units)`
`void`	`setMissionOpened(String missionName, boolean add)` Determines whether an openmission element should be written to the auvwProject.xml file

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

- Field Detail
  - OPENMISSION_ELEMENT
```
public static final String OPENMISSION_ELEMENT
```
    See Also:
    
    Constant Field Values
  - DESCRIPTION_ELEMENT
```
public static final String DESCRIPTION_ELEMENT
```
    See Also:
    
    Constant Field Values
  - X3D_ELEMENT
```
public static final String X3D_ELEMENT
```
    See Also:
    
    Constant Field Values
  - LOCALEIMAGERY_ELEMENT
```
public static final String LOCALEIMAGERY_ELEMENT
```
    See Also:
    
    Constant Field Values
  - CONFIGURATION_ELEMENT
```
public static final String CONFIGURATION_ELEMENT
```
    See Also:
    
    Constant Field Values
  - GEOLOCATION_ELEMENT
```
public static final String GEOLOCATION_ELEMENT
```
    See Also:
    
    Constant Field Values
  - GEO_UNITS_ATTRIBUTE
```
public static final String GEO_UNITS_ATTRIBUTE
```
    See Also:
    
    Constant Field Values
  - GEO_HANDLE_ELEMENT
```
public static final String GEO_HANDLE_ELEMENT
```
    See Also:
    
    Constant Field Values
  - GEO_LAT_ELEMENT
```
public static final String GEO_LAT_ELEMENT
```
    See Also:
    
    Constant Field Values
  - GEO_LON_ELEMENT
```
public static final String GEO_LON_ELEMENT
```
    See Also:
    
    Constant Field Values
  - GEO_SCALE_ELEMENT
```
public static final String GEO_SCALE_ELEMENT
```
    See Also:
    
    Constant Field Values
  - MISSIONOFFSET_ELEMENT
```
public static final String MISSIONOFFSET_ELEMENT
```
    See Also:
    
    Constant Field Values
  - MO_UNITS_ATTRIBUTE
```
public static final String MO_UNITS_ATTRIBUTE
```
    See Also:
    
    Constant Field Values
  - MO_UNITS_ATTRIBUTE_DEFAULT
```
public static final String MO_UNITS_ATTRIBUTE_DEFAULT
```
    See Also:
    
    Constant Field Values
  - NORTHING_ELEMENT
```
public static final String NORTHING_ELEMENT
```
    See Also:
    
    Constant Field Values
  - EASTING_ELEMENT
```
public static final String EASTING_ELEMENT
```
    See Also:
    
    Constant Field Values
  - MISSIONS_DIR
```
public static final String MISSIONS_DIR
```
    See Also:
    
    Constant Field Values
  - X3D_DIR
```
public static final String X3D_DIR
```
    See Also:
    
    Constant Field Values
  - CONFIGURATION_DIR
```
public static final String CONFIGURATION_DIR
```
    See Also:
    
    Constant Field Values
  - RESULTS_DIR
```
public static final String RESULTS_DIR
```
    See Also:
    
    Constant Field Values
  - IMAGES_DIR
```
public static final String IMAGES_DIR
```
    See Also:
    
    Constant Field Values
  - CEVARS_DIR
```
public static final String CEVARS_DIR
```
    See Also:
    
    Constant Field Values
  - PROJECT_FILENAME
```
public static final String PROJECT_FILENAME
```
    See Also:
    
    Constant Field Values
  - PROJECT_COMMONS_CONFIGURATION_FILENAME
```
public static final String PROJECT_COMMONS_CONFIGURATION_FILENAME
```
    PROJECT_COMMONS_CONFIGURATION_FILENAME is loaded from local project directory CONFIGURATION_DIR, and is not the same as master or template version in AUV Workbench configuration/ subdirectory
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Project
```
public Project(File projectDir,
               Component mainFrame)
        throws Exception
```
    Create a Project instance to represent an existing project
    
    Parameters:
    
    projectDir - base directory
    
    mainFrame - the parent UI Frame
    
    Throws:
    
    Exception - if projectDir does not exist or project is missing some pieces
  - Project
```
public Project(File projectDir,
               Component mainFrame,
               boolean create)
        throws Exception
```
    Create a Project instance to represent an existing project
    
    Parameters:
    
    projectDir - base directory
    
    mainFrame - the parent UI Frame
    
    create - if true, no exceptions if project structure incomplete
    
    Throws:
    
    Exception - if create == false and projectDir faulty or projectDir exists and is not a directory
- Method Detail
  - closeProject
```
public void closeProject()
```
  - isAuvwProject
```
public static boolean isAuvwProject(File f)
```
    Report if directory f is an AUV Workbench Project
    
    Parameters:
    
    f - the project directory to test
    
    Returns:
    
    true when an auvwProject.xml file is found in tested directory, which is different than auv/AuvWorkbench/configuration
  - getProjectDirectory
```
public File getProjectDirectory()
```
  - getMissionsDirectory
```
public File getMissionsDirectory()
```
  - getImagesDirectory
```
public File getImagesDirectory()
```
  - getResultsDirectory
```
public File getResultsDirectory()
```
  - getX3dDirectory
```
public File getX3dDirectory()
```
  - getCevarsDirectory
```
public File getCevarsDirectory()
```
  - getConfigDirectory
```
public File getConfigDirectory()
```
  - getProjectFile
```
public File getProjectFile()
```
  - getAllMissions
```
public String[] getAllMissions()
```
    Just return a list of the missions directory
    
    Returns:
    
    array of mission file names
  - getOpenMissions
```
public String[] getOpenMissions()
```
  - isMissionOpened
```
public boolean isMissionOpened(String missionPath)
```
    Indicate a mission is already open
    
    Parameters:
    
    missionPath - the path to the mission
    
    Returns:
    
    an indication that a mission is already open
  - setMissionOpened
```
public void setMissionOpened(String missionName,
                             boolean add)
```
    Determines whether an openmission element should be written to the auvwProject.xml file
    
    Parameters:
    
    missionName - the mission to make a determination on
    
    add - true if addition of an openmission element is desired
  - addMission
```
public void addMission(String missionPath)
```
    Copy a mission file from another location to this project mission directory. NOTE: not currently used, but should during the controller's openMission(File f) function
    
    Parameters:
    
    missionPath - the path of the mission to copy
  - getMissionOffset
```
public String[] getMissionOffset()
```
  - setMissionOffset
```
public void setMissionOffset(String north,
                             String east,
                             String units)
```
  - getGeoOrigin
```
public String[] getGeoOrigin()
```
  - setGeoOrigin
```
public void setGeoOrigin(String han,
                         String lat,
                         String lon,
                         String scale,
                         String wrl)
```
  - setLocalImageryPath
```
public void setLocalImageryPath(String path)
```
  - getLocaleImageryPath
```
public String getLocaleImageryPath()
```
  - doCheckUpdatedConfigurationTemplates
```
protected final void doCheckUpdatedConfigurationTemplates()
```
    This will replace the project configuration files with template version configuration files
  - deleteProjectConfiguration
```
public void deleteProjectConfiguration()
```
    Used before restoring default configuration files
  - chooseNewProjectPath
```
public static File chooseNewProjectPath(Component parent,
                                        String startingDirPath)
```
  - chooseProjectDirectory
```
public static File chooseProjectDirectory(Component parentComponent,
                                          String startingDirPath)
```
    Provide file chooser to select project directory
    
    Parameters:
    
    parentComponent - the component parent for a JOptionPane
    
    startingDirPath - a path to start looking from in dir chooser
    
    Returns:
    
    a path to a chosen project directory
  - newProjectFromArchive
```
public static File newProjectFromArchive(Component parent,
                                         String startingDirPath)
```
    Parameters:
    
    parent - the parent UI for this JFileChooser
    
    startingDirPath - the directory to begin search for .zip archive
    
    Returns:
    
    the selected .zip for creating a new project
  - openArchiveDirectory
```
public static File openArchiveDirectory(Component parent,
                                        String startingDirPath)
```
    Returns a pointer to a valid project folder on the local machine for compressing
    
    Parameters:
    
    parent - the Swing parent component to reference
    
    startingDirPath - the path to the current project directory
    
    Returns:
    
    a File pointer to a valid project folder on the local machine
  - getDescription
```
public String getDescription()
```
    Returns:
    
    the description
  - setDescription
```
public void setDescription(String newDescription)
```
    Parameters:
    
    newDescription - the description to set for this project

Class Project

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OPENMISSION_ELEMENT

DESCRIPTION_ELEMENT

X3D_ELEMENT

LOCALEIMAGERY_ELEMENT

CONFIGURATION_ELEMENT

GEOLOCATION_ELEMENT

GEO_UNITS_ATTRIBUTE

GEO_HANDLE_ELEMENT

GEO_LAT_ELEMENT

GEO_LON_ELEMENT

GEO_SCALE_ELEMENT

MISSIONOFFSET_ELEMENT

MO_UNITS_ATTRIBUTE

MO_UNITS_ATTRIBUTE_DEFAULT

NORTHING_ELEMENT

EASTING_ELEMENT

MISSIONS_DIR

X3D_DIR

CONFIGURATION_DIR

RESULTS_DIR

IMAGES_DIR

CEVARS_DIR

PROJECT_FILENAME

PROJECT_COMMONS_CONFIGURATION_FILENAME

Constructor Detail

Project

Project

Method Detail

closeProject

isAuvwProject

getProjectDirectory

getMissionsDirectory

getImagesDirectory

getResultsDirectory

getX3dDirectory

getCevarsDirectory

getConfigDirectory

getProjectFile

getAllMissions

getOpenMissions

isMissionOpened

setMissionOpened

addMission

getMissionOffset

setMissionOffset

getGeoOrigin

setGeoOrigin

setLocalImageryPath

getLocaleImageryPath

doCheckUpdatedConfigurationTemplates

deleteProjectConfiguration

chooseNewProjectPath

chooseProjectDirectory

newProjectFromArchive

openArchiveDirectory

getDescription

setDescription