org.dlese.dpc.suggest.comment

Class CommentRecord

java.lang.Object

org.dlese.dpc.suggest.SuggestionRecord

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

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCreationDate() Gets the creation date for this CommentRecord.
java.lang.String	getDescription() Gets the description attribute of the CommentRecord object
java.lang.String	getEmail() Gets the email attribute of the CommentRecord object
java.lang.String	getInstName() Gets the instName attribute of the CommentRecord object
java.lang.String	getItemID() Gets the itemID attribute of the CommentRecord object
java.lang.String	getNameFirst() Gets the nameFirst attribute of the CommentRecord object
java.lang.String	getNameLast() Gets the nameLast attribute of the CommentRecord object
java.lang.String	getRole() There may be more than one contributor element.
java.lang.String	getShare() Gets the share attribute of the CommentRecord object
java.lang.String	getTitle() Gets the title attribute of the CommentRecord object
static void	main(java.lang.String[] args) The main program for the CommentRecord class
void	setCreationDate(java.lang.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(java.lang.String val) Sets the description attribute of the CommentRecord object
void	setEmail(java.lang.String val) Sets the email attribute of the CommentRecord object
void	setInstName(java.lang.String val) Sets the instName attribute of the CommentRecord object
void	setItemID(java.lang.String val) Sets the itemID attribute of the CommentRecord object
void	setNameFirst(java.lang.String val) Sets the nameFirst attribute of the CommentRecord object
void	setNameLast(java.lang.String val) Sets the nameLast attribute of the CommentRecord object
void	setRole(java.lang.String val) Sets the role attribute of the CommentRecord object for the contributor/PERSON tagset.
void	setShare(java.lang.String val) Sets the share attribute of the CommentRecord object
void	setTitle(java.lang.String val) Sets the title attribute of the CommentRecord object
java.lang.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(org.dom4j.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 java.lang.String getTitle()

Gets the title attribute of the CommentRecord object

Returns:

The title value

setTitle

public void setTitle(java.lang.String val)
              throws java.lang.Exception

Sets the title attribute of the CommentRecord object

Parameters:

val - The new title value

Throws:

java.lang.Exception - Description of the Exception

getItemID

public java.lang.String getItemID()

Gets the itemID attribute of the CommentRecord object

Returns:

The itemID value

setItemID

public void setItemID(java.lang.String val)
               throws java.lang.Exception

Sets the itemID attribute of the CommentRecord object

Parameters:

val - The new itemID value

Throws:

java.lang.Exception - Description of the Exception

getDescription

public java.lang.String getDescription()

Gets the description attribute of the CommentRecord object

Returns:

The description value

setDescription

public void setDescription(java.lang.String val)
                    throws java.lang.Exception

Sets the description attribute of the CommentRecord object

Parameters:

val - The new description value

Throws:

java.lang.Exception - Description of the Exception

getRole

public java.lang.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(java.lang.String val)
             throws java.lang.Exception

Sets the role attribute of the CommentRecord object for the contributor/PERSON tagset.

Parameters:

val - The new role value

Throws:

java.lang.Exception - Description of the Exception

getShare

public java.lang.String getShare()

Gets the share attribute of the CommentRecord object

Returns:

The share value

setShare

public void setShare(java.lang.String val)
              throws java.lang.Exception

Sets the share attribute of the CommentRecord object

Parameters:

val - The new share value

Throws:

java.lang.Exception - Description of the Exception

getNameFirst

public java.lang.String getNameFirst()

Gets the nameFirst attribute of the CommentRecord object

Returns:

The nameFirst value

setNameFirst

public void setNameFirst(java.lang.String val)
                  throws java.lang.Exception

Sets the nameFirst attribute of the CommentRecord object

Parameters:

val - The new nameFirst value

Throws:

java.lang.Exception - Description of the Exception

getNameLast

public java.lang.String getNameLast()

Gets the nameLast attribute of the CommentRecord object

Returns:

The nameLast value

setNameLast

public void setNameLast(java.lang.String val)
                 throws java.lang.Exception

Sets the nameLast attribute of the CommentRecord object

Parameters:

val - The new nameLast value

Throws:

java.lang.Exception - Description of the Exception

getEmail

public java.lang.String getEmail()

Gets the email attribute of the CommentRecord object

Returns:

The email value

setEmail

public void setEmail(java.lang.String val)
              throws java.lang.Exception

Sets the email attribute of the CommentRecord object

Parameters:

val - The new email value

Throws:

java.lang.Exception - Description of the Exception

getInstName

public java.lang.String getInstName()

Gets the instName attribute of the CommentRecord object

Returns:

The instName value

setInstName

public void setInstName(java.lang.String val)
                 throws java.lang.Exception

Sets the instName attribute of the CommentRecord object

Parameters:

val - The new instName value

Throws:

java.lang.Exception - Description of the Exception

getCreationDate

public java.lang.String getCreationDate()

Gets the creation date for this CommentRecord.

Returns:

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

setCreationDate

public void setCreationDate(java.lang.String dateStr)
                     throws java.lang.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:

java.lang.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(java.lang.String[] args)
                 throws java.lang.Exception

The main program for the CommentRecord class

Parameters:

args - The command line arguments

Throws:

java.lang.Exception - NOT YET DOCUMENTED

toString

public java.lang.String toString()

Print selected fields of this object for debugging purposes

Overrides:

toString in class java.lang.Object

Returns:

String representation of this CommentRecord