marytts.tools.install

Class ComponentDescription

java.lang.Object

java.util.Observable

marytts.tools.install.ComponentDescription

All Implemented Interfaces:

Comparable<ComponentDescription>

Direct Known Subclasses:

LanguageComponentDescription, VoiceComponentDescription

public class ComponentDescription
extends Observable
implements Comparable<ComponentDescription>

Author:

marc

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ComponentDescription.Status

Field Summary

Fields

Modifier and Type	Field and Description
static String	installerNamespaceURI

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ComponentDescription(Element xmlDescription)
protected	ComponentDescription(String name, String version, String packageFilename)

Method Summary

Methods

Modifier and Type	Method and Description
void	addLocation(URL aLocation)
void	cancel()
int	compareTo(ComponentDescription o) Define a natural ordering for component descriptions.
static void	copyInputStream(InputStream in, OutputStream out)
Document	createComponentXML()
void	download(boolean synchronous)
boolean	equals(Object obj)
ComponentDescription	getAvailableUpdate() If this component has an available update, get that update.
String	getComponentTypeString()
String	getDescription()
String	getDisplayPackageSize()
LinkedList<String>	getInstalledFileNames()
URL	getLicenseURL()
Locale	getLocale()
List<URL>	getLocations()
String	getName()
String	getPackageFilename()
String	getPackageMD5Sum()
int	getPackageSize()
int	getProgress()
ComponentDescription.Status	getStatus()
String	getVersion()
void	install(boolean synchronous) Install this component, if the user accepts the license.
boolean	isSelected()
boolean	isUpdateAvailable() Inform whether an update is available for this component.
boolean	isUpdateOf(ComponentDescription other) This is an update of other if and only if the following is true: Both components have the same type (as identified by the class) and name; other has status INSTALLED; our version number is higher than other's version number.
static boolean	isVersionNewerThan(String oneVersion, String otherVersion) Determine whether oneVersion is newer than otherVersion.
void	pause()
void	removeAllLocations()
void	replaceWithUpdate() Replace this component definition with its available update.
void	resume(boolean synchronous)
void	setAvailableUpdate(ComponentDescription aDesc) Set the given component description as the available update of this component.
void	setDescription(String aDescription)
void	setLicenseURL(URL aLicense)
void	setLocale(Locale aLocale)
void	setPackageFilename(String aPackageFilename)
void	setPackageMD5Sum(String aMD5)
void	setPackageSize(int aSize)
void	setSelected(boolean value)
void	setSharedFiles(Set<String> fileList)
void	setVersion(String aVersion)
String	toString()
boolean	uninstall() Uninstall this component.

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Field Detail

installerNamespaceURI

public static final String installerNamespaceURI

See Also:

Constant Field Values

Constructor Detail

ComponentDescription

protected ComponentDescription(String name,
                    String version,
                    String packageFilename)

ComponentDescription

protected ComponentDescription(Element xmlDescription)
                        throws NullPointerException

Throws:

NullPointerException

Method Detail

replaceWithUpdate

public void replaceWithUpdate()

Replace this component definition with its available update. The object will stay the same but all data will be overwritten with the content of the update. After this method returns, isUpdateAvailable() will return false.

getComponentTypeString

public String getComponentTypeString()

getName

public String getName()

getLocale

public Locale getLocale()

setLocale

public void setLocale(Locale aLocale)

getVersion

public String getVersion()

setVersion

public void setVersion(String aVersion)

getDescription

public String getDescription()

setDescription

public void setDescription(String aDescription)

getLicenseURL

public URL getLicenseURL()

setLicenseURL

public void setLicenseURL(URL aLicense)

getLocations

public List<URL> getLocations()

removeAllLocations

public void removeAllLocations()

addLocation

public void addLocation(URL aLocation)

getPackageFilename

public String getPackageFilename()

setPackageFilename

public void setPackageFilename(String aPackageFilename)

getPackageSize

public int getPackageSize()

setPackageSize

public void setPackageSize(int aSize)

getDisplayPackageSize

public String getDisplayPackageSize()

getPackageMD5Sum

public String getPackageMD5Sum()

setPackageMD5Sum

public void setPackageMD5Sum(String aMD5)

isSelected

public boolean isSelected()

setSelected

public void setSelected(boolean value)

getStatus

public ComponentDescription.Status getStatus()

getInstalledFileNames

public LinkedList<String> getInstalledFileNames()

setSharedFiles

public void setSharedFiles(Set<String> fileList)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

pause

public void pause()

resume

public void resume(boolean synchronous)

cancel

public void cancel()

download

public void download(boolean synchronous)

install

public void install(boolean synchronous)
             throws Exception

Install this component, if the user accepts the license.

Parameters:

synchronous - synchronous

Throws:

Exception - Exception

uninstall

public boolean uninstall()

Uninstall this component.

Returns:

true if component was successfully uninstalled, false otherwise.

getProgress

public int getProgress()

createComponentXML

public Document createComponentXML()
                            throws ParserConfigurationException

Throws:

ParserConfigurationException

isUpdateAvailable

public boolean isUpdateAvailable()

Inform whether an update is available for this component.

Returns:

availableUpdate != null

getAvailableUpdate

public ComponentDescription getAvailableUpdate()

If this component has an available update, get that update.

Returns:

null if no update is available.

setAvailableUpdate

public void setAvailableUpdate(ComponentDescription aDesc)

Set the given component description as the available update of this component. If we already have an available update, then aDesc is only retained as the available update if it has a higher version number than the previously set update.

Parameters:

aDesc - an available update, or null to erase any previously set available updates.

Throws:

IllegalStateException - if aDesc is not null and our status is not "INSTALLED".

IllegalArgumentException - if aDesc is not null and our name is not the same as aDesc's name, or if our version number is not smaller than aDesc's version number.

isUpdateOf

public boolean isUpdateOf(ComponentDescription other)

This is an update of other if and only if the following is true:

1. Both components have the same type (as identified by the class) and name;
2. other has status INSTALLED;
3. our version number is higher than other's version number.

Parameters:

other - other

Returns:

false if other == null or !this.getClass.equals(other.getClass) or !name.equals(other.getName) or other.getStatus or != Status.INSTALLED or !(isVersionNewerThan(version, other.getVersion), otherwise true

isVersionNewerThan

public static boolean isVersionNewerThan(String oneVersion,
                         String otherVersion)

Determine whether oneVersion is newer than otherVersion. This performs a lexicographic comparison with the exception that a version with suffix "-SNAPSHOT" is treated as older than the version without that suffix. A version is not newer than itself.

Parameters:

oneVersion - oneVersion

otherVersion - otherVersion

Returns:

true if oneVersion is newer than otherVersion, false if they are equal or otherVersion is newer.

compareTo

public int compareTo(ComponentDescription o)

Define a natural ordering for component descriptions. Languages first, in alphabetic order, then voices, in alphabetic order.

Specified by:

compareTo in interface Comparable<ComponentDescription>

Parameters:

o - o

copyInputStream

public static final void copyInputStream(InputStream in,
                   OutputStream out)
                                  throws IOException

Throws:

IOException