org.autosemantix.deltalog
Class DeltaLog

java.lang.Object
  org.autosemantix.deltalog.DeltaLog

public class DeltaLog

extends java.lang.Object

This class represents the change log for a given project. Each project can have many releases each with its own version tag and a set of changes that have been made in that release.

Version:

Created on Sep 1, 2005

Author:

Shawn Simister

Constructor Summary

DeltaLog(java.lang.String projectName)

Method Summary

void	addRelease(Release release) Add a release to the project.
java.lang.String	getProjectName() Get the name of the current project.
Release	getRelease(java.lang.String version) Search for a specific release based on a version name.
java.util.List	getReleases() Get the list of releases.
void	load(java.lang.String filename) Load a log from an XML file.
void	save(java.lang.String filename) Save the log as XML.
void	saveHTML(java.lang.String filename) Save a formatted HTML summary of this change log.
void	setProjectName(java.lang.String projectName) Set the name of the current project.
java.lang.String	toXML() Convert a log to it's serialized XML equivalent.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeltaLog

public DeltaLog(java.lang.String projectName)

Method Detail

getReleases

public java.util.List getReleases()

Get the list of releases.

Returns:

A list of releases for this project.

addRelease

public void addRelease(Release release)

Add a release to the project.

Parameters:

release - A new release.

getRelease

public Release getRelease(java.lang.String version)

Search for a specific release based on a version name.

Parameters:

version - The version to look for.

Returns:

The release if found, otherwise null.

load

public void load(java.lang.String filename)

Load a log from an XML file.

Parameters:

filename - The file to load.

toXML

public java.lang.String toXML()

Convert a log to it's serialized XML equivalent.

Returns:

A string of XML representing the log.

save

public void save(java.lang.String filename)

Save the log as XML.

Parameters:

filename - File to save log to.

saveHTML

public void saveHTML(java.lang.String filename)

Save a formatted HTML summary of this change log.

Parameters:

filename - The .html filename.

getProjectName

public java.lang.String getProjectName()

Get the name of the current project.

Returns:

The name of the project.

setProjectName

public void setProjectName(java.lang.String projectName)

Set the name of the current project.

Parameters:

projectName - The name of the prpject.