uk.co.agena.minerva.util.model
Class Notes

java.lang.Object
  extended by uk.co.agena.minerva.util.model.Notes
All Implemented Interfaces:
Writable

public class Notes
extends java.lang.Object
implements Writable


Field Summary
 
Fields inherited from interface uk.co.agena.minerva.util.model.Writable
FIELD_SEPARATOR
 
Constructor Summary
Notes()
          Empty constructor
 
Method Summary
 void addNote(java.util.List newNotes)
          Adds all the notes in the specified list of notes
 void addNote(Note n)
          Add a note to the notes collection
 Note addNote(java.lang.String shortDescription, java.lang.String longDescription)
          Adds a note with the specified text
 void appendToAllNotes(java.lang.String shortString, java.lang.String longString)
          Appends the specified Strings to the short/long description field of the NameDescription attatched to each Note.
 java.lang.Object clone()
          Clones the notes set
 java.util.List getNotes()
          Returns a list of all the notes
 double getVersion()
          Returns the version of the class.
 int read(java.util.List strings, int currentLineNumber)
           
 void removeAllNotes()
          Removes all notes from the note collection
 void removeNote(Note n)
          Removes the specified note from the list of notes
 void setVersion(double version)
          Sets the version number of the class.
 java.util.List write()
          Writes the object in question to a List of Strings.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Notes

public Notes()
Empty constructor

Method Detail

addNote

public void addNote(Note n)
Add a note to the notes collection

Parameters:
n -

addNote

public void addNote(java.util.List newNotes)
Adds all the notes in the specified list of notes

Parameters:
newNotes -

addNote

public Note addNote(java.lang.String shortDescription,
                    java.lang.String longDescription)
Adds a note with the specified text

Parameters:
shortDescription -
longDescription -
Returns:

getNotes

public java.util.List getNotes()
Returns a list of all the notes

Returns:

getVersion

public double getVersion()
Description copied from interface: Writable
Returns the version of the class. Used to ensure backward compatibility.

Specified by:
getVersion in interface Writable
Returns:
the version number

setVersion

public void setVersion(double version)
Description copied from interface: Writable
Sets the version number of the class. Used to ensure backward compatibility.

Specified by:
setVersion in interface Writable
Parameters:
version - the version number

write

public java.util.List write()
                     throws MinervaReadWriteException
Description copied from interface: Writable
Writes the object in question to a List of Strings.

Specified by:
write in interface Writable
Returns:
the List to which the Strings have been written
Throws:
MinervaReadWriteException - if there

read

public int read(java.util.List strings,
                int currentLineNumber)
         throws MinervaReadWriteException
Specified by:
read in interface Writable
Throws:
MinervaReadWriteException

removeAllNotes

public void removeAllNotes()
Removes all notes from the note collection


removeNote

public void removeNote(Note n)
Removes the specified note from the list of notes

Parameters:
n -

appendToAllNotes

public void appendToAllNotes(java.lang.String shortString,
                             java.lang.String longString)
Appends the specified Strings to the short/long description field of the NameDescription attatched to each Note.

Parameters:
shortString - The string to append to the short description.
longString - The string to append to the long description.

clone

public java.lang.Object clone()
Clones the notes set

Overrides:
clone in class java.lang.Object
Returns:


Copyright © 2006 Agena Ltd. All Rights Reserved.