sg.edu.nyp.drmPublisher
Class DDFile

java.lang.Object
  sg.edu.nyp.drmPublisher.DDFile

All Implemented Interfaces:

java.io.Serializable

public class DDFile

extends java.lang.Object

implements java.io.Serializable

Author:

Pierre Trocme

See Also:

Serialized Form

Nested Class Summary

class

DDFile.XmlElement

Constructor Summary

DDFile(java.io.File dmFile, java.lang.String contentType)

Method Summary

java.io.File	generateDDFile() Generate the file described by this DDFile object.
java.io.File	generateDDFile(java.lang.String path) Build a .dd file describing the associated .dm file. It is advised to use the more safe generateDDFile() method.
void	setDescription(java.lang.String description) Set the description tag.
void	setIconUrl(java.lang.String iconUrl) Set the iconURL tag.
void	setInfoUrl(java.lang.String infoUrl) Set the infoURL tag.
void	setInstallNotifyURI(java.lang.String inURI) Set the installNotifyURL tag.
void	setInstallParam(java.lang.String installParam) Set the installParam tag
void	setName(java.lang.String name) Set the name tag.
void	setNextUrl(java.lang.String nextURL) Set the nextURL tag.
void	setObjectURI(java.lang.String objectURI) Set the installParam tag.
void	setVendor(java.lang.String vendor) Set the Vendor tag
java.lang.String	toString() Return a String view of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

DDFile

public DDFile(java.io.File dmFile,
              java.lang.String contentType)
       throws java.io.IOException

Method Detail

generateDDFile

public java.io.File generateDDFile(java.lang.String path)
                            throws java.io.IOException

Build a .dd file describing the associated .dm file.
It is advised to use the more safe generateDDFile() method.

Parameters:

path - the directory where will the DM File be created.

Throws:

java.io.IOException - if an I/O Exception occurs

generateDDFile

public java.io.File generateDDFile()
                            throws java.io.IOException

Generate the file described by this DDFile object. The file will be generated in the Execution directory

Throws:

java.io.IOException - if an I/O Exception occurs

toString

public java.lang.String toString()

Return a String view of this object. The string represents exactly the dd file which could result from using the generateDDFile().

setName

public void setName(java.lang.String name)

Set the name tag.

Parameters:

name - the name to set.

setVendor

public void setVendor(java.lang.String vendor)

Set the Vendor tag

Parameters:

vendor - the vendor to set.

setDescription

public void setDescription(java.lang.String description)

Set the description tag.

Parameters:

description - the description to be set.

setInstallNotifyURI

public void setInstallNotifyURI(java.lang.String inURI)

Set the installNotifyURL tag.

Parameters:

inURI - the installNotify string to be set.

setNextUrl

public void setNextUrl(java.lang.String nextURL)

Set the nextURL tag.

Parameters:

nextURL - the nextURL to be set.

setInfoUrl

public void setInfoUrl(java.lang.String infoUrl)

Set the infoURL tag.

Parameters:

infoUrl - the infoURL to be set.

setIconUrl

public void setIconUrl(java.lang.String iconUrl)

Set the iconURL tag.

Parameters:

iconUrl - the iconURL to set.

setInstallParam

public void setInstallParam(java.lang.String installParam)

Set the installParam tag

Parameters:

installParam - the installation parameters to set.

setObjectURI

public void setObjectURI(java.lang.String objectURI)

Set the installParam tag. This method is usefull only if the file publishing location is different from the current location.