org.qedeq.kernel.dto.module
Class HeaderVo

java.lang.Object
  org.qedeq.kernel.dto.module.HeaderVo

All Implemented Interfaces:

Header

public class HeaderVo

extends Object

implements Header

Header of a qedeq file. The header specifies such things as the location of the file, the title and abstract of that module, imports and exports.

Version:

$Revision: 1.7 $

Constructor Summary

HeaderVo()
Constructs a new module header.

Method Summary

boolean	equals(Object obj)
AuthorList	getAuthorList() Get author list.
String	getEmail() Get email address of module administrator.
ImportList	getImportList() Get list of needed modules.
Specification	getSpecification() Get module specification.
LatexList	getSummary() Get module summary.
LatexList	getTitle() Get module title.
UsedByList	getUsedByList() Get list of modules, that use this module.
int	hashCode()
void	setAuthorList(AuthorListVo authors) Set list of authors of this module.
void	setEmail(String email) Set email address of module administrator.
void	setImportList(ImportListVo imports) Set list of imports needed for this module.
void	setSpecification(SpecificationVo specification) Set module specification.
void	setSummary(LatexListVo summary) Set module summary text.
void	setTitle(LatexListVo title) Set module title.
void	setUsedByList(UsedByListVo usedby) Set list of known modules that need this module.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderVo

public HeaderVo()

Constructs a new module header.

Method Detail

setSpecification

public final void setSpecification(SpecificationVo specification)

Set module specification.

Parameters:

specification - Module specification.

getSpecification

public final Specification getSpecification()

Description copied from interface: Header

Get module specification.

Specified by:

getSpecification in interface Header

Returns:

Module specification.

setTitle

public final void setTitle(LatexListVo title)

Set module title.

Parameters:

title - Module title texts.

getTitle

public final LatexList getTitle()

Description copied from interface: Header

Get module title.

Specified by:

getTitle in interface Header

Returns:

Module title.

setSummary

public final void setSummary(LatexListVo summary)

Set module summary text.

Parameters:

summary - Module summary text.

getSummary

public final LatexList getSummary()

Description copied from interface: Header

Get module summary.

Specified by:

getSummary in interface Header

Returns:

Module abstract.

setAuthorList

public final void setAuthorList(AuthorListVo authors)

Set list of authors of this module.

Parameters:

authors - Author list.

getAuthorList

public final AuthorList getAuthorList()

Description copied from interface: Header

Get author list.

Specified by:

getAuthorList in interface Header

Returns:

Module author list.

setImportList

public final void setImportList(ImportListVo imports)

Set list of imports needed for this module.

Parameters:

imports - Module import list.

getImportList

public final ImportList getImportList()

Description copied from interface: Header

Get list of needed modules.

Specified by:

getImportList in interface Header

Returns:

Import list.

setUsedByList

public final void setUsedByList(UsedByListVo usedby)

Set list of known modules that need this module.

Parameters:

usedby - List of modules.

getUsedByList

public final UsedByList getUsedByList()

Description copied from interface: Header

Get list of modules, that use this module.

Specified by:

getUsedByList in interface Header

Returns:

Used by list.

setEmail

public final void setEmail(String email)

Set email address of module administrator.

Parameters:

email - Email address.

getEmail

public final String getEmail()

Description copied from interface: Header

Get email address of module administrator.

Specified by:

getEmail in interface Header

Returns:

Email address of module administrator.

equals

public boolean equals(Object obj)

hashCode

public int hashCode()

toString

public String toString()