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

Class DCSAdminForm

java.lang.Object
org.apache.struts.action.ActionForm
org.dlese.dpc.dds.action.form.VocabForm
org.dlese.dpc.repository.action.form.RepositoryForm
org.dlese.dpc.schemedit.action.form.DCSAdminForm
All Implemented Interfaces:
Serializable
public final class DCSAdminForm extends RepositoryForm implements Serializable
This class uses the getter methods of the ProviderBean and then adds setter methods for editable fields.
Author:
John Weatherley, Jonathan Ostwald
See Also:

  • Constructor Details

    • DCSAdminForm

      public DCSAdminForm()
      Constructor for the DCSAdminForm Bean object

  • Method Details

    • getDcsXml

      public String getDcsXml()

    • setDcsXml

      public void setDcsXml(String xml)

    • getDcsId

      public String getDcsId()

    • setDcsId

      public void setDcsId(String id)

    • getSessionBeans

      public List getSessionBeans()

    • setSessionBeans

      public void setSessionBeans(List sessionBeans)

    • getFrameworks

      public Map getFrameworks()

    • setFrameworks

      public void setFrameworks(Map map)

    • setUnloadedFrameworks

      public void setUnloadedFrameworks(List formats)

    • getUnloadedFrameworks

      public List getUnloadedFrameworks()

    • getCollectionPrefix

      public String getCollectionPrefix()

    • setCollectionPrefix

      public void setCollectionPrefix(String prefix)

    • getCollectionKey

      public String getCollectionKey()

    • setCollectionKey

      public void setCollectionKey(String key)

    • getTrustedWsIps

      public String getTrustedWsIps()

    • setTrustedWsIps

      public void setTrustedWsIps(String val)

    • getMetadataGroupsLoaderFile

      public String getMetadataGroupsLoaderFile()

    • setLockedRecords

      public void setLockedRecords(Map lockedRecords)

    • getLockedRecords

      public Map getLockedRecords()

    • getNumIdentifiersResults

      public String getNumIdentifiersResults()
      Gets the numIdentifiersResults attribute of the DCSAdminForm object
      Returns:
      The numIdentifiersResults value

    • setNumIdentifiersResults

      public void setNumIdentifiersResults(String numResults)
      Sets the numIdentifiersResults attribute of the DCSAdminForm object
      Parameters:
      numResults - The new numIdentifiersResults value

    • getNumRecordsResults

      public String getNumRecordsResults()
      Gets the numRecordsResults attribute of the DCSAdminForm object
      Returns:
      The numRecordsResults value

    • setNumRecordsResults

      public void setNumRecordsResults(String numResults)
      Sets the numRecordsResults attribute of the DCSAdminForm object
      Parameters:
      numResults - The new numRecordsResults value

    • getUpdateFrequency

      public String getUpdateFrequency()
      Gets the frequency by which the index is updated to reflect changes that occur in the metadata files. A return of 0 indicates no automatic updating occurs.
      Returns:
      The updateFrequency, in minutes.

    • setUpdateFrequency

      public void setUpdateFrequency(int frequency)
      Sets the frequency by which the index is updated to reflect changes that occur in the metadata files. A return of 0 indicates no automatic updating occurs.
      Parameters:
      frequency - The new updateFrequency, in minutes.

    • getIndexingStartDate

      public String getIndexingStartDate()
      Gets the date and time the indexer is/was scheduled to start, for example 'Dec 2, 2003 1:35 AM MST'.
      Returns:
      The date and time the indexer is scheduled to start, or empty String if not available.

    • getIndexingTimeOfDay

      public String getIndexingTimeOfDay()
      Gets the time of day the indexer isscheduled to start, for example '1:35 AM MST'.
      Returns:
      the time of day the indexer isscheduled to start, or empty String if not available.

    • setIndexingStartTime

      public void setIndexingStartTime(Date indexingStartTime)
      Sets the date and time the indexer is/was scheduled to start.
      Parameters:
      indexingStartTime - The new indexingStartTime value

    • setNumIndexingErrors

      public void setNumIndexingErrors(int numErrors)
      Sets the number of indexing errors that are present.
      Parameters:
      numErrors - The number of indexing errors that are present.

    • getNumIndexingErrors

      public String getNumIndexingErrors()
      Gets the number of indexing errors that are present. A value of -1 means no data is available.
      Returns:
      numErrors The number of indexing errors that are present.

    • getRemoveInvalidRecords

      public String getRemoveInvalidRecords()
      Gets the removeInvalidRecords attribute of the DCSAdminForm object
      Returns:
      The removeInvalidRecords value

    • getValidateRecords

      public String getValidateRecords()
      Gets the validateRecords attribute of the DCSAdminForm object
      Returns:
      The validateRecords value

    • setRepositoryName

      public void setRepositoryName(String name)
      Sets the repositoryName attribute of the DCSAdminForm object
      Parameters:
      name - The new repositoryName value

    • setRepositoryIdentifier

      public void setRepositoryIdentifier(String value)
      Sets the repositoryIdentifier attribute of the DCSAdminForm object
      Parameters:
      value - The new repositoryIdentifier value

    • getRepositoryIdentifier

      public String getRepositoryIdentifier()
      Gets the repositoryIdentifier attribute of the DCSAdminForm object
      Overrides:
      getRepositoryIdentifier in class RepositoryForm
      Returns:
      The repositoryIdentifier value

    • setCurrentAdminEmail

      public void setCurrentAdminEmail(String value)
      Sets the currentAdminEmail attribute of the DCSAdminForm object
      Parameters:
      value - The new currentAdminEmail value

    • getCurrentAdminEmail

      public String getCurrentAdminEmail()
      Gets the currentAdminEmail attribute of the DCSAdminForm object
      Returns:
      The currentAdminEmail value

    • getExampleId

      public String getExampleId()
      Gets the exampleId attribute of the DCSAdminForm object
      Returns:
      The exampleId value

    • setCurrentDescription

      public void setCurrentDescription(String value)
      Sets the currentDescription attribute of the DCSAdminForm object
      Parameters:
      value - The new currentDescription value

    • getCurrentDescription

      public String getCurrentDescription()
      Gets the currentDescription attribute of the DCSAdminForm object
      Returns:
      The currentDescription value

    • setAdd

      public void setAdd(String value)
      Sets the add attribute of the DCSAdminForm object
      Parameters:
      value - The new add value

    • getAdd

      public String getAdd()
      Gets the add attribute of the DCSAdminForm object
      Returns:
      The add value

    • setMetadataRecordsLocation

      public void setMetadataRecordsLocation(String metadataRecordsLocation)
      Sets the absolute path to the metadataRecordsLocation.
      Parameters:
      metadataRecordsLocation - The absolute path to a directory containing item-level metadata. All metadata files must reside in sub-directores by format and collection, for example: metadataRecordsLocation + /adn/dcc/DLESE-000-000-000-001.xml.

    • setCollectionRecordsLocation

      public void setCollectionRecordsLocation(String collectionRecordsLocation)
      Sets the absolute path to the collectionRecordsLocation.
      Parameters:
      collectionRecordsLocation - The absolute path to a directory of DLESE collection-level XML records.

    • getCollectionRecordsLocation

      public String getCollectionRecordsLocation()
      Gets the path for the directory of collect-level records the RepositoryManager is using, or empty string if none is configured.
      Returns:
      The collectionRecordsLocation value

    • getMetadataRecordsLocation

      public String getMetadataRecordsLocation()
      Gets the path for the directory of metadata records the RepositoryManager is using, or empty string if none is configured.
      Returns:
      The metadataRecordsLocation value

    • setCurrentSetDescription

      public void setCurrentSetDescription(String value)
      Sets the currentSetDescription attribute of the DCSAdminForm object
      Parameters:
      value - The new currentSetDescription value

    • getCurrentSetDescription

      public String getCurrentSetDescription()
      Gets the currentSetDescription attribute of the DCSAdminForm object
      Returns:
      The currentSetDescription value

    • setCurrentSetName

      public void setCurrentSetName(String value)
      Sets the currentSetName attribute of the DCSAdminForm object
      Parameters:
      value - The new currentSetName value

    • getCurrentSetName

      public String getCurrentSetName()
      Gets the currentSetName attribute of the DCSAdminForm object
      Returns:
      The currentSetName value

    • setCurrentSetSpec

      public void setCurrentSetSpec(String value)
      Sets the currentSetSpec attribute of the DCSAdminForm object
      Parameters:
      value - The new currentSetSpec value

    • getCurrentSetSpec

      public String getCurrentSetSpec()
      Gets the currentSetSpec attribute of the DCSAdminForm object
      Returns:
      The currentSetSpec value

    • setCurrentSetDirectory

      public void setCurrentSetDirectory(String value)
      Sets the currentSetDirectory attribute of the DCSAdminForm object
      Parameters:
      value - The new currentSetDirectory value

    • getCurrentSetDirectory

      public String getCurrentSetDirectory()
      Gets the currentSetDirectory attribute of the DCSAdminForm object
      Returns:
      The currentSetDirectory value

    • getSortSetsBy

      public String getSortSetsBy()
      Gets the sortSetsBy attribute of the DCSAdminForm object
      Returns:
      The sortSetsBy value

    • setSortSetsBy

      public void setSortSetsBy(String sortSetsBy)
      Sets the sortSetsBy attribute of the DCSAdminForm object
      Parameters:
      sortSetsBy - The new sortSetsBy value

    • getSets

      public ArrayList getSets()
      Gets the sets configured in the RepositoryManager. Overloaded method from RepositoryForm.
      Overrides:
      getSets in class RepositoryForm
      Returns:
      The sets value

    • setSets

      public void setSets(ArrayList setInfos)
      Sets the sets attribute of the DCSAdminForm object
      Parameters:
      sets - The new sets value

    • setCurrentSetFormat

      public void setCurrentSetFormat(String value)
      Sets the currentSetFormat attribute of the DCSAdminForm object
      Parameters:
      value - The new currentSetFormat value

    • getCurrentSetFormat

      public String getCurrentSetFormat()
      Gets the currentSetFormat attribute of the DCSAdminForm object
      Returns:
      The currentSetFormat value

    • setDrcBoostFactor

      public void setDrcBoostFactor(String boostFactor)
      Sets the boosting factor used to rank items in the DRC. Value must be zero or greater.
      Parameters:
      boostFactor - The new boosting factor used to rank items in the DRC.

    • setMultiDocBoostFactor

      public void setMultiDocBoostFactor(String boostFactor)
      Sets the boosting factor used to rank resources that have multiple records.
      Parameters:
      boostFactor - The boosting factor used to rank resources that have multiple records.

    • setTitleBoostFactor

      public void setTitleBoostFactor(String boostFactor)
      Sets the boosting factor used to rank items with matching terms in the title field. Value must be zero or greater.
      Parameters:
      boostFactor - The boosting factor used to rank items with matching terms in the title field.

    • setStemmingEnabled

      public void setStemmingEnabled(String stemmingEnabled)
      Sets whether stemming support is enabled.
      Parameters:
      stemmingEnabled - The new stemmingEnabled value

    • setStemmingBoostFactor

      public void setStemmingBoostFactor(String boostFactor)
      Sets the boosting factor used to rank items with matching stemmed terms. Value must be zero or greater.
      Parameters:
      boostFactor - The boosting factor used to rank items with matching stemmed terms.

    • getStemmingBoostFactor

      public String getStemmingBoostFactor()
      Gets the boosting factor used to rank items with matching stemmed terms.
      Returns:
      The boosting factor used to rank items with matching stemmed terms.

    • getDrcBoostFactor

      public String getDrcBoostFactor()
      Gets the boosting factor used to rank items in the DRC.
      Returns:
      The boosting factor used to rank items in the DRC.

    • getMultiDocBoostFactor

      public String getMultiDocBoostFactor()
      Gets the boosting factor used to rank resources that have multiple records.
      Returns:
      The boosting factor used to rank resources that have multiple records.

    • getTitleBoostFactor

      public String getTitleBoostFactor()
      Gets the titleBoostFactor attribute of the DCSAdminForm object
      Returns:
      The titleBoostFactor value

    • getStemmingEnabled

      public String getStemmingEnabled()
      Indicates whether stemming support is enabled.
      Returns:
      true if stemming is enabled, false otherwise.

    • setMessage

      public void setMessage(String message)
      Sets the message attribute of the DCSAdminForm object
      Parameters:
      message - The new message value

    • getMessage

      public String getMessage()
      Gets the message attribute of the DCSAdminForm object
      Returns:
      The message value

    • setXmlError

      public void setXmlError(String xmlError)
      Sets the xmlError attribute of the DCSAdminForm object
      Parameters:
      xmlError - The new xmlError value

    • getXmlError

      public String getXmlError()
      Gets the xmlError attribute of the DCSAdminForm object
      Returns:
      The xmlError value

    • getCollectionsBaseDir

      public String getCollectionsBaseDir()
      Grabs the base directory where collections metadata files are located, or null if not configured.
      Returns:
      Base directory where the collections reside.

    • getValidCollectionKeys

      public ArrayList getValidCollectionKeys()
      Grabs the collection keys from the DPC keys schema.
      Returns:
      A list of valid colleciton keys.

    • getValidMetadataFormats

      public ArrayList getValidMetadataFormats()
      Grabs the valid metadata formats from the DPC schema.
      Returns:
      A list of valid metadata formats.

    • validate

      public org.apache.struts.action.ActionErrors validate(org.apache.struts.action.ActionMapping mapping, HttpServletRequest request)
      Validate the input. This method is called AFTER the setter method is called.
      Overrides:
      validate in class org.apache.struts.action.ActionForm
      Parameters:
      mapping - The ActionMapping used.
      request - The HttpServletRequest for this request.
      Returns:
      An ActionError containin any errors that had occured.