org.dlese.dpc.repository.action.form
Class RepositoryAdminForm

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.repository.action.form.RepositoryAdminForm

All Implemented Interfaces:

Serializable

public final class RepositoryAdminForm
extends RepositoryForm
implements Serializable

This class uses the getter methods of the ProviderBean and then adds setter methods for editable fields.

Version:

$Id: RepositoryAdminForm.java,v 1.27 2010/03/16 21:42:01 jweather Exp $

Author:

John Weatherley

See Also:

Serialized Form

Field Summary

Fields inherited from class org.dlese.dpc.repository.action.form.RepositoryForm

compressions, deletedRecord, earliestDatestamp, exampleID, granularity, metadataFormats, properties, ProtocolVersion, providerStatus, record

Fields inherited from class org.dlese.dpc.dds.action.form.VocabForm

audience, field, language, metaFormat, value, vocab

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

multipartRequestHandler, servlet

Constructor Summary

RepositoryAdminForm()
Constructor for the RepositoryAdminForm Bean object

Method Summary

String	getAdd() Gets the add attribute of the RepositoryAdminForm object
String	getCollectionRecordsLocation() Gets the path for the directory of collect-level records the RepositoryManager is using, or empty string if none is configured.
String	getCollectionsBaseDir() Grabs the base directory where collections metadata files are located, or null if not configured.
String	getCommand() Gets the command attribute of the RepositoryAdminForm object
String	getConfigDirLocation() Gets the path to the RepositoryManager config directory.
String	getCurrentAdminEmail() Gets the currentAdminEmail attribute of the RepositoryAdminForm object
String	getCurrentDescription() Gets the currentDescription attribute of the RepositoryAdminForm object
String	getCurrentSetDescription() Gets the currentSetDescription attribute of the RepositoryAdminForm object
String	getCurrentSetDirectory() Gets the currentSetDirectory attribute of the RepositoryAdminForm object
String	getCurrentSetFormat() Gets the currentSetFormat attribute of the RepositoryAdminForm object
String	getCurrentSetName() Gets the currentSetName attribute of the RepositoryAdminForm object
String	getCurrentSetSpec() Gets the currentSetSpec attribute of the RepositoryAdminForm object
String	getDrcBoostFactor() Gets the boosting factor used to rank items in the DRC.
String	getExampleId() Gets the exampleId attribute of the RepositoryAdminForm object
String	getIndexingDaysOfWeek() Gets the days of the week the indexer will run, as a String.
String	getIndexingStartDate() Gets the date and time the indexer is/was scheduled to start, for example 'Dec 2, 2003 1:35 AM MST'.
String	getIndexingTimeOfDay() Gets the time of day the indexer isscheduled to start, for example '1:35 AM MST'.
String	getMessage() Gets the message attribute of the RepositoryAdminForm object
String	getMetadataRecordsLocation() Gets the path for the directory of metadata records the RepositoryManager is using, or empty string if none is configured.
String	getMultiDocBoostFactor() Gets the boosting factor used to rank resources that have multiple records.
String	getNumIdentifiersResults() Gets the numIdentifiersResults attribute of the RepositoryAdminForm object
String	getNumIndexingErrors() Gets the number of indexing errors that are present.
String	getNumRecordsResults() Gets the numRecordsResults attribute of the RepositoryAdminForm object
String	getRemoveInvalidRecords() Gets the removeInvalidRecords attribute of the RepositoryAdminForm object
String	getRepositoryDataDir() Get the directory where the repository persistent data and certain configs resides, including the collections configs, specified by the init param repositoryData.
String	getRepositoryIdentifier() Gets the repositoryIdentifier attribute of the RepositoryAdminForm object
ArrayList	getSets() Gets the sets configured in the RepositoryManager.
String	getSortSetsBy() Gets the sortSetsBy attribute of the RepositoryAdminForm object
String	getStemmingBoostFactor() Gets the boosting factor used to rank items with matching stemmed terms.
String	getStemmingEnabled() Indicates whether stemming support is enabled.
String	getTitleBoostFactor() Gets the titleBoostFactor attribute of the RepositoryAdminForm object
String	getTrustedWsIps() Gets the trustedWsIps attribute of the RepositoryAdminForm object
String	getUpdateFrequency() Gets the frequency by which the index is updated to reflect changes that occur in the metadata files.
String	getValidateRecords() Gets the validateRecords attribute of the RepositoryAdminForm object
ArrayList	getValidCollectionKeys() Grabs the collection keys from the DPC keys schema.
ArrayList	getValidMetadataFormats() Grabs the valid metadata formats from the DPC schema.
String	getXmlError() Gets the xmlError attribute of the RepositoryAdminForm object
void	reset(org.apache.struts.action.ActionMapping mapping, HttpServletRequest request) Reset bean properties to their default state, as needed.
void	setAdd(String value) Sets the add attribute of the RepositoryAdminForm object
void	setCollectionRecordsLocation(String collectionRecordsLocation) Sets the absolute path to the collectionRecordsLocation.
void	setCommand(String command) Sets the command attribute of the RepositoryAdminForm object
void	setCurrentAdminEmail(String value) Sets the currentAdminEmail attribute of the RepositoryAdminForm object
void	setCurrentDescription(String value) Sets the currentDescription attribute of the RepositoryAdminForm object
void	setCurrentSetDescription(String value) Sets the currentSetDescription attribute of the RepositoryAdminForm object
void	setCurrentSetDirectory(String value) Sets the currentSetDirectory attribute of the RepositoryAdminForm object
void	setCurrentSetFormat(String value) Sets the currentSetFormat attribute of the RepositoryAdminForm object
void	setCurrentSetName(String value) Sets the currentSetName attribute of the RepositoryAdminForm object
void	setCurrentSetSpec(String value) Sets the currentSetSpec attribute of the RepositoryAdminForm object
void	setDrcBoostFactor(String boostFactor) Sets the boosting factor used to rank items in the DRC.
void	setIdexingDaysOfWeek(int[] daysOfWeek) Sets the idexingDaysOfWeek as an array of Calendar.DAY_OF_WEEK fields, or null if none.
void	setIndexingStartTime(Date indexingStartTime) Sets the date and time the indexer is/was scheduled to start.
void	setMessage(String message) Sets the message attribute of the RepositoryAdminForm object
void	setMetadataRecordsLocation(String metadataRecordsLocation) Sets the absolute path to the metadataRecordsLocation.
void	setMultiDocBoostFactor(String boostFactor) Sets the boosting factor used to rank resources that have multiple records.
void	setNumIdentifiersResults(String numResults) Sets the numIdentifiersResults attribute of the RepositoryAdminForm object
void	setNumIndexingErrors(int numErrors) Sets the number of indexing errors that are present.
void	setNumRecordsResults(String numResults) Sets the numRecordsResults attribute of the RepositoryAdminForm object
void	setRepositoryIdentifier(String value) Sets the repositoryIdentifier attribute of the RepositoryAdminForm object
void	setRepositoryName(String name) Sets the repositoryName attribute of the RepositoryAdminForm object
void	setSets(ArrayList sets) Sets the sets attribute of the RepositoryAdminForm object
void	setSortSetsBy(String sortSetsBy) Sets the sortSetsBy attribute of the RepositoryAdminForm object
void	setStemmingBoostFactor(String boostFactor) Sets the boosting factor used to rank items with matching stemmed terms.
void	setStemmingEnabled(String stemmingEnabled) Sets whether stemming support is enabled.
void	setTitleBoostFactor(String boostFactor) Sets the boosting factor used to rank items with matching terms in the title field.
void	setTrustedWsIps(String val) Sets the trustedWsIps attribute of the RepositoryAdminForm object
void	setUpdateFrequency(int frequency) Sets the frequency by which the index is updated to reflect changes that occur in the metadata files.
void	setXmlError(String xmlError) Sets the xmlError attribute of the RepositoryAdminForm object
org.apache.struts.action.ActionErrors	validate(org.apache.struts.action.ActionMapping mapping, HttpServletRequest request) Validate the input.

Methods inherited from class org.dlese.dpc.repository.action.form.RepositoryForm

addOaiError, getAdminEmails, getBaseURL, getCompressions, getDatestamp, getDeletedRecord, getDeletedStatus, getDescriptions, getDs, getEarliestDatestamp, getErrors, getExampleID, getGranularity, getIdentifier, getMetadataFormats, getMetadataNamespaces, getMetadataSchemaURLs, getNumDeletedDocs, getNumNonDeletedDocs, getOaiIdPfx, getOAIRequestTag, getProtocolVersion, getProviderStatus, getRecord, getRepositoryName, getRequestedFormat, getResults, getResultsLength, getResultsOffset, getResumptionToken, getRootCloseTag, getRootOpenTag, getSetSpecs, getXMLDeclaration, hasErrors, prtln, prtlnErr, setBaseURL, setDatestamp, setDebug, setDeletedStatus, setIdentifier, setMetadataFormats, setOaiIdPfx, setRecord, setRequestedFormat, setResults, setResultsLength, setResultsOffset, setResumptionToken, setSetSpecs, xmlToHtml

Methods inherited from class org.dlese.dpc.dds.action.form.VocabForm

getAudience, getField, getFieldId, getFieldLabel, getIsVocabTermAvailable, getLanguage, getVocab, getVocabList, getVocabList, getVocabTerm, setField, setField, setMetaFormat, setValue, setVocab, setVocabInterface

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

getMultipartRequestHandler, getServlet, getServletWrapper, reset, setMultipartRequestHandler, setServlet, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RepositoryAdminForm

public RepositoryAdminForm()

Constructor for the RepositoryAdminForm Bean object

Method Detail

getCommand

public String getCommand()

Gets the command attribute of the RepositoryAdminForm object

Returns:

The command value

setCommand

public void setCommand(String command)

Sets the command attribute of the RepositoryAdminForm object

Parameters:

command - The new command value

getTrustedWsIps

public String getTrustedWsIps()

Gets the trustedWsIps attribute of the RepositoryAdminForm object

Returns:

The trustedWsIps value

setTrustedWsIps

public void setTrustedWsIps(String val)

Sets the trustedWsIps attribute of the RepositoryAdminForm object

Parameters:

val - The new trustedWsIps value

getNumIdentifiersResults

public String getNumIdentifiersResults()

Gets the numIdentifiersResults attribute of the RepositoryAdminForm object

Returns:

The numIdentifiersResults value

setNumIdentifiersResults

public void setNumIdentifiersResults(String numResults)

Sets the numIdentifiersResults attribute of the RepositoryAdminForm object

Parameters:

numResults - The new numIdentifiersResults value

getNumRecordsResults

public String getNumRecordsResults()

Gets the numRecordsResults attribute of the RepositoryAdminForm object

Returns:

The numRecordsResults value

setNumRecordsResults

public void setNumRecordsResults(String numResults)

Sets the numRecordsResults attribute of the RepositoryAdminForm 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

getIndexingDaysOfWeek

public String getIndexingDaysOfWeek()

Gets the days of the week the indexer will run, as a String.

Returns:

The indexingDaysOfWeek value

setIdexingDaysOfWeek

public void setIdexingDaysOfWeek(int[] daysOfWeek)

Sets the idexingDaysOfWeek as an array of Calendar.DAY_OF_WEEK fields, or null if none.

Parameters:

daysOfWeek - The new idexingDaysOfWeek 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 RepositoryAdminForm object

Returns:

The removeInvalidRecords value

getValidateRecords

public String getValidateRecords()

Gets the validateRecords attribute of the RepositoryAdminForm object

Returns:

The validateRecords value

setRepositoryName

public void setRepositoryName(String name)

Sets the repositoryName attribute of the RepositoryAdminForm object

Parameters:

name - The new repositoryName value

setRepositoryIdentifier

public void setRepositoryIdentifier(String value)

Sets the repositoryIdentifier attribute of the RepositoryAdminForm object

Parameters:

value - The new repositoryIdentifier value

getRepositoryIdentifier

public String getRepositoryIdentifier()

Gets the repositoryIdentifier attribute of the RepositoryAdminForm object

Overrides:

getRepositoryIdentifier in class RepositoryForm

Returns:

The repositoryIdentifier value

setCurrentAdminEmail

public void setCurrentAdminEmail(String value)

Sets the currentAdminEmail attribute of the RepositoryAdminForm object

Parameters:

value - The new currentAdminEmail value

getCurrentAdminEmail

public String getCurrentAdminEmail()

Gets the currentAdminEmail attribute of the RepositoryAdminForm object

Returns:

The currentAdminEmail value

getExampleId

public String getExampleId()

Gets the exampleId attribute of the RepositoryAdminForm object

Returns:

The exampleId value

setCurrentDescription

public void setCurrentDescription(String value)

Sets the currentDescription attribute of the RepositoryAdminForm object

Parameters:

value - The new currentDescription value

getCurrentDescription

public String getCurrentDescription()

Gets the currentDescription attribute of the RepositoryAdminForm object

Returns:

The currentDescription value

setAdd

public void setAdd(String value)

Sets the add attribute of the RepositoryAdminForm object

Parameters:

value - The new add value

getAdd

public String getAdd()

Gets the add attribute of the RepositoryAdminForm 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

getConfigDirLocation

public String getConfigDirLocation()

Gets the path to the RepositoryManager config directory.

Returns:

The RepositoryManager config dir.

getRepositoryDataDir

public String getRepositoryDataDir()

Get the directory where the repository persistent data and certain configs resides, including the collections configs, specified by the init param repositoryData.

Returns:

The directory where the repository data and certain configs resides.

setCurrentSetDescription

public void setCurrentSetDescription(String value)

Sets the currentSetDescription attribute of the RepositoryAdminForm object

Parameters:

value - The new currentSetDescription value

getCurrentSetDescription

public String getCurrentSetDescription()

Gets the currentSetDescription attribute of the RepositoryAdminForm object

Returns:

The currentSetDescription value

setCurrentSetName

public void setCurrentSetName(String value)

Sets the currentSetName attribute of the RepositoryAdminForm object

Parameters:

value - The new currentSetName value

getCurrentSetName

public String getCurrentSetName()

Gets the currentSetName attribute of the RepositoryAdminForm object

Returns:

The currentSetName value

setCurrentSetSpec

public void setCurrentSetSpec(String value)

Sets the currentSetSpec attribute of the RepositoryAdminForm object

Parameters:

value - The new currentSetSpec value

getCurrentSetSpec

public String getCurrentSetSpec()

Gets the currentSetSpec attribute of the RepositoryAdminForm object

Returns:

The currentSetSpec value

setCurrentSetDirectory

public void setCurrentSetDirectory(String value)

Sets the currentSetDirectory attribute of the RepositoryAdminForm object

Parameters:

value - The new currentSetDirectory value

getCurrentSetDirectory

public String getCurrentSetDirectory()

Gets the currentSetDirectory attribute of the RepositoryAdminForm object

Returns:

The currentSetDirectory value

getSortSetsBy

public String getSortSetsBy()

Gets the sortSetsBy attribute of the RepositoryAdminForm object

Returns:

The sortSetsBy value

setSortSetsBy

public void setSortSetsBy(String sortSetsBy)

Sets the sortSetsBy attribute of the RepositoryAdminForm 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 sets)

Sets the sets attribute of the RepositoryAdminForm object

Parameters:

sets - The new sets value

setCurrentSetFormat

public void setCurrentSetFormat(String value)

Sets the currentSetFormat attribute of the RepositoryAdminForm object

Parameters:

value - The new currentSetFormat value

getCurrentSetFormat

public String getCurrentSetFormat()

Gets the currentSetFormat attribute of the RepositoryAdminForm 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 RepositoryAdminForm 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 RepositoryAdminForm object

Parameters:

message - The new message value

getMessage

public String getMessage()

Gets the message attribute of the RepositoryAdminForm object

Returns:

The message value

setXmlError

public void setXmlError(String xmlError)

Sets the xmlError attribute of the RepositoryAdminForm object

Parameters:

xmlError - The new xmlError value

getXmlError

public String getXmlError()

Gets the xmlError attribute of the RepositoryAdminForm 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.

reset

public void reset(org.apache.struts.action.ActionMapping mapping,
                  HttpServletRequest request)

Reset bean properties to their default state, as needed.

Overrides:

reset in class org.apache.struts.action.ActionForm

Parameters:

mapping - The ActionMapping being used

request - The HttpServletRequest

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.