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:

Serialized Form

Field Summary

protected String	collection
protected DleseCollectionDocReader	collectionDocReader
protected String	collectionMetaName
protected String	currentVocabFramework
protected String	currentVocabGroup
protected String	currentVocabName
protected String	error
protected String	hasCollectionSpecified
protected static long	histogramIndexModified
protected SimpleLuceneIndex	index
protected int	largestTotal
protected String	primaryRecordCollectionDescriptionPage
protected RepositoryManager	rm
protected ServletContext	servletContext
protected String	totalQuery
protected MetadataVocab	vocab

Fields inherited from class org.apache.struts.action.ActionForm

multipartRequestHandler, servlet

Constructor Summary

HistogramForm()
Constructor for the HistogramForm object

Method Summary

DleseCollectionDocReader	getCollectionDocReader() Gets the collectionDocReader attribute of the HistogramForm object
ArrayList	getCollections() Gets the collection attribute of the HistogramForm object
ArrayList	getCollectionsVocab() This is the OLD way, used by DDS v2.0
String	getCollectionTitle() Gets the collectionTitle attribute of the HistogramForm object
String	getCollectionTotal() Gets the collectionTotal attribute of the HistogramForm object
String	getCurrentVocabGroup() Gets the currentVocabGroup attribute of the HistogramForm object
String	getCurrentVocabName() Gets the currentVocabName attribute of the HistogramForm object
String	getError() Gets the error attribute of the DDSViewResourceForm object
String	getHasCollectionSpecified() Gets the hasCollectionSpecified attribute of the HistogramForm object
String	getLargestTotal() Gets the largestTotal attribute of the HistogramForm object
String	getTotal() Gets the total attribute of the HistogramForm object
ArrayList	getVocabList() Gets the vocabList attribute of the HistogramForm object
ArrayList	hasSubtotalsGreaterThanZero(ArrayList ret) Description of the Method
void	resetLargestTotal() Description of the Method
void	setCollection(String collection) Sets the collection attribute of the HistogramForm object
void	setCollectionDocReader(DocReader collectionDocReader) Sets the collection attribute of the HistogramForm object
void	setCollectionMetaName(String collectionMetaName) Sets the collectionMetaName attribute of the HistogramForm object
void	setCurrentVocabFramework(String currentVocabFramework) Sets the currentVocabFramework attribute of the HistogramForm object
void	setCurrentVocabGroup(String currentVocabGroup) Sets the currentVocabGroup attribute of the HistogramForm object
void	setCurrentVocabName(String currentVocabName) Sets the currentVocab attribute of the HistogramForm object
void	setError(String error) Sets the error attribute of the DDSViewResourceForm object
void	setHasCollectionSpecified(String hasCollectionSpecified) Sets the hasCollectionSpecified attribute of the HistogramForm object
void	setIndex(SimpleLuceneIndex index) Sets the index attribute of the HistogramForm object
void	setRepositoryManager(RepositoryManager rm) Sets the repositoryManager attribute of the HistogramForm object
void	setServletContext(ServletContext servletContext) Sets the servletContext attribute of the HistogramForm object
void	setVocab(MetadataVocab vocab) Sets the vocab attribute of the VocabCachingActionForm 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

Field Detail

error

protected String error

hasCollectionSpecified

protected String hasCollectionSpecified

primaryRecordCollectionDescriptionPage

protected String primaryRecordCollectionDescriptionPage

totalQuery

protected String totalQuery

index

protected SimpleLuceneIndex index

rm

protected RepositoryManager rm

collection

protected String collection

collectionMetaName

protected String collectionMetaName

collectionDocReader

protected DleseCollectionDocReader collectionDocReader

largestTotal

protected int largestTotal

servletContext

protected ServletContext servletContext

currentVocabName

protected String currentVocabName

currentVocabGroup

protected String currentVocabGroup

currentVocabFramework

protected String currentVocabFramework

vocab

protected MetadataVocab vocab

histogramIndexModified

protected static long histogramIndexModified

Constructor Detail

HistogramForm

public HistogramForm()

Constructor for the HistogramForm object

Method Detail

setVocab

public void setVocab(MetadataVocab vocab)

Sets the vocab attribute of the VocabCachingActionForm object

Parameters:

vocab - The new vocab value

setServletContext

public void setServletContext(ServletContext servletContext)

Sets the servletContext attribute of the HistogramForm object

Parameters:

servletContext - The new servletContext value

setCurrentVocabName

public void setCurrentVocabName(String currentVocabName)

Sets the currentVocab attribute of the HistogramForm object

Parameters:

currentVocabName - The new currentVocabName value

getCurrentVocabName

public String getCurrentVocabName()

Gets the currentVocabName attribute of the HistogramForm object

Returns:

The currentVocabName value

setCurrentVocabGroup

public void setCurrentVocabGroup(String currentVocabGroup)

Sets the currentVocabGroup attribute of the HistogramForm object

Parameters:

currentVocabGroup - The new currentVocabGroup value

getCurrentVocabGroup

public String getCurrentVocabGroup()

Gets the currentVocabGroup attribute of the HistogramForm object

Returns:

The currentVocabGroup value

setCurrentVocabFramework

public void setCurrentVocabFramework(String currentVocabFramework)

Sets the currentVocabFramework attribute of the HistogramForm object

Parameters:

currentVocabFramework - The new currentVocabFramework value

getLargestTotal

public String getLargestTotal()

Gets the largestTotal attribute of the HistogramForm object

Returns:

The largestTotal value

resetLargestTotal

public void resetLargestTotal()

Description of the Method

setCollection

public void setCollection(String collection)

Sets the collection attribute of the HistogramForm object

Parameters:

collection - The new collection value

setCollectionMetaName

public void setCollectionMetaName(String collectionMetaName)

Sets the collectionMetaName attribute of the HistogramForm object

Parameters:

collectionMetaName - The new collectionMetaName value

getCollectionTitle

public String getCollectionTitle()

Gets the collectionTitle attribute of the HistogramForm object

Returns:

The collectionTitle value

setHasCollectionSpecified

public void setHasCollectionSpecified(String hasCollectionSpecified)

Sets the hasCollectionSpecified attribute of the HistogramForm object

Parameters:

hasCollectionSpecified - The new hasCollectionSpecified value

getHasCollectionSpecified

public String getHasCollectionSpecified()

Gets the hasCollectionSpecified attribute of the HistogramForm object

Returns:

The hasCollectionSpecified value

setError

public void setError(String error)

Sets the error attribute of the DDSViewResourceForm object

Parameters:

error - The new error value

getError

public String getError()

Gets the error attribute of the DDSViewResourceForm object

Returns:

The error value

setCollectionDocReader

public void setCollectionDocReader(DocReader collectionDocReader)

Sets the collection attribute of the HistogramForm object

Parameters:

collectionDocReader - The new collectionResultDoc value

getCollectionDocReader

public DleseCollectionDocReader getCollectionDocReader()

Gets the collectionDocReader attribute of the HistogramForm object

Returns:

The collectionDocReader value

getCollections

public ArrayList getCollections()

Gets the collection attribute of the HistogramForm object

Returns:

The collection value

getVocabList

public ArrayList getVocabList()

Gets the vocabList attribute of the HistogramForm object

Returns:

The vocabList value

hasSubtotalsGreaterThanZero

public ArrayList hasSubtotalsGreaterThanZero(ArrayList ret)

Description of the Method

Parameters:

ret -

Returns:

getTotal

public String getTotal()

Gets the total attribute of the HistogramForm object

Returns:

The total value

getCollectionsVocab

public ArrayList getCollectionsVocab()

This is the OLD way, used by DDS v2.0

Returns:

The collectionsVocab value

setRepositoryManager

public void setRepositoryManager(RepositoryManager rm)

Sets the repositoryManager attribute of the HistogramForm object

Parameters:

rm - The new repositoryManager value

setIndex

public void setIndex(SimpleLuceneIndex index)

Sets the index attribute of the HistogramForm object

Parameters:

index - The new index value

getCollectionTotal

public String getCollectionTotal()

Gets the collectionTotal attribute of the HistogramForm object

Returns:

The collectionTotal value