Package org.dlese.dpc.serviceclients.remotesearch

Class RemoteResultDoc

java.lang.Object
org.dlese.dpc.serviceclients.remotesearch.RemoteResultDoc
All Implemented Interfaces:
Serializable
public class RemoteResultDoc extends Object implements Serializable
This class wraps the individual items that are returned by RemoteSearcher.searchDocs(String). It is patterned after the ResultDoc class.
Author:
ostwald
See Also:

  • Constructor Details

    • RemoteResultDoc

      public RemoteResultDoc(String id, String url, String collection, RemoteSearcher rs)
      Constructor for the RemoteResultDoc object. Used to create a RemoteResultDoc from an alsoCatalogedBy element (see RemoteSearcher.searchDocs(java.lang.String))
      Parameters:
      id - id of item
      url - url of item
      collection - collection label of item
      rs - instance of RemoteSearcher

    • RemoteResultDoc

      public RemoteResultDoc(org.dom4j.Element record, RemoteSearcher rs)
      Construct a RemoteResultDoc from a MatchingRecord element (of the reponse from the UrlCheck Web Service)
      Parameters:
      record - matching record Element
      rs - instance of RemoteSearcher

  • Method Details

    • getId

      public String getId()
      Gets the id attribute of the RemoteResultDoc object (identifying the resource within DDS)
      Returns:
      The id value

    • getDoctype

      public final String getDoctype()
      Gets the doctype attribute of the RemoteResultDoc object (hardcoded to "adn")
      Returns:
      The doctype value

    • getReaderClass

      public final String getReaderClass()
      Gets the readerClass attribute of the RemoteResultDoc object
      Returns:
      The readerClass value

    • getDocReader

      public ADNItemDocReader getDocReader()
      Gets the docReader attribute of the RemoteResultDoc object which supports display of RemoteResultDoc instances via JSP (see ADNItemDocReader).
      Returns:
      The docReader value

    • getDocument

      public GetRecordResponse getDocument()
      Gets the document attribute of the RemoteResultDoc object. The doc attribute is obtained from the RemoteSearcher instance and then cached for future access.
      Returns:
      The document value

    • getUrl

      public String getUrl()
      Gets the url attribute of the RemoteResultDoc object, which pionts to the resource on the web.
      Returns:
      The url value

    • getCollection

      public String getCollection()
      Gets the collection attribute of the RemoteResultDoc object
      Returns:
      The collection value (a human readable string)

    • toString

      public String toString()
      A printable representation - used for debugging
      Overrides:
      toString in class Object
      Returns:
      Description of the Return Value