com.lf.commons.model

Class ModelConfig

java.lang.Object

com.lf.commons.web.msg.XMLMessage

com.lf.commons.model.ModelConfig

All Implemented Interfaces:

AbstractMessage

public class ModelConfig
extends XMLMessage

Represents a configuration descriptor in XML format based on 'config.dtd'.

Since:

1.6

Version:

$Revision: 1.7 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MODEL_CONFIG_DOCNAME The name of the root element.
static java.lang.String	MODEL_CONFIG_DTD The underlying DTD.

Fields inherited from class com.lf.commons.web.msg.XMLMessage

docname, document, dtd, encoding, format

Constructor Summary

Constructors

Constructor and Description
ModelConfig() Constructs an instance based on a given DTD.
ModelConfig(DeployProps version, java.util.Vector<java.io.File> resources, java.io.File basedir) Constructs a descriptor instance.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Date	getDate() Provides the export date from the configuration descriptor.
java.lang.String	getProductBuild() Provides the product build from the configuration descriptor.
java.lang.String	getProductID() Provides the product identifier from the configuration descriptor.
java.lang.String	getProductName() Provides the product name from the configuration descriptor.
java.lang.String	getProductVersion() Provides the product version from the configuration descriptor.
java.util.Vector<java.lang.String>	getResources() Provides the resources from the configuration descriptor.

Methods inherited from class com.lf.commons.web.msg.XMLMessage

canProcess, getAttribute, getAttributeValue, getContents, getDocument, getDTD, getElement, getElements, getElementValue, getEncoding, getIntFunctionResult, isArmed, isValid, printDocument, read, read, setEncoding, setFormat, write, write

Methods inherited from class java.lang.Object

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

Field Detail

MODEL_CONFIG_DTD

public static final java.lang.String MODEL_CONFIG_DTD

The underlying DTD.

See Also:

Constant Field Values

MODEL_CONFIG_DOCNAME

public static final java.lang.String MODEL_CONFIG_DOCNAME

The name of the root element.

See Also:

Constant Field Values

Constructor Detail

ModelConfig

public ModelConfig()

Constructs an instance based on a given DTD.

Since:

1.6

ModelConfig

public ModelConfig(DeployProps version,
           java.util.Vector<java.io.File> resources,
           java.io.File basedir)

Constructs a descriptor instance.

The product data is extracted from the given Version object, the date is the current date and time, and the resource map is created from the given set of files and directories relative to the given base directory.

Parameters:

version - The application version infos

resources - The container with resource files

basedir - The directory hosting the configuration

Throws:

java.lang.NullPointerException - If parameters are null

java.lang.IllegalArgumentException - If at least one of the parameters is invalid

Since:

1.6

Method Detail

getProductName

public java.lang.String getProductName()

Provides the product name from the configuration descriptor.

Returns:

Product name, may be null or empty

Since:

1.6

getProductID

public java.lang.String getProductID()

Provides the product identifier from the configuration descriptor.

Returns:

Product identifier, may be null or empty

Since:

1.6

getProductVersion

public java.lang.String getProductVersion()

Provides the product version from the configuration descriptor.

Returns:

Product version, may be null or empty

Since:

1.6

getProductBuild

public java.lang.String getProductBuild()

Provides the product build from the configuration descriptor.

Returns:

Product build, may be null or empty

Since:

1.6

getDate

public java.util.Date getDate()

Provides the export date from the configuration descriptor.

Returns:

Export date, may be null or empty

Since:

1.6

getResources

public java.util.Vector<java.lang.String> getResources()

Provides the resources from the configuration descriptor.

Returns:

Container with resources, may be null or empty

Since:

1.6