Package org.dlese.dpc.serviceclients.cat

Class CATRequestConstraints

java.lang.Object
org.dlese.dpc.serviceclients.cat.CATRequestConstraints
public class CATRequestConstraints extends Object
Data Structure to manage information passed to the CATRest Service to constrain it's search.
Author:
ostwald

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Integer
    ANY_GRADE
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    CATRequestConstraints()
    Constructor for the CATRequestConstraints object

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addStandardDocument(String docId)
    Adds an item to the standardDocuments attribute of the CATRequestConstraints object
    Map
    asMap()
    Return Constraints as a map, keyed by parameter name
    String
    getAuthor()
    Gets the author attribute of the CATRequestConstraints object
    int
    getEndGrade()
    Gets the endGrade attribute of the CATRequestConstraints object
    List
    getFeedbackStandards()
    Gets the feedbackStandards attribute of the CATRequestConstraints object
    String
    getId()
    Gets the id attribute of the CATRequestConstraints object
    String
    getIdentifier()
    Gets the identifier attribute of the CATRequestConstraints object
    String
    getKeywords()
    Gets the keywords attribute of the CATRequestConstraints object
    int
    getMaxResults()
    Gets the maxResults attribute of the CATRequestConstraints object
    String
    getQuery()
    Gets the query attribute of the CATRequestConstraints object
    String
    getStandardDocuments()
    Gets the standardDocuments attribute of the CATRequestConstraints object by creating a comma-delimited string joining the items in the standardDocuments list
    int
    getStartGrade()
    Gets the startGrade attribute of the CATRequestConstraints object
    String
    getTopic()
    Gets the topic attribute of the CATRequestConstraints object
    void
    setAuthor(String author)
    Sets the author attribute of the CATRequestConstraints object
    void
    setEndGrade(int endGrade)
    Sets the endGrade attribute of the CATRequestConstraints object
    void
    setFeedbackStandards(String s)
    Sets the feedbackStandards attribute of the CATRequestConstraints object
    void
    setFeedbackStandards(List stds)
    Sets the feedbackStandards attribute of the CATRequestConstraints object
    void
    setId(String id)
    Sets the id attribute of the CATRequestConstraints object
    void
    setIdentifier(String id)
    Sets the identifier attribute of the CATRequestConstraints object
    void
    setKeywords(String keywords)
    Sets the keywords attribute of the CATRequestConstraints object
    void
    setMaxResults(int max)
    Sets the maxResults attribute of the CATRequestConstraints object
    void
    setQuery(String q)
    Sets the query attribute of the CATRequestConstraints object
    void
    setStartGrade(int startGrade)
    Sets the startGrade attribute of the CATRequestConstraints object
    void
    setTopic(String topic)
    Sets the topic attribute of the CATRequestConstraints object
    String
    toQueryString()
    Generate a queryString to be passed with CAT service request
    String
    toString()
    Return string representation of constraints map, used for debugging

    Methods inherited from class java.lang.Object

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

  • Field Details

    • ANY_GRADE

      public static final Integer ANY_GRADE

  • Constructor Details

    • CATRequestConstraints

      public CATRequestConstraints()
      Constructor for the CATRequestConstraints object

  • Method Details

    • getQuery

      public String getQuery()
      Gets the query attribute of the CATRequestConstraints object
      Returns:
      The query value

    • setId

      public void setId(String id)
      Sets the id attribute of the CATRequestConstraints object
      Parameters:
      id - The new id value

    • getId

      public String getId()
      Gets the id attribute of the CATRequestConstraints object
      Returns:
      The id value

    • setAuthor

      public void setAuthor(String author)
      Sets the author attribute of the CATRequestConstraints object
      Parameters:
      author - The new author value

    • getAuthor

      public String getAuthor()
      Gets the author attribute of the CATRequestConstraints object
      Returns:
      The author value

    • setTopic

      public void setTopic(String topic)
      Sets the topic attribute of the CATRequestConstraints object
      Parameters:
      topic - The new topic value

    • getTopic

      public String getTopic()
      Gets the topic attribute of the CATRequestConstraints object
      Returns:
      The topic value

    • getStandardDocuments

      public String getStandardDocuments()
      Gets the standardDocuments attribute of the CATRequestConstraints object by creating a comma-delimited string joining the items in the standardDocuments list
      Returns:
      The standardDocuments value

    • addStandardDocument

      public void addStandardDocument(String docId)
      Adds an item to the standardDocuments attribute of the CATRequestConstraints object
      Parameters:
      docId - asn docId to be added to standardDocuments

    • setStartGrade

      public void setStartGrade(int startGrade)
      Sets the startGrade attribute of the CATRequestConstraints object
      Parameters:
      startGrade - The new startGrade value

    • getStartGrade

      public int getStartGrade()
      Gets the startGrade attribute of the CATRequestConstraints object
      Returns:
      The startGrade value

    • setEndGrade

      public void setEndGrade(int endGrade)
      Sets the endGrade attribute of the CATRequestConstraints object
      Parameters:
      endGrade - The new endGrade value

    • getEndGrade

      public int getEndGrade()
      Gets the endGrade attribute of the CATRequestConstraints object
      Returns:
      The endGrade value

    • setKeywords

      public void setKeywords(String keywords)
      Sets the keywords attribute of the CATRequestConstraints object
      Parameters:
      keywords - The new keywords value

    • getKeywords

      public String getKeywords()
      Gets the keywords attribute of the CATRequestConstraints object
      Returns:
      The keywords value

    • setQuery

      public void setQuery(String q)
      Sets the query attribute of the CATRequestConstraints object
      Parameters:
      q - The new query value (used to specifiy resourceUrl)

    • getMaxResults

      public int getMaxResults()
      Gets the maxResults attribute of the CATRequestConstraints object
      Returns:
      The maxResults value

    • setMaxResults

      public void setMaxResults(int max)
      Sets the maxResults attribute of the CATRequestConstraints object
      Parameters:
      max - The new maxResults value

    • getIdentifier

      public String getIdentifier()
      Gets the identifier attribute of the CATRequestConstraints object
      Returns:
      The identifier value

    • setIdentifier

      public void setIdentifier(String id)
      Sets the identifier attribute of the CATRequestConstraints object
      Parameters:
      id - The new identifier value

    • setFeedbackStandards

      public void setFeedbackStandards(List stds)
      Sets the feedbackStandards attribute of the CATRequestConstraints object
      Parameters:
      stds - The new feedbackStandards value

    • setFeedbackStandards

      public void setFeedbackStandards(String s)
      Sets the feedbackStandards attribute of the CATRequestConstraints object
      Parameters:
      s - The new feedbackStandards value

    • getFeedbackStandards

      public List getFeedbackStandards()
      Gets the feedbackStandards attribute of the CATRequestConstraints object
      Returns:
      The feedbackStandards value

    • asMap

      public Map asMap()
      Return Constraints as a map, keyed by parameter name
      Returns:
      Contraints map

    • toQueryString

      public String toQueryString()
      Generate a queryString to be passed with CAT service request
      Returns:
      a queryString

    • toString

      public String toString()
      Return string representation of constraints map, used for debugging
      Overrides:
      toString in class Object
      Returns:
      string representation of this CATRequestConstraints