DLESE Tools
v1.6.0

org.dlese.dpc.suggest.comment
Class CommentRecord

java.lang.Object
  extended by org.dlese.dpc.suggest.SuggestionRecord
      extended by org.dlese.dpc.suggest.comment.CommentRecord

public class CommentRecord
extends SuggestionRecord

SuggestionRecord for Suggestors using the "dlese_anno" metadata framework.

Version:
$Id: CommentRecord.java,v 1.2 2009/03/20 23:34:00 jweather Exp $
Author:
Jonathan Ostwald

Field Summary
 
Fields inherited from class org.dlese.dpc.suggest.SuggestionRecord
doc, docMap
 
Constructor Summary
CommentRecord(Document doc, SchemaHelper schemaHelper)
          Creates a new CommentRecord given a LOCALIZED dom4j.Document and SchemaHelper, but doesn't assign an id
 
Method Summary
 String getCreationDate()
          Gets the creation date for this CommentRecord.
 String getDescription()
          Gets the description attribute of the CommentRecord object
 String getEmail()
          Gets the email attribute of the CommentRecord object
 String getInstName()
          Gets the instName attribute of the CommentRecord object
 String getItemID()
          Gets the itemID attribute of the CommentRecord object
 String getNameFirst()
          Gets the nameFirst attribute of the CommentRecord object
 String getNameLast()
          Gets the nameLast attribute of the CommentRecord object
 String getRole()
          There may be more than one contributor element.
 String getShare()
          Gets the share attribute of the CommentRecord object
 String getTitle()
          Gets the title attribute of the CommentRecord object
static void main(String[] args)
          The main program for the CommentRecord class
 void setCreationDate(String dateStr)
          Writes a String representaton of the date to various locations in the instance document.
static void setDebug(boolean db)
          Sets the debug attribute of the Emailer object
 void setDescription(String val)
          Sets the description attribute of the CommentRecord object
 void setEmail(String val)
          Sets the email attribute of the CommentRecord object
 void setInstName(String val)
          Sets the instName attribute of the CommentRecord object
 void setItemID(String val)
          Sets the itemID attribute of the CommentRecord object
 void setNameFirst(String val)
          Sets the nameFirst attribute of the CommentRecord object
 void setNameLast(String val)
          Sets the nameLast attribute of the CommentRecord object
 void setRole(String val)
          Sets the role attribute of the CommentRecord object for the contributor/PERSON tagset.
 void setShare(String val)
          Sets the share attribute of the CommentRecord object
 void setTitle(String val)
          Sets the title attribute of the CommentRecord object
 String toString()
          Print selected fields of this object for debugging purposes
 
Methods inherited from class org.dlese.dpc.suggest.SuggestionRecord
get, getDoc, getDocMap, put
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CommentRecord

public CommentRecord(Document doc,
                     SchemaHelper schemaHelper)
Creates a new CommentRecord given a LOCALIZED dom4j.Document and SchemaHelper, but doesn't assign an id

Parameters:
doc - Document
schemaHelper - NOT YET DOCUMENTED
Method Detail

getTitle

public String getTitle()
Gets the title attribute of the CommentRecord object

Returns:
The title value

setTitle

public void setTitle(String val)
              throws Exception
Sets the title attribute of the CommentRecord object

Parameters:
val - The new title value
Throws:
Exception - Description of the Exception

getItemID

public String getItemID()
Gets the itemID attribute of the CommentRecord object

Returns:
The itemID value

setItemID

public void setItemID(String val)
               throws Exception
Sets the itemID attribute of the CommentRecord object

Parameters:
val - The new itemID value
Throws:
Exception - Description of the Exception

getDescription

public String getDescription()
Gets the description attribute of the CommentRecord object

Returns:
The description value

setDescription

public void setDescription(String val)
                    throws Exception
Sets the description attribute of the CommentRecord object

Parameters:
val - The new description value
Throws:
Exception - Description of the Exception

getRole

public String getRole()
There may be more than one contributor element. We are assigning the role to the contributor/PERSON tagset.

Returns:
The role value

setRole

public void setRole(String val)
             throws Exception
Sets the role attribute of the CommentRecord object for the contributor/PERSON tagset.

Parameters:
val - The new role value
Throws:
Exception - Description of the Exception

getShare

public String getShare()
Gets the share attribute of the CommentRecord object

Returns:
The share value

setShare

public void setShare(String val)
              throws Exception
Sets the share attribute of the CommentRecord object

Parameters:
val - The new share value
Throws:
Exception - Description of the Exception

getNameFirst

public String getNameFirst()
Gets the nameFirst attribute of the CommentRecord object

Returns:
The nameFirst value

setNameFirst

public void setNameFirst(String val)
                  throws Exception
Sets the nameFirst attribute of the CommentRecord object

Parameters:
val - The new nameFirst value
Throws:
Exception - Description of the Exception

getNameLast

public String getNameLast()
Gets the nameLast attribute of the CommentRecord object

Returns:
The nameLast value

setNameLast

public void setNameLast(String val)
                 throws Exception
Sets the nameLast attribute of the CommentRecord object

Parameters:
val - The new nameLast value
Throws:
Exception - Description of the Exception

getEmail

public String getEmail()
Gets the email attribute of the CommentRecord object

Returns:
The email value

setEmail

public void setEmail(String val)
              throws Exception
Sets the email attribute of the CommentRecord object

Parameters:
val - The new email value
Throws:
Exception - Description of the Exception

getInstName

public String getInstName()
Gets the instName attribute of the CommentRecord object

Returns:
The instName value

setInstName

public void setInstName(String val)
                 throws Exception
Sets the instName attribute of the CommentRecord object

Parameters:
val - The new instName value
Throws:
Exception - Description of the Exception

getCreationDate

public String getCreationDate()
Gets the creation date for this CommentRecord.

Returns:
The creationDate value (e.g., "2007-09-23")

setCreationDate

public void setCreationDate(String dateStr)
                     throws Exception
Writes a String representaton of the date to various locations in the instance document.

Parameters:
dateStr - The creationDate value (e.g., "2007-09-23")
Throws:
Exception - if the creationDate cannot be set

setDebug

public static void setDebug(boolean db)
Sets the debug attribute of the Emailer object

Parameters:
db - The new debug value

main

public static void main(String[] args)
                 throws Exception
The main program for the CommentRecord class

Parameters:
args - The command line arguments
Throws:
Exception - NOT YET DOCUMENTED

toString

public String toString()
Print selected fields of this object for debugging purposes

Overrides:
toString in class Object
Returns:
String representation of this CommentRecord

DLESE Tools
v1.6.0