com.c5corp.c5utm
Class C5UTMconfs

java.lang.Object
  com.c5corp.c5utm.C5UTMconfs

public class C5UTMconfs
extends java.lang.Object

public class C5UTMconfs C5UTMconfs.java - part of the C5 Landscape database (otherwise known as the C5UTM database). C5UTMconfs.java reads C5UTM preferences from two files: conf/c5utm.conf - datum and units for the data in the db /conf/database.conf The location of these files can be specified using the constructor taking a single String (path) argument. - jdbc stuff and db passwords The results are available via pubic accessor functions This class also validates the configuration to the degree it can.

Since:

1.0

Author:

Brett Stalbaum Copyright 2002-2006 see LICENSE.txt and UCSD_LICENSE.txt

Constructor Summary

C5UTMconfs()
This constructor opens and parses the files and loads the private vars

C5UTMconfs(java.lang.String path)
This constructor opens and parses the files and loads the private vars.

Method Summary

boolean	databaseUnitsConfigured() Returns a boolean, true if the database units are configured.
boolean	databaseWorking() Returns a boolean, true if the configuration file validates and the DB is working.
java.lang.String	getAccessPassword() Returns a java.lang.String containing the configured access password for this C5UTM database installation.
java.lang.String	getBaseUrl() Returns a java.lang.String containing the configured base url for this C5UTM database installation.
java.lang.String	getCorpsconDir() Returns a java.lang.String containing the configured CORPSCON directory for this C5UTM database installation.
java.io.File	getCorpsconDirFile() Returns a java.io.File containing the configured CORPSCON directory for this C5UTM database installation.
java.lang.String	getDbUrl() Returns a java.lang.String containing the configured database url for this C5UTM database installation.
java.lang.String	getDemDir() Returns a java.lang.String containing the configured DEM directory, (the location of dems already processed into the database), for this C5UTM database installation.
java.io.File	getDemDirFile() Returns a java.io.File containing the configured DEM directory, (the location of dems already processed into the database), for this C5UTM database installation.
java.lang.String	getDriver() Returns a java.lang.String containing the configured database driver for this C5UTM database installation.
java.lang.String	getHorizontalDatum() Returns a java.lang.String containing the configured horizontal datum for this C5UTM database installation.
java.lang.String	getHorizontalUnits() Returns a java.lang.String containing the configured horizontal units for this C5UTM database installation.
java.lang.String	getImageCacheDir() Returns a java.lang.String containing the configured web image cache directory for this C5UTM database installation.
java.lang.String	getMessages() Returns a java.lang.String, containing any diagnostic messages related to datbase configuration and validation.
java.lang.String	getNewDemsDir() Returns a java.lang.String containing the configured NEW_DEMS directory, (the location of dems waiting to be processed into the database), for this C5UTM database installation.
java.io.File	getNewDemsDirFile() Returns a java.io.File containing the configured NEW_DEMS directory, (the location of dems waiting to be processed into the database), for this C5UTM database installation.
java.lang.String	getPublicHtml() Returns a java.lang.String containing the configured web directory for this C5UTM database installation.
java.lang.String	getReceiptsDir() Returns a java.lang.String containing the configured RECEIPTS directory for this C5UTM database installation.
java.io.File	getReceiptsDirFile() Returns a java.io.File containing the configured RECEIPTS directory for this C5UTM database installation.
java.lang.String	getUpdatePassword() Returns a java.lang.String containing the configured update password for this C5UTM database installation.
java.lang.String	getUTMImageDir() Returns a java.lang.String containing the configured web image directory for this C5UTM database installation.
java.io.File	getUTMImageDirFile() Returns a java.io.File containing the configured web image directory for this C5UTM database installation.
java.lang.String	getVerticalDatum() Returns a java.lang.String containing the configured vertical datum for this C5UTM database installation.
java.lang.String	getVerticalUnits() Returns a java.lang.String containing the configured vertical units for this C5UTM database installation.
java.lang.String	getWebImageDir() deprecated Returns a java.lang.String containing the configured web image directory for this C5UTM database installation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

C5UTMconfs

public C5UTMconfs()

This constructor opens and parses the files and loads the private vars

C5UTMconfs

public C5UTMconfs(java.lang.String path)

This constructor opens and parses the files and loads the private vars.

Parameters:

path - representing the path to the conf directory and the base instalation must be called with a path to the directory containing the conf files

Method Detail

getVerticalDatum

public java.lang.String getVerticalDatum()

Returns a java.lang.String containing the configured vertical datum for this C5UTM database installation.

Returns:

vertical datum

getHorizontalDatum

public java.lang.String getHorizontalDatum()

Returns a java.lang.String containing the configured horizontal datum for this C5UTM database installation.

Returns:

horizontal datum

getVerticalUnits

public java.lang.String getVerticalUnits()

Returns a java.lang.String containing the configured vertical units for this C5UTM database installation.

Returns:

vertical units

getHorizontalUnits

public java.lang.String getHorizontalUnits()

Returns a java.lang.String containing the configured horizontal units for this C5UTM database installation.

Returns:

horizontal units

getCorpsconDir

public java.lang.String getCorpsconDir()

Returns a java.lang.String containing the configured CORPSCON directory for this C5UTM database installation.

Returns:

the configured corpscon dir

getDemDir

public java.lang.String getDemDir()

Returns a java.lang.String containing the configured DEM directory, (the location of dems already processed into the database), for this C5UTM database installation.

Returns:

configured DEM dir

getReceiptsDir

public java.lang.String getReceiptsDir()

Returns a java.lang.String containing the configured RECEIPTS directory for this C5UTM database installation. (Receipts are database management history info.)

Returns:

the configured receipts dir

getNewDemsDir

public java.lang.String getNewDemsDir()

Returns a java.lang.String containing the configured NEW_DEMS directory, (the location of dems waiting to be processed into the database), for this C5UTM database installation.

Returns:

the configured new dems dir

getPublicHtml

public java.lang.String getPublicHtml()

Returns a java.lang.String containing the configured web directory for this C5UTM database installation. (Receipts are database management history info.)

Returns:

the public html directory

getWebImageDir

public java.lang.String getWebImageDir()

deprecated Returns a java.lang.String containing the configured web image directory for this C5UTM database installation. (Receipts are database management history info.)

Returns:

the web image dir

getUTMImageDir

public java.lang.String getUTMImageDir()

Returns a java.lang.String containing the configured web image directory for this C5UTM database installation. (Receipts are database management history info.)

Returns:

the UTM image dir

getImageCacheDir

public java.lang.String getImageCacheDir()

Returns a java.lang.String containing the configured web image cache directory for this C5UTM database installation. (Receipts are database management history info.)

Returns:

the image cache dir

getCorpsconDirFile

public java.io.File getCorpsconDirFile()

Returns a java.io.File containing the configured CORPSCON directory for this C5UTM database installation.

Returns:

a File representing the Corpscon dir

See Also:

File

getDemDirFile

public java.io.File getDemDirFile()

Returns a java.io.File containing the configured DEM directory, (the location of dems already processed into the database), for this C5UTM database installation.

Returns:

a File representing the DEM dir

getReceiptsDirFile

public java.io.File getReceiptsDirFile()

Returns a java.io.File containing the configured RECEIPTS directory for this C5UTM database installation. (Receipts are database management history info.)

Returns:

a File representing the receipts dir

getNewDemsDirFile

public java.io.File getNewDemsDirFile()

Returns a java.io.File containing the configured NEW_DEMS directory, (the location of dems waiting to be processed into the database), for this C5UTM database installation.

Returns:

a File representing the NEW_DEMS dir

getUTMImageDirFile

public java.io.File getUTMImageDirFile()

Returns a java.io.File containing the configured web image directory for this C5UTM database installation. (Receipts are database management history info.)

Returns:

a file representing the UTM images dir

getBaseUrl

public java.lang.String getBaseUrl()

Returns a java.lang.String containing the configured base url for this C5UTM database installation.

Returns:

the base url for the web interface

getDbUrl

public java.lang.String getDbUrl()

Returns a java.lang.String containing the configured database url for this C5UTM database installation.

Returns:

the database url

See Also:

Connection

getDriver

public java.lang.String getDriver()

Returns a java.lang.String containing the configured database driver for this C5UTM database installation.

Returns:

the database driver

See Also:

Connection

getAccessPassword

public java.lang.String getAccessPassword()

Returns a java.lang.String containing the configured access password for this C5UTM database installation.

Returns:

access password

See Also:

Connection

getUpdatePassword

public java.lang.String getUpdatePassword()

Returns a java.lang.String containing the configured update password for this C5UTM database installation.

Returns:

the the update password

See Also:

Connection

databaseWorking

public boolean databaseWorking()

Returns a boolean, true if the configuration file validates and the DB is working.

Returns:

true if database working

databaseUnitsConfigured

public boolean databaseUnitsConfigured()

Returns a boolean, true if the database units are configured.

Returns:

true if the database is working

getMessages

public java.lang.String getMessages()

Returns a java.lang.String, containing any diagnostic messages related to datbase configuration and validation.

Returns:

diagnostic messages