pt.lsts.neptus.util.conf

Class ConfigFetch

java.lang.Object

pt.lsts.neptus.util.conf.ConfigFetch

public class ConfigFetch
extends java.lang.Object

Version:

1.3.9 10/2006

Author:

Paulo Dias

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigFetch.ENVIROMENT

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	baseJarFileDir
java.io.BufferedWriter	bw
java.io.BufferedWriter	bwhale
protected static java.lang.String	className
protected static java.lang.String	classPackage
protected static org.dom4j.Document	confDoc
protected static java.lang.String	configFile
static java.lang.String	DS
static ConfigFetch.ENVIROMENT	ENV
protected static boolean	ifLogger
static ConfigFetch	INSTANCE
protected static java.util.Hashtable<java.lang.String,java.lang.String>	listOfSchemas
protected static java.util.Hashtable<java.lang.String,java.lang.String>	listOfSchemasPaths
static long	mark
protected static java.lang.String	neptusTmpDir
static short	OS_ERROR
static short	OS_LINUX
static short	OS_OTHER
static short	OS_WINDOWS
protected static java.lang.String[]	parentPaths
protected static boolean	schemasInTempFile
static long	STARTTIME
protected static java.awt.Component	superParentFrame
static java.util.Map<java.lang.String,java.lang.Long>	timings

Method Summary

Methods

Modifier and Type	Method and Description
static void	benchmark(java.lang.String tag)
static java.lang.String	getActionMapSchemaLocation()
static java.lang.String	getAttributeTextByXPath(java.lang.String xpath2Attribute, org.dom4j.Document doDocument)
static java.lang.String	getChecklistSchemaLocation()
static java.lang.String	getCompilationDate()
static java.lang.String	getConfigFile()
static java.lang.String	getConsoleSchemaLocation()
static java.lang.String	getCoordinateSystemSchemaLocation()
static java.lang.String	getCoordinateSystemsConfigLocation()
static NeptusProperty.DistributionEnum	getDistributionType()
static java.lang.String	getElementTextByXPath(java.lang.String xpath2Element, org.dom4j.Document doDocument)
static java.util.List<java.awt.Image>	getIconImagesForFrames()
static java.lang.String	getLoggingPropertiesLocation() returns the central properties file for log4j Loggers.
static java.lang.String	getLoggingPropertiesType() returns the central properties file type for log4j Loggers.
static java.lang.String	getMapSchemaLocation()
static java.lang.String	getMiscSystemsConfigLocation()
static java.lang.String	getMiscSystemsSchemaLocation()
static java.lang.String	getMissionSchemaLocation()
static long	getNeptusInitializationTime()
static java.lang.String	getNeptusTmpDir()
static java.lang.String	getNeptusVersion()
static short	getOS()
static java.lang.String	getSaveAsCommentForXML()
static java.lang.String	getScmRev()
static java.awt.Frame	getSuperParentAsFrame()
static java.awt.Component	getSuperParentFrame()
static java.lang.String	getVehicleSchemaLocation()
static java.util.LinkedList<java.lang.String>	getVehiclesList()
static java.lang.String	getVersionExtendedInfoSimpleString()
static java.util.Properties	getVersionInfoAsProperties()
static java.lang.String	getVersionInfoAsString()
static java.lang.String	getVersionSimpleString()
static boolean	initialize()
static boolean	initialize(boolean ifLog)
static boolean	initialize(java.lang.String configFile)
static boolean	initialize(java.lang.String configFile, boolean ifLog)
static boolean	isOnLockedMode()
static boolean	isOSEqual(short os)
boolean	load() Loads the configuration file.
boolean	load(java.lang.String configFile) Loads the configuration file.
static void	main(java.lang.String[] args)
static void	mark(java.lang.String tag)
protected org.dom4j.Document	readConfigFile(java.lang.String configFile)
static java.lang.String	resolvePath(java.lang.String path) Tries to resolve a relative path.
static java.lang.String	resolvePathBasedOnConfigFile(java.lang.String filePath) Resolves a path based on a parent or the original path if it's already absolute.
static java.lang.String	resolvePathWithParent(java.lang.String parentPath, java.lang.String filePath) Resolves a path based on a parent or the original path if it's alredy absolute.
static boolean	setDistributionType(NeptusProperty.DistributionEnum dist)
boolean	setFile(java.lang.String configFile) This method set's a new file name.
static void	setOnLockedMode(boolean onLockedMode)
static void	setSuperParentFrame(java.awt.Component superParentFrame)
static void	setSuperParentFrameForced(java.awt.Component superParentFrame)

Methods inherited from class java.lang.Object

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

Field Detail

OS_ERROR

public static final short OS_ERROR

See Also:

Constant Field Values

OS_WINDOWS

public static final short OS_WINDOWS

See Also:

Constant Field Values

OS_LINUX

public static final short OS_LINUX

See Also:

Constant Field Values

OS_OTHER

public static final short OS_OTHER

See Also:

Constant Field Values

DS

public static final java.lang.String DS

STARTTIME

public static final long STARTTIME

mark

public static long mark

timings

public static java.util.Map<java.lang.String,java.lang.Long> timings

schemasInTempFile

protected static boolean schemasInTempFile

listOfSchemas

protected static final java.util.Hashtable<java.lang.String,java.lang.String> listOfSchemas

listOfSchemasPaths

protected static final java.util.Hashtable<java.lang.String,java.lang.String> listOfSchemasPaths

ENV

public static ConfigFetch.ENVIROMENT ENV

classPackage

protected static final java.lang.String classPackage

See Also:

Constant Field Values

className

protected static final java.lang.String className

See Also:

Constant Field Values

confDoc

protected static org.dom4j.Document confDoc

configFile

protected static java.lang.String configFile

baseJarFileDir

protected static java.lang.String baseJarFileDir

ifLogger

protected static boolean ifLogger

neptusTmpDir

protected static final java.lang.String neptusTmpDir

parentPaths

protected static java.lang.String[] parentPaths

superParentFrame

protected static java.awt.Component superParentFrame

bw

public java.io.BufferedWriter bw

bwhale

public java.io.BufferedWriter bwhale

INSTANCE

public static ConfigFetch INSTANCE

Method Detail

initialize

public static boolean initialize()

Returns:

See Also:

ConfigFetch()

initialize

public static boolean initialize(java.lang.String configFile,
                 boolean ifLog)

Returns:

See Also:

ConfigFetch(String, boolean)

initialize

public static boolean initialize(boolean ifLog)

Returns:

See Also:

ConfigFetch(boolean)

initialize

public static boolean initialize(java.lang.String configFile)

Returns:

See Also:

ConfigFetch(String)

setFile

public boolean setFile(java.lang.String configFile)

This method set's a new file name. IMPORTANT: It doesn't load it. To load you have to call load(String).

Parameters:

configFile - Configuration file name

Returns:

load

public boolean load(java.lang.String configFile)

Loads the configuration file. Also configures the log4j.

Parameters:

configFile - Configuration file name

Returns:

true if successful

load

public boolean load()

Loads the configuration file. Also configures the log4j.

Returns:

true if successful

resolvePath

public static java.lang.String resolvePath(java.lang.String path)

Tries to resolve a relative path. The searches are done in: <ul> <li>If it's absolute returns the same path.</li> <li>Looks in the path given by init().</li> <li>Looks in one level down from the path given by init() .</li> <li>Looks in the path given by init() + "../classes".</li> <li>Looks in the path given by init() + "../config".</li> <li>Looks in the path given by init() + "../files".</li> <li>Looks in the path given by init() + "../images".</li> <li>Looks in two level down from the path given by init().</li> </ul>

Parameters:

path - Relative path to resolve.

Returns:

true if successful

Since:

v1.3.5 is static

resolvePathWithParent

public static java.lang.String resolvePathWithParent(java.lang.String parentPath,
                                     java.lang.String filePath)

Resolves a path based on a parent or the original path if it's alredy absolute.
The file may not exist! The parentPath is suposed to exist.
It returns always the absolute path.

Parameters:

parentPath -

filePath -

Returns:

resolvePathBasedOnConfigFile

public static java.lang.String resolvePathBasedOnConfigFile(java.lang.String filePath)

Resolves a path based on a parent or the original path if it's already absolute. The parent used here is the getConfigFile()

Parameters:

filePath -

Returns:

See Also:

#resolvePathWithParent(String, String)}

getConfigFile

public static java.lang.String getConfigFile()

Returns:

Returns the configFile path.

getElementTextByXPath

public static java.lang.String getElementTextByXPath(java.lang.String xpath2Element,
                                     org.dom4j.Document doDocument)

Parameters:

xpath2Element -

doDocument -

Returns:

getAttributeTextByXPath

public static java.lang.String getAttributeTextByXPath(java.lang.String xpath2Attribute,
                                       org.dom4j.Document doDocument)

Parameters:

xpath2Attribute -

doDocument -

Returns:

readConfigFile

protected org.dom4j.Document readConfigFile(java.lang.String configFile)

Parameters:

ConfigFile -

Returns:

getLoggingPropertiesLocation

public static java.lang.String getLoggingPropertiesLocation()

returns the central properties file for log4j Loggers. This file is expected to be xml or properties depending on the attribute "type". //log-conf-file

Returns:

getLoggingPropertiesType

public static java.lang.String getLoggingPropertiesType()

returns the central properties file type for log4j Loggers. This file type is expected to be "xml" or "properties". //log-conf-file/@type

Returns:

getCoordinateSystemsConfigLocation

public static java.lang.String getCoordinateSystemsConfigLocation()

Returns:

getMiscSystemsConfigLocation

public static java.lang.String getMiscSystemsConfigLocation()

Returns:

getVehiclesList

public static java.util.LinkedList<java.lang.String> getVehiclesList()

Returns:

getMissionSchemaLocation

public static java.lang.String getMissionSchemaLocation()

Returns:

getVehicleSchemaLocation

public static java.lang.String getVehicleSchemaLocation()

Returns:

getMapSchemaLocation

public static java.lang.String getMapSchemaLocation()

Returns:

getCoordinateSystemSchemaLocation

public static java.lang.String getCoordinateSystemSchemaLocation()

Returns:

getChecklistSchemaLocation

public static java.lang.String getChecklistSchemaLocation()

Returns:

getMiscSystemsSchemaLocation

public static java.lang.String getMiscSystemsSchemaLocation()

Returns:

getConsoleSchemaLocation

public static java.lang.String getConsoleSchemaLocation()

Returns:

getActionMapSchemaLocation

public static java.lang.String getActionMapSchemaLocation()

Returns:

getVersionInfoAsProperties

public static java.util.Properties getVersionInfoAsProperties()

Returns:

getVersionSimpleString

public static java.lang.String getVersionSimpleString()

getVersionInfoAsString

public static java.lang.String getVersionInfoAsString()

Returns:

getVersionExtendedInfoSimpleString

public static java.lang.String getVersionExtendedInfoSimpleString()

getSaveAsCommentForXML

public static java.lang.String getSaveAsCommentForXML()

Returns:

getSuperParentFrame

public static java.awt.Component getSuperParentFrame()

Returns:

Returns the superParentFrame.

getSuperParentAsFrame

public static java.awt.Frame getSuperParentAsFrame()

Returns:

Returns the superParentFrame.

setSuperParentFrame

public static void setSuperParentFrame(java.awt.Component superParentFrame)

Parameters:

superParentFrame - The superParentFrame to set.

setSuperParentFrameForced

public static void setSuperParentFrameForced(java.awt.Component superParentFrame)

Parameters:

superParentFrame - The superParentFrame to set.

getOS

public static short getOS()

Returns:

The short corresponding to the OS found.

isOSEqual

public static boolean isOSEqual(short os)

Parameters:

os - The shor representing the OS to test.

Returns:

The result of the test.

getNeptusVersion

public static java.lang.String getNeptusVersion()

Returns:

The Neptus version.

getCompilationDate

public static java.lang.String getCompilationDate()

Returns:

The compilation date.

getScmRev

public static java.lang.String getScmRev()

getNeptusInitializationTime

public static long getNeptusInitializationTime()

getNeptusTmpDir

public static java.lang.String getNeptusTmpDir()

isOnLockedMode

public static boolean isOnLockedMode()

setOnLockedMode

public static void setOnLockedMode(boolean onLockedMode)

getIconImagesForFrames

public static java.util.List<java.awt.Image> getIconImagesForFrames()

Returns:

mark

public static void mark(java.lang.String tag)

benchmark

public static void benchmark(java.lang.String tag)

getDistributionType

public static NeptusProperty.DistributionEnum getDistributionType()

Returns:

the distributionType

setDistributionType

public static boolean setDistributionType(NeptusProperty.DistributionEnum dist)

Parameters:

dist -

Returns:

true if the change happen or not.

main

public static void main(java.lang.String[] args)

Parameters:

args -