Package org.dlese.dpc.schemedit.action.form

Class DCSViewForm

java.lang.Object
org.apache.struts.action.ActionForm
org.dlese.dpc.schemedit.action.form.SchemEditForm
org.dlese.dpc.schemedit.action.form.DCSViewForm
All Implemented Interfaces:
Serializable
public final class DCSViewForm extends SchemEditForm implements Serializable
Author:
Jonathan Ostwald
See Also:

  • Constructor Details

    • DCSViewForm

      public DCSViewForm()
      Constructor for the DCSViewForm object

  • Method Details

    • getDcsSetInfo

      public DcsSetInfo getDcsSetInfo()

    • setDcsSetInfo

      public void setDcsSetInfo(DcsSetInfo dcsSetInfo)

    • getPrevId

      public String getPrevId()

    • setPrevId

      public void setPrevId(String id)

    • getNextId

      public String getNextId()

    • setNextId

      public void setNextId(String id)

    • getContextURL

      public String getContextURL()
      Gets the contextURL attribute of the DCSViewForm object
      Overrides:
      getContextURL in class SchemEditForm
      Returns:
      The contextURL value

    • setContextURL

      public void setContextURL(String contextURL)
      Sets the contextURL attribute of the DCSViewForm object
      Overrides:
      setContextURL in class SchemEditForm
      Parameters:
      contextURL - The new contextURL value

    • getResults

      public SearchHelper getResults()
      Gets the search results returned by the SimpleLuceneIndex.
      Returns:
      The results value

    • setCollectionFrameworkLoaded

      public void setCollectionFrameworkLoaded(boolean bool)

    • getCollectionFrameworkLoaded

      public boolean getCollectionFrameworkLoaded()

    • setResults

      public void setResults(SearchHelper results)
      Sets the search results.

    • setResult

      public void setResult(ResultDoc resultDoc)
      Sets the result attribute of the DCSViewForm object
      Parameters:
      resultDoc - The new result value

    • getResult

      public ResultDoc getResult()
      Gets the result attribute of the DCSViewForm object
      Returns:
      The result value

    • setResultIndex

      public void setResultIndex(int i)

    • getResultIndex

      public int getResultIndex()
      Get the index of the current result within the results. Returns -1 if result not found.

    • getRecordViewPage

      public String getRecordViewPage()
      Returns relative path to the jsp frag page containing the record view for the format of the result record.

    • getDocReader

      public DocReader getDocReader()
      Gets the result attribute of the DCSViewForm object
      Returns:
      The result value

    • getNumResults

      public String getNumResults()
      Gets the numResults attribute of the DCSViewForm object
      Returns:
      The numResults value

    • setReportTitle

      public void setReportTitle(String reportTitle)
      Sets the reportTitle attribute of the DCSViewForm object
      Parameters:
      reportTitle - The new reportTitle value

    • getReportTitle

      public String getReportTitle()
      Gets the reportTitle attribute of the DCSViewForm object
      Returns:
      The reportTitle value

    • setStart

      public void setStart(int start)
      Sets the starting index for the records to display.
      Parameters:
      start - The new start value

    • getStart

      public String getStart()
      Gets the starting index for the records that will be displayed.
      Returns:
      The start value

    • getEnd

      public String getEnd()
      Gets the ending index for the records that will be displayed.
      Returns:
      The end value

    • getOffset

      public String getOffset()
      Gets the offset into the results array to begin iterating.
      Returns:
      The offset value

    • getLength

      public String getLength()
      Gets the length of iterations to loop over the results array.
      Returns:
      The length value

    • getNumPagingRecords

      public int getNumPagingRecords()

    • setNumPagingRecords

      public void setNumPagingRecords(int numPagingRecords)
      Sets the number of records to display per paiging request. Defaults to 10.
      Parameters:
      numPagingRecords - The new numPagingRecords value

    • getQe

      public String getQe()
      Gets the query string entered by the user, encoded for use in a URL string.
      Returns:
      The query value ncoded for use in a URL string.

    • getNextResultsUrl

      public String getNextResultsUrl()
      Gets the HTTP parameters that should be used to retrieve the next set of results.
      Returns:
      Everything after the ? that should be included in the pager URL.

    • getPrevResultsUrl

      public String getPrevResultsUrl()
      Gets the HTTP parameters that should be used to retrieve the previous set of results.
      Returns:
      Everything after the ? that should be included in the pager URL.

    • setRequest

      public void setRequest(HttpServletRequest request)
      Sets the request attribute of the DCSViewForm object.
      Parameters:
      request - The new request value

    • getFrameworkConfigFormat

      public String getFrameworkConfigFormat()

    • setFrameworkConfigFormat

      public void setFrameworkConfigFormat(String format)

    • setNonPaigingParams

      public void setNonPaigingParams(String nonPaigingParams)
      Sets the nonPaigingParams attribute of the DCSViewForm object
      Parameters:
      nonPaigingParams - The new nonPaigingParams value

    • getNonPaigingParams

      public final String getNonPaigingParams()
      Gets all the parameters that existed in the request other than those used for paiging.
      Returns:
      The NonPaigingParams returned as an HTTP query string.

    • validate

      public SchemEditActionErrors validate(org.apache.struts.action.ActionMapping mapping, HttpServletRequest request)
      Description copied from class: SchemEditForm
      Validate the request parameters before the Action sees them). NOTE: "validate" must be 2set to TRUE in action mapping (see struts-config) for this method to be called.

      NOTE: is this necessary for the entities to get displayed correctly in the editing forms??

      Overrides:
      validate in class SchemEditForm
      Parameters:
      mapping - NOT YET DOCUMENTED
      request - NOT YET DOCUMENTED
      Returns:
      NOT YET DOCUMENTED

    • prtln

      protected static 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.

    • prtlnError

      protected static void prtlnError(String s)

    • setDebug

      public static void setDebug(boolean db)
      Sets the debug attribute of the object
      Parameters:
      db - The new debug value