Package 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 Details

    • searchServiceUrl

      protected String searchServiceUrl
      NOT YET DOCUMENTED

    • searchServiceClient

      protected WebServiceClient searchServiceClient
      NOT YET DOCUMENTED

  • Constructor Details

    • SuggestCommentHelper

      public SuggestCommentHelper(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
      invalid reference 
      org.dlese.dpc.suggest.SuggestCommentHelper
      ).
      Parameters:
      recordTemplate - NOT YET DOCUMENTED
      schemaHelper - NOT YET DOCUMENTED

  • Method Details

    • getXmlFormat

      public 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 Exception
      Creates a new
      invalid reference 
      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:
      Exception - NOT YET DOCUMENTED

    • getItemRecordProps

      public Map getItemRecordProps(String id) throws Exception
      Gets the itemRecordProps attribute of the SuggestCommentHelper object
      Parameters:
      id - NOT YET DOCUMENTED
      Returns:
      The itemRecordProps value
      Throws:
      Exception - NOT YET DOCUMENTED

    • putRecordToDCS

      public String putRecordToDCS(SuggestionRecord rec) throws 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:
      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