org.dlese.dpc.suggest.comment

Class SuggestCommentHelper

java.lang.Object

org.dlese.dpc.suggest.SuggestHelper

org.dlese.dpc.suggest.comment.SuggestCommentHelper

public class SuggestCommentHelper
extends SuggestHelper

Provides services for SuggestComment Client.

Author:

Jonathan Ostwald

Field Summary

Fields

Modifier and Type	Field and Description
protected WebServiceClient	searchServiceClient NOT YET DOCUMENTED
protected java.lang.String	searchServiceUrl NOT YET DOCUMENTED

Fields inherited from class org.dlese.dpc.suggest.SuggestHelper

dcsStatus, dcsStatusNote, recordTemplate, schemaHelper

Constructor Summary

Constructors

Constructor and Description
SuggestCommentHelper(java.io.File recordTemplate, SchemaHelper schemaHelper) SuggestCommentHelper Constructor.

Method Summary

Modifier and Type	Method and Description
java.util.Map	getItemRecordProps(java.lang.String id) Gets the itemRecordProps attribute of the SuggestCommentHelper object
WebServiceClient	getSearchServiceClient() Gets the searchServiceClient attribute of the SuggestCommentHelper object
java.lang.String	getXmlFormat() Gets the xmlFormat attribute of the SuggestCommentHelper object
CommentRecord	newRecord() Creates a new ResourceRecord instance by reading from the recordTemplate.
java.lang.String	putRecordToDCS(SuggestionRecord rec) Insert a suggested record into the DCS specified by client configuration.
static void	setDebug(boolean db) Sets the debug attribute of the SuggestCommentHelper object
void	setSearchServiceClient(WebServiceClient wsc) Sets the searchServiceClient attribute of the SuggestCommentHelper object

Methods inherited from class org.dlese.dpc.suggest.SuggestHelper

getDateStamp, getDestCollection, getEmailFrom, getEmailTo, getMailServer, getRepositoryServiceClient, getSchemaHelper, getViewBaseUrl, prtlnErr, setDcsStatus, setDcsStatusNote, setDestCollection, setEmailFrom, setEmailTo, setMailServer, setRepositoryServiceClient

Methods inherited from class java.lang.Object

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

Field Detail

searchServiceUrl

protected java.lang.String searchServiceUrl

NOT YET DOCUMENTED

searchServiceClient

protected WebServiceClient searchServiceClient

NOT YET DOCUMENTED

Constructor Detail

SuggestCommentHelper

public SuggestCommentHelper(java.io.File recordTemplate,
                            SchemaHelper schemaHelper)

SuggestCommentHelper Constructor. The repositoryDir param points to a directory that contains a default record (used for making new records), and a records directory (where suggested urls are stored). This stuff is all hard coded for now, but properties can be used to supply defaults (see org.dlese.dpc.suggest.SuggestCommentHelper).

Parameters:

recordTemplate - NOT YET DOCUMENTED

schemaHelper - NOT YET DOCUMENTED

Method Detail

getXmlFormat

public java.lang.String getXmlFormat()

Gets the xmlFormat attribute of the SuggestCommentHelper object

Specified by:

getXmlFormat in class SuggestHelper

Returns:

The xmlFormat value

newRecord

public CommentRecord newRecord()
                        throws java.lang.Exception

Creates a new ResourceRecord instance by reading from the recordTemplate. We don't call readRecord (file) because we don't want the id to be set for the new record

Specified by:

newRecord in class SuggestHelper

Returns:

Description of the Return Value

Throws:

java.lang.Exception - NOT YET DOCUMENTED

getItemRecordProps

public java.util.Map getItemRecordProps(java.lang.String id)
                                 throws java.lang.Exception

Gets the itemRecordProps attribute of the SuggestCommentHelper object

Parameters:

id - NOT YET DOCUMENTED

Returns:

The itemRecordProps value

Throws:

java.lang.Exception - NOT YET DOCUMENTED

putRecordToDCS

public java.lang.String putRecordToDCS(SuggestionRecord rec)
                                throws java.lang.Exception

Insert a suggested record into the DCS specified by client configuration.

Specified by:

putRecordToDCS in class SuggestHelper

Parameters:

rec - NOT YET DOCUMENTED

Returns:

ID of record in destination DCS

Throws:

java.lang.Exception - Description of the Exception

getSearchServiceClient

public WebServiceClient getSearchServiceClient()

Gets the searchServiceClient attribute of the SuggestCommentHelper object

Returns:

The searchServiceClient value

setSearchServiceClient

public void setSearchServiceClient(WebServiceClient wsc)

Sets the searchServiceClient attribute of the SuggestCommentHelper object

Parameters:

wsc - The new searchServiceClient value

setDebug

public static void setDebug(boolean db)

Sets the debug attribute of the SuggestCommentHelper object

Parameters:

db - The new debug value