jwo.landserf.structure
Class Header

java.lang.Object
  jwo.landserf.structure.Header

All Implemented Interfaces:

Serializable

public class Header

extends Object

implements Serializable

Stores general header information about a document. Includes information such as title, author, copyright details etc.

Version:

2.2, 9th September, 2002.

Author:

Jo Wood.

See Also:

Serialized Form

Constructor Summary

Header(Header oldHeader)
Creates a header based on a copy of the given one.

Header(String title)
Creates a default header with a given title.

Header(String title, String author, String rights, String notes)
Creates a header with given title, author, rights and notes.

Method Summary

String	getAuthor() Reports the author of the object associated with this header.
String	getNotes() Reports any notes on the object associated with this header.
String	getRights() Reports the copyright details of the object associated with this header.
String	getTitle() Reports the title of the object associated with this header.
void	setAuthor(String author) Sets the author of the object associated with this header.
void	setNotes(String notes) Sets the notes on the object associated with this header.
void	setRights(String rights) Sets the copyright details associated with this header.
void	setTitle(String title) Sets the title of the object associated with this header.
String	toString() Reports the contents of the header as a text string.

Methods inherited from class java.lang.Object

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

Constructor Detail

Header

public Header(String title)

Creates a default header with a given title.

Parameters:

title - Title of object described by the header.

Header

public Header(String title,
              String author,
              String rights,
              String notes)

Creates a header with given title, author, rights and notes.

Parameters:

title - Title of object described by the header.

author - Author of object described by the header.

rights - Copyright details of object described by the header.

notes - Miscellaneous notes associated with object.

Header

public Header(Header oldHeader)

Creates a header based on a copy of the given one.

Parameters:

oldHeader - Header to copy.

Method Detail

getTitle

public String getTitle()

Reports the title of the object associated with this header.

Returns:

Title of object.

getAuthor

public String getAuthor()

Reports the author of the object associated with this header.

Returns:

Author of object.

getRights

public String getRights()

Reports the copyright details of the object associated with this header.

Returns:

Copyright details associated with this object.

getNotes

public String getNotes()

Reports any notes on the object associated with this header.

Returns:

Notes associated with object.

toString

public String toString()

Reports the contents of the header as a text string.

Returns:

Text representing header.

setTitle

public void setTitle(String title)

Sets the title of the object associated with this header.

Parameters:

title - New title of object.

setAuthor

public void setAuthor(String author)

Sets the author of the object associated with this header.

Parameters:

author - New author information associated with object.

setRights

public void setRights(String rights)

Sets the copyright details associated with this header.

Parameters:

rights - New copyright information associated with object.

setNotes

public void setNotes(String notes)

Sets the notes on the object associated with this header.

Parameters:

notes - New notes associated with object.