Class ContextBase

java.lang.Object

org.ampere.base.util.ContextBase

All Implemented Interfaces:

ContextDefinition, PACTEdef

public class ContextBase
extends Object
implements PACTEdef, ContextDefinition

Configuration and environnement management

Author:

hmorel

Field Summary

Fields

Modifier and Type	Field	Description
static final int	SYSTEM_LINUX
static final int	SYSTEM_WINDOWS

Fields inherited from interface org.ampere.base.util.ContextDefinition

ALL_RESOURCE, CONFIG_DIR, DBX, DEBUG_FEATURES, EMBEDDED_RESOURCE, ERROR, EXAMPLE_DIR, LOCAL_RESOURCE, PACTE_HOME, PHYSICS, PHYSICS_DTD, PXD_DTD, RSCR_COLOR_CSS, RSRC_PHYSICS, RSRC_PHYSICS_XML, SELFDOC_DTD, SYNTAX, SYSTEM_RESOURCE, TEST_DATA, TEXT_EXTEND

Fields inherited from interface org.ampere.base.util.PACTEdef

AMBIGUOUS, DOUBLE_TAG, FREQUENCY_NAME, FREQUENCY_TAG, TIME_NAME, TIME_TAG, UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ContextBase()

Method Summary

Modifier and Type	Method	Description
String	getConfigType(boolean system)
static File	getDataDirectory()
static File	getDataUserDir()
static PrintWriter	getDefaultOutput()
static File	getExampleDirectory()
static InputSource	getInputSource(int res)
File	getLibDir()
static String	getOSname(int osCode)
File	getPacteHome()	PACTE HOME directory is the installation directory that containts data directory.
File	getPacteTest()	PACTE TEST directory is the local directory that containts test, examples and test data directories.
static File	getResource(int res)
static ContextBase	getSingleton()
File	getSystemPactePropertyFile()
static File	getTestDataDirectory()
static File	getUserDir()
boolean	isConfigurated()
boolean	isLocalConfigurated(boolean validated)
boolean	isSystemConfigurated(boolean validated)
void	logMessage(String message)
static boolean	matchRelativePath(String relative, String absolute)	test if a relative path matches an absolute one
static void	register(String feature, String classPath, String function)	Register a feature use in a given method
static void	setDefaultOutput(PrintWriter out)
void	setLocalPacteTest(File ptest)
void	startLog()
static void	verifyConfig()	Verify the PACTE configuration

Methods inherited from class java.lang.Object

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

Field Details

SYSTEM_LINUX

public static final int SYSTEM_LINUX

See Also:

• Constant Field Values

SYSTEM_WINDOWS

public static final int SYSTEM_WINDOWS

See Also:

• Constant Field Values

Constructor Details

ContextBase

protected ContextBase()

Method Details

getSingleton

public static ContextBase getSingleton()

setDefaultOutput

public static void setDefaultOutput(PrintWriter out)

getDefaultOutput

public static PrintWriter getDefaultOutput()

isSystemConfigurated

public boolean isSystemConfigurated(boolean validated)

isLocalConfigurated

public boolean isLocalConfigurated(boolean validated)

isConfigurated

public boolean isConfigurated()

setLocalPacteTest

public void setLocalPacteTest(File ptest)

getSystemPactePropertyFile

public File getSystemPactePropertyFile()

getDataDirectory

public static File getDataDirectory()

getExampleDirectory

public static File getExampleDirectory()

getPacteHome

public File getPacteHome()

PACTE HOME directory is the installation directory that containts data directory.

Returns:

the PACTE home directory

getPacteTest

public File getPacteTest()

PACTE TEST directory is the local directory that containts test, examples and test data directories.

Returns:

the PACTE test directory

getLibDir

public File getLibDir()

Returns:

the local library directory.

getResource

public static File getResource(int res)

getInputSource

public static InputSource getInputSource(int res)

getOSname

public static String getOSname(int osCode)

getConfigType

public String getConfigType(boolean system)

getUserDir

public static File getUserDir()

Returns:

the current user directory

getDataUserDir

public static File getDataUserDir()

Returns:

the masked PACTEdef directory in the user directory

matchRelativePath

public static boolean matchRelativePath(String relative,
 String absolute)

test if a relative path matches an absolute one

Parameters:

relative - relative input path

absolute - absolute input path

Returns:

true if both pathes match

getTestDataDirectory

public static File getTestDataDirectory()

Returns:

the test data directory, for debugging purpose

register

public static void register(String feature,
 String classPath,
 String function)

Register a feature use in a given method

Parameters:

feature - considered feature

classPath - associated class path

function - associated function

startLog

public void startLog()

logMessage

public void logMessage(String message)

verifyConfig

public static void verifyConfig()

Verify the PACTE configuration