org.dlese.dpc.serviceclients.cat

Class CATRequestConstraints

java.lang.Object

org.dlese.dpc.serviceclients.cat.CATRequestConstraints

public class CATRequestConstraints
extends java.lang.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 and Description
static java.lang.Integer	ANY_GRADE

Constructor Summary

Constructors

Constructor and Description
CATRequestConstraints() Constructor for the CATRequestConstraints object

Method Summary

Modifier and Type	Method and Description
void	addStandardDocument(java.lang.String docId) Adds an item to the standardDocuments attribute of the CATRequestConstraints object
java.util.Map	asMap() Return Constraints as a map, keyed by parameter name
java.lang.String	getAuthor() Gets the author attribute of the CATRequestConstraints object
int	getEndGrade() Gets the endGrade attribute of the CATRequestConstraints object
java.util.List	getFeedbackStandards() Gets the feedbackStandards attribute of the CATRequestConstraints object
java.lang.String	getId() Gets the id attribute of the CATRequestConstraints object
java.lang.String	getIdentifier() Gets the identifier attribute of the CATRequestConstraints object
java.lang.String	getKeywords() Gets the keywords attribute of the CATRequestConstraints object
int	getMaxResults() Gets the maxResults attribute of the CATRequestConstraints object
java.lang.String	getQuery() Gets the query attribute of the CATRequestConstraints object
java.lang.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
java.lang.String	getTopic() Gets the topic attribute of the CATRequestConstraints object
void	setAuthor(java.lang.String author) Sets the author attribute of the CATRequestConstraints object
void	setEndGrade(int endGrade) Sets the endGrade attribute of the CATRequestConstraints object
void	setFeedbackStandards(java.util.List stds) Sets the feedbackStandards attribute of the CATRequestConstraints object
void	setFeedbackStandards(java.lang.String s) Sets the feedbackStandards attribute of the CATRequestConstraints object
void	setId(java.lang.String id) Sets the id attribute of the CATRequestConstraints object
void	setIdentifier(java.lang.String id) Sets the identifier attribute of the CATRequestConstraints object
void	setKeywords(java.lang.String keywords) Sets the keywords attribute of the CATRequestConstraints object
void	setMaxResults(int max) Sets the maxResults attribute of the CATRequestConstraints object
void	setQuery(java.lang.String q) Sets the query attribute of the CATRequestConstraints object
void	setStartGrade(int startGrade) Sets the startGrade attribute of the CATRequestConstraints object
void	setTopic(java.lang.String topic) Sets the topic attribute of the CATRequestConstraints object
java.lang.String	toQueryString() Generate a queryString to be passed with CAT service request
java.lang.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 Detail

ANY_GRADE

public static final java.lang.Integer ANY_GRADE

Constructor Detail

CATRequestConstraints

public CATRequestConstraints()

Constructor for the CATRequestConstraints object

Method Detail

getQuery

public java.lang.String getQuery()

Gets the query attribute of the CATRequestConstraints object

Returns:

The query value

setId

public void setId(java.lang.String id)

Sets the id attribute of the CATRequestConstraints object

Parameters:

id - The new id value

getId

public java.lang.String getId()

Gets the id attribute of the CATRequestConstraints object

Returns:

The id value

setAuthor

public void setAuthor(java.lang.String author)

Sets the author attribute of the CATRequestConstraints object

Parameters:

author - The new author value

getAuthor

public java.lang.String getAuthor()

Gets the author attribute of the CATRequestConstraints object

Returns:

The author value

setTopic

public void setTopic(java.lang.String topic)

Sets the topic attribute of the CATRequestConstraints object

Parameters:

topic - The new topic value

getTopic

public java.lang.String getTopic()

Gets the topic attribute of the CATRequestConstraints object

Returns:

The topic value

getStandardDocuments

public java.lang.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(java.lang.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(java.lang.String keywords)

Sets the keywords attribute of the CATRequestConstraints object

Parameters:

keywords - The new keywords value

getKeywords

public java.lang.String getKeywords()

Gets the keywords attribute of the CATRequestConstraints object

Returns:

The keywords value

setQuery

public void setQuery(java.lang.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 java.lang.String getIdentifier()

Gets the identifier attribute of the CATRequestConstraints object

Returns:

The identifier value

setIdentifier

public void setIdentifier(java.lang.String id)

Sets the identifier attribute of the CATRequestConstraints object

Parameters:

id - The new identifier value

setFeedbackStandards

public void setFeedbackStandards(java.util.List stds)

Sets the feedbackStandards attribute of the CATRequestConstraints object

Parameters:

stds - The new feedbackStandards value

setFeedbackStandards

public void setFeedbackStandards(java.lang.String s)

Sets the feedbackStandards attribute of the CATRequestConstraints object

Parameters:

s - The new feedbackStandards value

getFeedbackStandards

public java.util.List getFeedbackStandards()

Gets the feedbackStandards attribute of the CATRequestConstraints object

Returns:

The feedbackStandards value

asMap

public java.util.Map asMap()

Return Constraints as a map, keyed by parameter name

Returns:

Contraints map

toQueryString

public java.lang.String toQueryString()

Generate a queryString to be passed with CAT service request

Returns:

a queryString

toString

public java.lang.String toString()

Return string representation of constraints map, used for debugging

Overrides:

toString in class java.lang.Object

Returns:

string representation of this CATRequestConstraints