ConfigProperties ClassDeltaXML DITA Compare .NET API Documentation
DeltaXML DITA Compare .NET API Documentation
DeltaXML's configuration properties are used to control the behaviour of DeltaXML products.
Inheritance Hierarchy

System Object
    com.deltaxml.dita ConfigProperties

Namespace: com.deltaxml.dita
Assembly: deltaxml-dita (in deltaxml-dita.dll) Version:

public sealed class ConfigProperties : Object

DeltaXML's configuration properties are used to control the behaviour of DeltaXML products. For example, for those products that support OASIS catalogs, they provide a facility to specify where these catalogs are located. Each product will specify the properties that can be configured.

A configuration property is constructed from a triple:

  • name - A string representing the name of the property.
  • value - A string representing the value of the property.
  • fixed - A boolean specifying whether this property can be overridden

A configuration properties object will contain those properties that are specified by an external DeltaXML configuration file ( deltaxmlConfig.xml), which is typically located in the same directory as the product's library (e.g. product.jar file). We refer to this directory as the installation directory for the remainder of this discussion on configuration properties. If the file cannot be found in the installation directory then it is looked for in the user's home directory, and then the current working directory.

It is sometimes useful to be able to specify a property in terms of other properties. For example, it would be possible to specify a property P in terms of a property Q by including the text ${Q} in P's value. Note that Java system properties, such as user.home and user.dir can be referred to in this way (i.e. ${user.home} and ${user.dir} respectively). We also provide an install.dir property, for locating the product's installation directory, when this information is obtainable from the JVM. Some application servers prevent the automatic installation directory detection from working.

A DeltaXML configuration file can specify a search path list to look for additional properties to be set (or overridden - if they have not previously been fixed). Here, the first search path in the list that exists is loaded; all other entries in the search path are ignored. Further, any attempt to reload a previously visited configuration file will finish the configuration file loading process.

See Also