com.lf.commons.dialog

Class ReleaseNotes

java.lang.Object

com.lf.commons.web.msg.XMLMessage

com.lf.commons.dialog.ReleaseNotes

All Implemented Interfaces:

AbstractMessage

public class ReleaseNotes
extends XMLMessage

Represents a license message in XML format based on 'release_notes.dtd'.

Can be used to transport release notes for Leisenfels applications.

Since:

1.6

Version:

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

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHANGE_TYPE_BUGFIX Some static change type from the DTD.
static java.lang.String	CHANGE_TYPE_ENHANCEMENT Some static change type from the DTD.
static java.lang.String	CHANGE_TYPE_MISC Some static change type from the DTD.
static java.lang.String	CHANGE_TYPE_NEW Some static change type from the DTD.
static java.lang.String	CHANGE_TYPE_SECURITY Some static change type from the DTD.
static java.lang.String	RELEASE_NOTES_DOCNAME The name of the root element.
static java.lang.String	RELEASE_NOTES_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
ReleaseNotes() Constructs an instance based on a given DTD.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Vector<java.lang.String[]>	getCategories() Provides the categories from the release notes file.
java.util.Hashtable<java.lang.String,java.lang.String>	getCategoriesByID() Provides the categories from the release notes files to get the names by ID.
java.util.Vector<java.lang.String[]>	getChangeTypes() Provides the change types (static).
java.util.Hashtable<java.lang.String,java.lang.String>	getChangeTypesByID() Provides the change types (static) to get the names by ID.
java.util.Vector<java.lang.String[]>	getEditions() Provides the editions from the release notes file.
java.util.Hashtable<java.lang.String,java.lang.String>	getEditionsByID() Provides the editions from the release notes files to get the names by ID.
java.util.Vector<java.util.Properties>	getEntries(java.lang.String id, boolean activeonly) Provides the entries for a specific product from the release notes file.
Locale	getLocale() Provides the locale from the release notes file.
java.util.Vector<java.util.Properties>	getProducts() Provides the products from the release notes file.
java.lang.String	replaceIDs(java.lang.String idlist, java.util.Hashtable<java.lang.String,java.lang.String> cache) Replaces the IDs from the list by their associated display names.

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

RELEASE_NOTES_DTD

public static final java.lang.String RELEASE_NOTES_DTD

The underlying DTD.

See Also:

Constant Field Values

RELEASE_NOTES_DOCNAME

public static final java.lang.String RELEASE_NOTES_DOCNAME

The name of the root element.

See Also:

Constant Field Values

CHANGE_TYPE_NEW

public static final java.lang.String CHANGE_TYPE_NEW

Some static change type from the DTD.

See Also:

Constant Field Values

CHANGE_TYPE_ENHANCEMENT

public static final java.lang.String CHANGE_TYPE_ENHANCEMENT

Some static change type from the DTD.

See Also:

Constant Field Values

CHANGE_TYPE_BUGFIX

public static final java.lang.String CHANGE_TYPE_BUGFIX

Some static change type from the DTD.

See Also:

Constant Field Values

CHANGE_TYPE_SECURITY

public static final java.lang.String CHANGE_TYPE_SECURITY

Some static change type from the DTD.

See Also:

Constant Field Values

CHANGE_TYPE_MISC

public static final java.lang.String CHANGE_TYPE_MISC

Some static change type from the DTD.

See Also:

Constant Field Values

Constructor Detail

ReleaseNotes

public ReleaseNotes()

Constructs an instance based on a given DTD.

Since:

1.6

Method Detail

getProducts

public java.util.Vector<java.util.Properties> getProducts()

Provides the products from the release notes file.

The attributes can be acquired from the containers by getProperty("id") etc.

Returns:

Container with products, may be null or empty

Since:

1.6

getEntries

public java.util.Vector<java.util.Properties> getEntries(java.lang.String id,
                                                boolean activeonly)

Provides the entries for a specific product from the release notes file.

The attributes can be acquired from the containers by getProperty("text") etc. The text lines are concatenated with NEWLINE separator to be restored.

Parameters:

id - The product identifier like "digester-1.6.1_3"

activeonly - Provide only active entries?

Returns:

Container with products, may be null or empty

Since:

1.6

getCategories

public java.util.Vector<java.lang.String[]> getCategories()

Provides the categories from the release notes file.

Only the declared categories are provided. If the entries are associated with categories that are not declared by the categories element these are NOT supported!

Returns:

Container with categories, may be null or empty

Since:

1.6

getCategoriesByID

public java.util.Hashtable<java.lang.String,java.lang.String> getCategoriesByID()

Provides the categories from the release notes files to get the names by ID.

Returns:

Container with categories, may be null or empty

Since:

1.6

getEditions

public java.util.Vector<java.lang.String[]> getEditions()

Provides the editions from the release notes file.

Only the declared editions are provided. If the entries are associated with editions that are not declared by the editions element these are NOT supported!

Returns:

Container with products, may be null or empty

Since:

1.6

getEditionsByID

public java.util.Hashtable<java.lang.String,java.lang.String> getEditionsByID()

Provides the editions from the release notes files to get the names by ID.

Returns:

Container with editions, may be null or empty

Since:

1.6

getLocale

public Locale getLocale()

Provides the locale from the release notes file.

Returns:

The locale like "eng_US", may be null

Since:

1.6

replaceIDs

public java.lang.String replaceIDs(java.lang.String idlist,
                          java.util.Hashtable<java.lang.String,java.lang.String> cache)

Replaces the IDs from the list by their associated display names.

Parameters:

idlist - The comma separated list of IDs

cache - The container with IDs (keys) and names (values)

Returns:

The filtered string

Since:

1.6

getChangeTypes

public java.util.Vector<java.lang.String[]> getChangeTypes()

Provides the change types (static).

Returns:

Container with types and descriptions, may be null or empty

Since:

1.6

getChangeTypesByID

public java.util.Hashtable<java.lang.String,java.lang.String> getChangeTypesByID()

Provides the change types (static) to get the names by ID.

Returns:

Container with types and descriptions, may be null or empty

Since:

1.6