Package org.dlese.dpc.dds.action.form
Class HistogramForm
java.lang.Object
org.apache.struts.action.ActionForm
org.dlese.dpc.dds.action.form.HistogramForm
- All Implemented Interfaces:
Serializable
public final class HistogramForm
extends org.apache.struts.action.ActionForm
implements Serializable
A Struts Form bean for handling DDS histogram requests
- Author:
- Ryan Deardorff
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Stringprotected DleseCollectionDocReaderprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected static longprotected SimpleLuceneIndexprotected intprotected Stringprotected RepositoryManagerprotected ServletContextprotected Stringprotected MetadataVocabFields inherited from class org.apache.struts.action.ActionForm
multipartRequestHandler, servlet -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets the collectionDocReader attribute of the HistogramForm objectGets the collection attribute of the HistogramForm objectThis is the OLD way, used by DDS v2.0Gets the collectionTitle attribute of the HistogramForm objectGets the collectionTotal attribute of the HistogramForm objectGets the currentVocabGroup attribute of the HistogramForm objectGets the currentVocabName attribute of the HistogramForm objectgetError()Gets the error attribute of the DDSViewResourceForm objectGets the hasCollectionSpecified attribute of the HistogramForm objectGets the largestTotal attribute of the HistogramForm objectgetTotal()Gets the total attribute of the HistogramForm objectGets the vocabList attribute of the HistogramForm objectDescription of the MethodvoidDescription of the MethodvoidsetCollection(String collection) Sets the collection attribute of the HistogramForm objectvoidsetCollectionDocReader(DocReader collectionDocReader) Sets the collection attribute of the HistogramForm objectvoidsetCollectionMetaName(String collectionMetaName) Sets the collectionMetaName attribute of the HistogramForm objectvoidsetCurrentVocabFramework(String currentVocabFramework) Sets the currentVocabFramework attribute of the HistogramForm objectvoidsetCurrentVocabGroup(String currentVocabGroup) Sets the currentVocabGroup attribute of the HistogramForm objectvoidsetCurrentVocabName(String currentVocabName) Sets the currentVocab attribute of the HistogramForm objectvoidSets the error attribute of the DDSViewResourceForm objectvoidsetHasCollectionSpecified(String hasCollectionSpecified) Sets the hasCollectionSpecified attribute of the HistogramForm objectvoidsetIndex(SimpleLuceneIndex index) Sets the index attribute of the HistogramForm objectvoidSets the repositoryManager attribute of the HistogramForm objectvoidsetServletContext(ServletContext servletContext) Sets the servletContext attribute of the HistogramForm objectvoidsetVocab(MetadataVocab vocab) Sets the vocab attribute of the VocabCachingActionForm objectMethods inherited from class org.apache.struts.action.ActionForm
getMultipartRequestHandler, getServlet, getServletWrapper, reset, reset, setMultipartRequestHandler, setServlet, validate, validate
-
Field Details
-
error
-
hasCollectionSpecified
-
-
totalQuery
-
index
-
rm
-
collection
-
collectionMetaName
-
collectionDocReader
-
largestTotal
protected int largestTotal -
servletContext
-
currentVocabName
-
currentVocabGroup
-
currentVocabFramework
-
vocab
-
histogramIndexModified
protected static long histogramIndexModified
-
-
Constructor Details
-
HistogramForm
public HistogramForm()Constructor for the HistogramForm object
-
-
Method Details
-
setVocab
Sets the vocab attribute of the VocabCachingActionForm object- Parameters:
vocab- The new vocab value
-
setServletContext
Sets the servletContext attribute of the HistogramForm object- Parameters:
servletContext- The new servletContext value
-
setCurrentVocabName
Sets the currentVocab attribute of the HistogramForm object- Parameters:
currentVocabName- The new currentVocabName value
-
getCurrentVocabName
Gets the currentVocabName attribute of the HistogramForm object- Returns:
- The currentVocabName value
-
setCurrentVocabGroup
Sets the currentVocabGroup attribute of the HistogramForm object- Parameters:
currentVocabGroup- The new currentVocabGroup value
-
getCurrentVocabGroup
Gets the currentVocabGroup attribute of the HistogramForm object- Returns:
- The currentVocabGroup value
-
setCurrentVocabFramework
Sets the currentVocabFramework attribute of the HistogramForm object- Parameters:
currentVocabFramework- The new currentVocabFramework value
-
getLargestTotal
Gets the largestTotal attribute of the HistogramForm object- Returns:
- The largestTotal value
-
resetLargestTotal
public void resetLargestTotal()Description of the Method -
setCollection
Sets the collection attribute of the HistogramForm object- Parameters:
collection- The new collection value
-
setCollectionMetaName
Sets the collectionMetaName attribute of the HistogramForm object- Parameters:
collectionMetaName- The new collectionMetaName value
-
getCollectionTitle
Gets the collectionTitle attribute of the HistogramForm object- Returns:
- The collectionTitle value
-
setHasCollectionSpecified
Sets the hasCollectionSpecified attribute of the HistogramForm object- Parameters:
hasCollectionSpecified- The new hasCollectionSpecified value
-
getHasCollectionSpecified
Gets the hasCollectionSpecified attribute of the HistogramForm object- Returns:
- The hasCollectionSpecified value
-
setError
Sets the error attribute of the DDSViewResourceForm object- Parameters:
error- The new error value
-
getError
Gets the error attribute of the DDSViewResourceForm object- Returns:
- The error value
-
setCollectionDocReader
Sets the collection attribute of the HistogramForm object- Parameters:
collectionDocReader- The new collectionResultDoc value
-
getCollectionDocReader
Gets the collectionDocReader attribute of the HistogramForm object- Returns:
- The collectionDocReader value
-
getCollections
Gets the collection attribute of the HistogramForm object- Returns:
- The collection value
-
getVocabList
Gets the vocabList attribute of the HistogramForm object- Returns:
- The vocabList value
-
hasSubtotalsGreaterThanZero
Description of the Method- Parameters:
ret-- Returns:
-
getTotal
Gets the total attribute of the HistogramForm object- Returns:
- The total value
-
getCollectionsVocab
This is the OLD way, used by DDS v2.0- Returns:
- The collectionsVocab value
-
setRepositoryManager
Sets the repositoryManager attribute of the HistogramForm object- Parameters:
rm- The new repositoryManager value
-
setIndex
Sets the index attribute of the HistogramForm object- Parameters:
index- The new index value
-
getCollectionTotal
Gets the collectionTotal attribute of the HistogramForm object- Returns:
- The collectionTotal value
-