HistogramForm (jOAI Java Documentation v3.3)

java.lang.Object
- org.apache.struts.action.ActionForm
- - org.dlese.dpc.dds.action.form.HistogramForm

All Implemented Interfaces:

java.io.Serializable
```
public final class HistogramForm
extends org.apache.struts.action.ActionForm
implements java.io.Serializable
```
A Struts Form bean for handling DDS histogram requests

Author:

Ryan Deardorff

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`collection`
`protected DleseCollectionDocReader`	`collectionDocReader`
`protected java.lang.String`	`collectionMetaName`
`protected java.lang.String`	`currentVocabFramework`
`protected java.lang.String`	`currentVocabGroup`
`protected java.lang.String`	`currentVocabName`
`protected java.lang.String`	`error`
`protected java.lang.String`	`hasCollectionSpecified`
`protected static long`	`histogramIndexModified`
`protected SimpleLuceneIndex`	`index`
`protected int`	`largestTotal`
`protected java.lang.String`	`primaryRecordCollectionDescriptionPage`
`protected RepositoryManager`	`rm`
`protected javax.servlet.ServletContext`	`servletContext`
`protected java.lang.String`	`totalQuery`
`protected MetadataVocab`	`vocab`

Fields inherited from class org.apache.struts.action.ActionForm
multipartRequestHandler, servlet

Constructor Summary

Constructors
Constructor and Description

HistogramForm()
Constructor for the HistogramForm object

Constructors
Constructor and Description
`HistogramForm()` Constructor for the HistogramForm object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DleseCollectionDocReader`	`getCollectionDocReader()` Gets the collectionDocReader attribute of the HistogramForm object
`java.util.ArrayList`	`getCollections()` Gets the collection attribute of the HistogramForm object
`java.util.ArrayList`	`getCollectionsVocab()` This is the OLD way, used by DDS v2.0
`java.lang.String`	`getCollectionTitle()` Gets the collectionTitle attribute of the HistogramForm object
`java.lang.String`	`getCollectionTotal()` Gets the collectionTotal attribute of the HistogramForm object
`java.lang.String`	`getCurrentVocabGroup()` Gets the currentVocabGroup attribute of the HistogramForm object
`java.lang.String`	`getCurrentVocabName()` Gets the currentVocabName attribute of the HistogramForm object
`java.lang.String`	`getError()` Gets the error attribute of the DDSViewResourceForm object
`java.lang.String`	`getHasCollectionSpecified()` Gets the hasCollectionSpecified attribute of the HistogramForm object
`java.lang.String`	`getLargestTotal()` Gets the largestTotal attribute of the HistogramForm object
`java.lang.String`	`getTotal()` Gets the total attribute of the HistogramForm object
`java.util.ArrayList`	`getVocabList()` Gets the vocabList attribute of the HistogramForm object
`java.util.ArrayList`	`hasSubtotalsGreaterThanZero(java.util.ArrayList ret)` Description of the Method
`void`	`resetLargestTotal()` Description of the Method
`void`	`setCollection(java.lang.String collection)` Sets the collection attribute of the HistogramForm object
`void`	`setCollectionDocReader(DocReader collectionDocReader)` Sets the collection attribute of the HistogramForm object
`void`	`setCollectionMetaName(java.lang.String collectionMetaName)` Sets the collectionMetaName attribute of the HistogramForm object
`void`	`setCurrentVocabFramework(java.lang.String currentVocabFramework)` Sets the currentVocabFramework attribute of the HistogramForm object
`void`	`setCurrentVocabGroup(java.lang.String currentVocabGroup)` Sets the currentVocabGroup attribute of the HistogramForm object
`void`	`setCurrentVocabName(java.lang.String currentVocabName)` Sets the currentVocab attribute of the HistogramForm object
`void`	`setError(java.lang.String error)` Sets the error attribute of the DDSViewResourceForm object
`void`	`setHasCollectionSpecified(java.lang.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(javax.servlet.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 java.lang.String error
```
  - hasCollectionSpecified
```
protected java.lang.String hasCollectionSpecified
```
  - primaryRecordCollectionDescriptionPage
```
protected java.lang.String primaryRecordCollectionDescriptionPage
```
  - totalQuery
```
protected java.lang.String totalQuery
```
  - index
```
protected SimpleLuceneIndex index
```
  - rm
```
protected RepositoryManager rm
```
  - collection
```
protected java.lang.String collection
```
  - collectionMetaName
```
protected java.lang.String collectionMetaName
```
  - collectionDocReader
```
protected DleseCollectionDocReader collectionDocReader
```
  - largestTotal
```
protected int largestTotal
```
  - servletContext
```
protected javax.servlet.ServletContext servletContext
```
  - currentVocabName
```
protected java.lang.String currentVocabName
```
  - currentVocabGroup
```
protected java.lang.String currentVocabGroup
```
  - currentVocabFramework
```
protected java.lang.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(javax.servlet.ServletContext servletContext)
```
    Sets the servletContext attribute of the HistogramForm object
    
    Parameters:
    
    servletContext - The new servletContext value
  - setCurrentVocabName
```
public void setCurrentVocabName(java.lang.String currentVocabName)
```
    Sets the currentVocab attribute of the HistogramForm object
    
    Parameters:
    
    currentVocabName - The new currentVocabName value
  - getCurrentVocabName
```
public java.lang.String getCurrentVocabName()
```
    Gets the currentVocabName attribute of the HistogramForm object
    
    Returns:
    
    The currentVocabName value
  - setCurrentVocabGroup
```
public void setCurrentVocabGroup(java.lang.String currentVocabGroup)
```
    Sets the currentVocabGroup attribute of the HistogramForm object
    
    Parameters:
    
    currentVocabGroup - The new currentVocabGroup value
  - getCurrentVocabGroup
```
public java.lang.String getCurrentVocabGroup()
```
    Gets the currentVocabGroup attribute of the HistogramForm object
    
    Returns:
    
    The currentVocabGroup value
  - setCurrentVocabFramework
```
public void setCurrentVocabFramework(java.lang.String currentVocabFramework)
```
    Sets the currentVocabFramework attribute of the HistogramForm object
    
    Parameters:
    
    currentVocabFramework - The new currentVocabFramework value
  - getLargestTotal
```
public java.lang.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(java.lang.String collection)
```
    Sets the collection attribute of the HistogramForm object
    
    Parameters:
    
    collection - The new collection value
  - setCollectionMetaName
```
public void setCollectionMetaName(java.lang.String collectionMetaName)
```
    Sets the collectionMetaName attribute of the HistogramForm object
    
    Parameters:
    
    collectionMetaName - The new collectionMetaName value
  - getCollectionTitle
```
public java.lang.String getCollectionTitle()
```
    Gets the collectionTitle attribute of the HistogramForm object
    
    Returns:
    
    The collectionTitle value
  - setHasCollectionSpecified
```
public void setHasCollectionSpecified(java.lang.String hasCollectionSpecified)
```
    Sets the hasCollectionSpecified attribute of the HistogramForm object
    
    Parameters:
    
    hasCollectionSpecified - The new hasCollectionSpecified value
  - getHasCollectionSpecified
```
public java.lang.String getHasCollectionSpecified()
```
    Gets the hasCollectionSpecified attribute of the HistogramForm object
    
    Returns:
    
    The hasCollectionSpecified value
  - setError
```
public void setError(java.lang.String error)
```
    Sets the error attribute of the DDSViewResourceForm object
    
    Parameters:
    
    error - The new error value
  - getError
```
public java.lang.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 java.util.ArrayList getCollections()
```
    Gets the collection attribute of the HistogramForm object
    
    Returns:
    
    The collection value
  - getVocabList
```
public java.util.ArrayList getVocabList()
```
    Gets the vocabList attribute of the HistogramForm object
    
    Returns:
    
    The vocabList value
  - hasSubtotalsGreaterThanZero
```
public java.util.ArrayList hasSubtotalsGreaterThanZero(java.util.ArrayList ret)
```
    Description of the Method
    
    Parameters:
    
    ret -
    
    Returns:
  - getTotal
```
public java.lang.String getTotal()
```
    Gets the total attribute of the HistogramForm object
    
    Returns:
    
    The total value
  - getCollectionsVocab
```
public java.util.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 java.lang.String getCollectionTotal()
```
    Gets the collectionTotal attribute of the HistogramForm object
    
    Returns:
    
    The collectionTotal value

Class HistogramForm

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

error

hasCollectionSpecified

primaryRecordCollectionDescriptionPage

totalQuery

index

rm

collection

collectionMetaName

collectionDocReader

largestTotal

servletContext

currentVocabName

currentVocabGroup

currentVocabFramework

vocab

histogramIndexModified

Constructor Detail

HistogramForm

Method Detail

setVocab

setServletContext

setCurrentVocabName

getCurrentVocabName

setCurrentVocabGroup

getCurrentVocabGroup

setCurrentVocabFramework

getLargestTotal

resetLargestTotal

setCollection

setCollectionMetaName

getCollectionTitle

setHasCollectionSpecified

getHasCollectionSpecified

setError

getError

setCollectionDocReader

getCollectionDocReader

getCollections

getVocabList

hasSubtotalsGreaterThanZero

getTotal

getCollectionsVocab

setRepositoryManager

setIndex

getCollectionTotal