Package org.dlese.dpc.suggest.comment
Class CommentRecord
java.lang.Object
org.dlese.dpc.suggest.SuggestionRecord
org.dlese.dpc.suggest.comment.CommentRecord
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
ConstructorsConstructorDescriptionCommentRecord(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 TypeMethodDescriptionGets the creation date for this CommentRecord.Gets the description attribute of the CommentRecord objectgetEmail()Gets the email attribute of the CommentRecord objectGets the instName attribute of the CommentRecord objectGets the itemID attribute of the CommentRecord objectGets the nameFirst attribute of the CommentRecord objectGets the nameLast attribute of the CommentRecord objectgetRole()There may be more than one contributor element.getShare()Gets the share attribute of the CommentRecord objectgetTitle()Gets the title attribute of the CommentRecord objectstatic voidThe main program for the CommentRecord classvoidsetCreationDate(String dateStr) Writes a String representaton of the date to various locations in the instance document.static voidsetDebug(boolean db) Sets the debug attribute of the Emailer objectvoidsetDescription(String val) Sets the description attribute of the CommentRecord objectvoidSets the email attribute of the CommentRecord objectvoidsetInstName(String val) Sets the instName attribute of the CommentRecord objectvoidSets the itemID attribute of the CommentRecord objectvoidsetNameFirst(String val) Sets the nameFirst attribute of the CommentRecord objectvoidsetNameLast(String val) Sets the nameLast attribute of the CommentRecord objectvoidSets the role attribute of the CommentRecord object for the contributor/PERSON tagset.voidSets the share attribute of the CommentRecord objectvoidSets the title attribute of the CommentRecord objecttoString()Print selected fields of this object for debugging purposesMethods inherited from class org.dlese.dpc.suggest.SuggestionRecord
get, getDoc, getDocMap, put
-
Constructor Details
-
CommentRecord
Creates a new CommentRecord given a LOCALIZED dom4j.Document and SchemaHelper, but doesn't assign an id- Parameters:
doc-DocumentschemaHelper- NOT YET DOCUMENTED
-
-
Method Details
-
getTitle
Gets the title attribute of the CommentRecord object- Returns:
- The title value
-
setTitle
Sets the title attribute of the CommentRecord object- Parameters:
val- The new title value- Throws:
Exception- Description of the Exception
-
getItemID
Gets the itemID attribute of the CommentRecord object- Returns:
- The itemID value
-
setItemID
Sets the itemID attribute of the CommentRecord object- Parameters:
val- The new itemID value- Throws:
Exception- Description of the Exception
-
getDescription
Gets the description attribute of the CommentRecord object- Returns:
- The description value
-
setDescription
Sets the description attribute of the CommentRecord object- Parameters:
val- The new description value- Throws:
Exception- Description of the Exception
-
getRole
There may be more than one contributor element. We are assigning the role to the contributor/PERSON tagset.- Returns:
- The role value
-
setRole
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
-
getNameFirst
Gets the nameFirst attribute of the CommentRecord object- Returns:
- The nameFirst value
-
setNameFirst
Sets the nameFirst attribute of the CommentRecord object- Parameters:
val- The new nameFirst value- Throws:
Exception- Description of the Exception
-
getNameLast
Gets the nameLast attribute of the CommentRecord object- Returns:
- The nameLast value
-
setNameLast
Sets the nameLast attribute of the CommentRecord object- Parameters:
val- The new nameLast value- Throws:
Exception- Description of the Exception
-
getEmail
Gets the email attribute of the CommentRecord object- Returns:
- The email value
-
setEmail
Sets the email attribute of the CommentRecord object- Parameters:
val- The new email value- Throws:
Exception- Description of the Exception
-
getInstName
Gets the instName attribute of the CommentRecord object- Returns:
- The instName value
-
setInstName
Sets the instName attribute of the CommentRecord object- Parameters:
val- The new instName value- Throws:
Exception- Description of the Exception
-
getCreationDate
Gets the creation date for this CommentRecord.- Returns:
- The creationDate value (e.g., "2007-09-23")
-
setCreationDate
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
The main program for the CommentRecord class- Parameters:
args- The command line arguments- Throws:
Exception- NOT YET DOCUMENTED
-
toString
Print selected fields of this object for debugging purposes
-