DLESE Tools
v1.6.0

org.dlese.dpc.oai.provider.action.form
Class OaiPmhSearchForm

java.lang.Object
  extended by org.apache.struts.action.ActionForm
      extended by org.dlese.dpc.oai.provider.action.form.OaiPmhSearchForm
All Implemented Interfaces:
Serializable

public final class OaiPmhSearchForm
extends org.apache.struts.action.ActionForm

Form used to support OAI-PMH search page.

Author:
John Weatherley
See Also:
Serialized Form

Nested Class Summary
 class OaiPmhSearchForm.DateLabelPair
           
 
Field Summary
 
Fields inherited from class org.apache.struts.action.ActionForm
multipartRequestHandler, servlet
 
Constructor Summary
OaiPmhSearchForm()
          Constructor for the ProviderAdminForm Bean object
 
Method Summary
 List getAvailableFormats()
           
 List getAvailableSets()
           
 String getContextURL()
           
protected static String getDs()
          Return a string for the current time and date, sutiable for display in log files and output to standout:
 String getExampleFormat()
           
 String getExampleId()
           
 String getMessage()
          Gets the message attribute of the ProviderAdminForm object
 String getOaiIdPfx()
          Gets the oaiIdPfx attribute of the ProviderBean object
 String getShowAdvanced()
           
 List getUtcDates()
          A list of UTC dates in the past in the following order: one minute, one hour, one day, one week, one month, one year.
protected  void prtln(String s)
          Output a line of text to standard out, with datestamp, if debug is set to true.
protected  void prtlnErr(String s)
          Output a line of text to error out, with datestamp.
 void setAvailableFormats(List availableFormats)
           
 void setAvailableSets(List avalableSets)
           
 void setContextURL(String contextURL)
           
protected  void setDebug(boolean db)
          Sets the debug attribute of the DocumentService object
 void setExampleFormat(String exampleFormat)
           
 void setExampleId(String exampleId)
           
 void setMessage(String message)
          Sets the message attribute of the ProviderAdminForm object
 void setOaiIdPfx(String oaiIdPfx)
          Sets the oaiIdPfx attribute of the ProviderBean object
 void setShowAdvanced(String showAdvanced)
           
 org.apache.struts.action.ActionErrors validate(org.apache.struts.action.ActionMapping mapping, HttpServletRequest request)
          Validate the input.
 
Methods inherited from class org.apache.struts.action.ActionForm
getMultipartRequestHandler, getServlet, getServletWrapper, reset, reset, setMultipartRequestHandler, setServlet, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OaiPmhSearchForm

public OaiPmhSearchForm()
Constructor for the ProviderAdminForm Bean object

Method Detail

getShowAdvanced

public String getShowAdvanced()

setShowAdvanced

public void setShowAdvanced(String showAdvanced)

getExampleFormat

public String getExampleFormat()

setExampleFormat

public void setExampleFormat(String exampleFormat)

getContextURL

public String getContextURL()

setContextURL

public void setContextURL(String contextURL)

getOaiIdPfx

public String getOaiIdPfx()
Gets the oaiIdPfx attribute of the ProviderBean object

Returns:
The oaiIdPfx value

setOaiIdPfx

public void setOaiIdPfx(String oaiIdPfx)
Sets the oaiIdPfx attribute of the ProviderBean object

Parameters:
oaiIdPfx - The new oaiIdPfx value

getAvailableFormats

public List getAvailableFormats()

setAvailableFormats

public void setAvailableFormats(List availableFormats)

getAvailableSets

public List getAvailableSets()

setAvailableSets

public void setAvailableSets(List avalableSets)

setExampleId

public void setExampleId(String exampleId)

getExampleId

public String getExampleId()

getUtcDates

public List getUtcDates()
A list of UTC dates in the past in the following order: one minute, one hour, one day, one week, one month, one year.

Returns:
A list of UTC dates in the past.

setMessage

public void setMessage(String message)
Sets the message attribute of the ProviderAdminForm object

Parameters:
message - The new message value

getMessage

public String getMessage()
Gets the message attribute of the ProviderAdminForm object

Returns:
The message value

validate

public org.apache.struts.action.ActionErrors validate(org.apache.struts.action.ActionMapping mapping,
                                                      HttpServletRequest request)
Validate the input. This method is called AFTER the setter method is called.

Overrides:
validate in class org.apache.struts.action.ActionForm
Parameters:
mapping - The ActionMapping used.
request - The HttpServletRequest for this request.
Returns:
An ActionError containin any errors that had occured.

getDs

protected static String getDs()
Return a string for the current time and date, sutiable for display in log files and output to standout:

Returns:
The dateStamp value

prtlnErr

protected final void prtlnErr(String s)
Output a line of text to error out, with datestamp.

Parameters:
s - The text that will be output to error out.

prtln

protected final void prtln(String s)
Output a line of text to standard out, with datestamp, if debug is set to true.

Parameters:
s - The String that will be output.

setDebug

protected final void setDebug(boolean db)
Sets the debug attribute of the DocumentService object

Parameters:
db - The new debug value

DLESE Tools
v1.6.0