DLESE Tools
v1.6.0

org.dlese.dpc.dds.action.form
Class DDSReportingForm

java.lang.Object
  extended by org.apache.struts.action.ActionForm
      extended by org.dlese.dpc.dds.action.form.DDSReportingForm
All Implemented Interfaces:
Serializable

public class DDSReportingForm
extends org.apache.struts.action.ActionForm
implements Serializable

A bean that holds data for DDS reporting.

Author:
John Weatherley
See Also:
DDSReportingAction, Serialized Form

Field Summary
 
Fields inherited from class org.apache.struts.action.ActionForm
multipartRequestHandler, servlet
 
Constructor Summary
DDSReportingForm()
          Constructor for the RepositoryForm object
 
Method Summary
 String getCollection()
          Gets the collection attribute of the DDSReportingForm object
protected static String getDs()
          Return a string for the current time and date, sutiable for display in log files and output to standout:
 String getErrorMsg()
          Gets the errorMsg attribute of the DDSReportingForm object
 String getId()
          Gets the id attribute of the DDSReportingForm object
 List getIdsInMultipleRecords()
          Gets a list of encoded IDs for index field 'id' that show being in more than one record in the index.
 SimpleLuceneIndex getIndex()
          Gets the index attribute of the DDSReportingForm object
 String getIndexToUse()
          Gets the indexToUse attribute of the DDSReportingForm object
 MmdRec[] getMmdRecsDupsOther()
          Gets the mmdRecsDupsOther attribute of the DDSReportingForm object
 MmdRec[] getMmdRecsDupsSame()
          Gets the mmdRecsDupsSame attribute of the DDSReportingForm object
 MmdRec getMyMmdRec()
          Gets the myMmdRec attribute of the DDSReportingForm object
 String getNumResults()
          Gets the numResults attribute of the DDSReportingForm object
 int getNumTerms()
          Gets the numTerms attribute of the DDSReportingForm object
 String[] getOriginalWords()
          Gets the originalWords attribute of the DDSReportingForm object
 ResultDocList getResults()
          Gets the results attribute of the DDSReportingForm object
 String[] getStems()
          Gets the stems attribute of the DDSReportingForm object
 String getTermCountFields()
          Gets the termCountFields attribute of the DDSReportingForm object
 Map getTermCountMap()
          Gets the termCountMap attribute of the DDSReportingForm object
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 setCalculateCountsForFields(String s)
          Sets the fields to generate term counts for, separated by spaces.
 void setCalculateCountsForFieldsAsArray(String[] fields)
          Sets the fields to generate term counts for, or null for none.
 void setCollection(String collection)
          Sets the collection attribute of the DDSReportingForm object
static void setDebug(boolean isDebugOuput)
          Sets the debug attribute
 void setErrorMsg(String errorMsg)
          Sets the errorMsg attribute of the DDSReportingForm object
 void setId(String id)
          Sets the id attribute of the DDSReportingForm object
 void setIndex(SimpleLuceneIndex newIndex)
          Sets the index attribute of the DDSReportingForm object
 void setIndexToUse(String value)
          Sets the indexToUse attribute of the DDSReportingForm object
 void setResults(ResultDocList results)
          Sets the results attribute of the DDSReportingForm object
 void setStemWords(String s)
          Sets the stemWords attribute of the DDSReportingForm object
 
Methods inherited from class org.apache.struts.action.ActionForm
getMultipartRequestHandler, getServlet, getServletWrapper, reset, reset, setMultipartRequestHandler, setServlet, validate, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DDSReportingForm

public DDSReportingForm()
Constructor for the RepositoryForm object

Method Detail

getIndex

public SimpleLuceneIndex getIndex()
Gets the index attribute of the DDSReportingForm object

Returns:
The index value

setIndex

public void setIndex(SimpleLuceneIndex newIndex)
Sets the index attribute of the DDSReportingForm object

Parameters:
newIndex - The new index value

setId

public void setId(String id)
Sets the id attribute of the DDSReportingForm object

Parameters:
id - The new id value

getId

public String getId()
Gets the id attribute of the DDSReportingForm object

Returns:
The id value

setCollection

public void setCollection(String collection)
Sets the collection attribute of the DDSReportingForm object

Parameters:
collection - The new collection value

getCollection

public String getCollection()
Gets the collection attribute of the DDSReportingForm object

Returns:
The collection value

getMmdRecsDupsSame

public MmdRec[] getMmdRecsDupsSame()
Gets the mmdRecsDupsSame attribute of the DDSReportingForm object

Returns:
The mmdRecsDupsSame value

getMyMmdRec

public MmdRec getMyMmdRec()
Gets the myMmdRec attribute of the DDSReportingForm object

Returns:
The myMmdRec value

getMmdRecsDupsOther

public MmdRec[] getMmdRecsDupsOther()
Gets the mmdRecsDupsOther attribute of the DDSReportingForm object

Returns:
The mmdRecsDupsOther value

setCalculateCountsForFields

public void setCalculateCountsForFields(String s)
Sets the fields to generate term counts for, separated by spaces.

Parameters:
s - The new calculateCountsForFields value

setCalculateCountsForFieldsAsArray

public void setCalculateCountsForFieldsAsArray(String[] fields)
Sets the fields to generate term counts for, or null for none.

Parameters:
fields - The new calculateCountsForFields value

getTermCountFields

public String getTermCountFields()
Gets the termCountFields attribute of the DDSReportingForm object

Returns:
The termCountFields value

getNumTerms

public int getNumTerms()
Gets the numTerms attribute of the DDSReportingForm object

Returns:
The numTerms value

setStemWords

public void setStemWords(String s)
Sets the stemWords attribute of the DDSReportingForm object

Parameters:
s - The new stemWords value

getOriginalWords

public String[] getOriginalWords()
Gets the originalWords attribute of the DDSReportingForm object

Returns:
The originalWords value

getStems

public String[] getStems()
Gets the stems attribute of the DDSReportingForm object

Returns:
The stems value

getTermCountMap

public Map getTermCountMap()
Gets the termCountMap attribute of the DDSReportingForm object

Returns:
The termCountMap value

setIndexToUse

public void setIndexToUse(String value)
Sets the indexToUse attribute of the DDSReportingForm object

Parameters:
value - The new indexToUse value

getIndexToUse

public String getIndexToUse()
Gets the indexToUse attribute of the DDSReportingForm object

Returns:
The indexToUse value

setErrorMsg

public void setErrorMsg(String errorMsg)
Sets the errorMsg attribute of the DDSReportingForm object

Parameters:
errorMsg - The new errorMsg value

getErrorMsg

public String getErrorMsg()
Gets the errorMsg attribute of the DDSReportingForm object

Returns:
The errorMsg value

getResults

public ResultDocList getResults()
Gets the results attribute of the DDSReportingForm object

Returns:
The results value

setResults

public void setResults(ResultDocList results)
Sets the results attribute of the DDSReportingForm object

Parameters:
results - The new results value

getNumResults

public String getNumResults()
Gets the numResults attribute of the DDSReportingForm object

Returns:
The numResults value

getIdsInMultipleRecords

public List getIdsInMultipleRecords()
Gets a list of encoded IDs for index field 'id' that show being in more than one record in the index.

Returns:
A list of encoded IDs

getDs

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

public static void setDebug(boolean isDebugOuput)
Sets the debug attribute

Parameters:
isDebugOuput - The new debug value

DLESE Tools
v1.6.0