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:

java.io.Serializable

public final class DCSAdminForm
extends RepositoryForm
implements java.io.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:

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

Constructors

Constructor and Description
DCSAdminForm() Constructor for the DCSAdminForm Bean object

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAdd() Gets the add attribute of the DCSAdminForm object
java.lang.String	getCollectionKey()
java.lang.String	getCollectionPrefix()
java.lang.String	getCollectionRecordsLocation() Gets the path for the directory of collect-level records the RepositoryManager is using, or empty string if none is configured.
java.lang.String	getCollectionsBaseDir() Grabs the base directory where collections metadata files are located, or null if not configured.
java.lang.String	getCurrentAdminEmail() Gets the currentAdminEmail attribute of the DCSAdminForm object
java.lang.String	getCurrentDescription() Gets the currentDescription attribute of the DCSAdminForm object
java.lang.String	getCurrentSetDescription() Gets the currentSetDescription attribute of the DCSAdminForm object
java.lang.String	getCurrentSetDirectory() Gets the currentSetDirectory attribute of the DCSAdminForm object
java.lang.String	getCurrentSetFormat() Gets the currentSetFormat attribute of the DCSAdminForm object
java.lang.String	getCurrentSetName() Gets the currentSetName attribute of the DCSAdminForm object
java.lang.String	getCurrentSetSpec() Gets the currentSetSpec attribute of the DCSAdminForm object
java.lang.String	getDcsId()
java.lang.String	getDcsXml()
java.lang.String	getDrcBoostFactor() Gets the boosting factor used to rank items in the DRC.
java.lang.String	getExampleId() Gets the exampleId attribute of the DCSAdminForm object
java.util.Map	getFrameworks()
java.lang.String	getIndexingStartDate() Gets the date and time the indexer is/was scheduled to start, for example 'Dec 2, 2003 1:35 AM MST'.
java.lang.String	getIndexingTimeOfDay() Gets the time of day the indexer isscheduled to start, for example '1:35 AM MST'.
java.util.Map	getLockedRecords()
java.lang.String	getMessage() Gets the message attribute of the DCSAdminForm object
java.lang.String	getMetadataGroupsLoaderFile()
java.lang.String	getMetadataRecordsLocation() Gets the path for the directory of metadata records the RepositoryManager is using, or empty string if none is configured.
java.lang.String	getMultiDocBoostFactor() Gets the boosting factor used to rank resources that have multiple records.
java.lang.String	getNumIdentifiersResults() Gets the numIdentifiersResults attribute of the DCSAdminForm object
java.lang.String	getNumIndexingErrors() Gets the number of indexing errors that are present.
java.lang.String	getNumRecordsResults() Gets the numRecordsResults attribute of the DCSAdminForm object
java.lang.String	getRemoveInvalidRecords() Gets the removeInvalidRecords attribute of the DCSAdminForm object
java.lang.String	getRepositoryIdentifier() Gets the repositoryIdentifier attribute of the DCSAdminForm object
java.util.List	getSessionBeans()
java.util.ArrayList	getSets() Gets the sets configured in the RepositoryManager.
java.lang.String	getSortSetsBy() Gets the sortSetsBy attribute of the DCSAdminForm object
java.lang.String	getStemmingBoostFactor() Gets the boosting factor used to rank items with matching stemmed terms.
java.lang.String	getStemmingEnabled() Indicates whether stemming support is enabled.
java.lang.String	getTitleBoostFactor() Gets the titleBoostFactor attribute of the DCSAdminForm object
java.lang.String	getTrustedWsIps()
java.util.List	getUnloadedFrameworks()
java.lang.String	getUpdateFrequency() Gets the frequency by which the index is updated to reflect changes that occur in the metadata files.
java.lang.String	getValidateRecords() Gets the validateRecords attribute of the DCSAdminForm object
java.util.ArrayList	getValidCollectionKeys() Grabs the collection keys from the DPC keys schema.
java.util.ArrayList	getValidMetadataFormats() Grabs the valid metadata formats from the DPC schema.
java.lang.String	getXmlError() Gets the xmlError attribute of the DCSAdminForm object
void	setAdd(java.lang.String value) Sets the add attribute of the DCSAdminForm object
void	setCollectionKey(java.lang.String key)
void	setCollectionPrefix(java.lang.String prefix)
void	setCollectionRecordsLocation(java.lang.String collectionRecordsLocation) Sets the absolute path to the collectionRecordsLocation.
void	setCurrentAdminEmail(java.lang.String value) Sets the currentAdminEmail attribute of the DCSAdminForm object
void	setCurrentDescription(java.lang.String value) Sets the currentDescription attribute of the DCSAdminForm object
void	setCurrentSetDescription(java.lang.String value) Sets the currentSetDescription attribute of the DCSAdminForm object
void	setCurrentSetDirectory(java.lang.String value) Sets the currentSetDirectory attribute of the DCSAdminForm object
void	setCurrentSetFormat(java.lang.String value) Sets the currentSetFormat attribute of the DCSAdminForm object
void	setCurrentSetName(java.lang.String value) Sets the currentSetName attribute of the DCSAdminForm object
void	setCurrentSetSpec(java.lang.String value) Sets the currentSetSpec attribute of the DCSAdminForm object
void	setDcsId(java.lang.String id)
void	setDcsXml(java.lang.String xml)
void	setDrcBoostFactor(java.lang.String boostFactor) Sets the boosting factor used to rank items in the DRC.
void	setFrameworks(java.util.Map map)
void	setIndexingStartTime(java.util.Date indexingStartTime) Sets the date and time the indexer is/was scheduled to start.
void	setLockedRecords(java.util.Map lockedRecords)
void	setMessage(java.lang.String message) Sets the message attribute of the DCSAdminForm object
void	setMetadataRecordsLocation(java.lang.String metadataRecordsLocation) Sets the absolute path to the metadataRecordsLocation.
void	setMultiDocBoostFactor(java.lang.String boostFactor) Sets the boosting factor used to rank resources that have multiple records.
void	setNumIdentifiersResults(java.lang.String numResults) Sets the numIdentifiersResults attribute of the DCSAdminForm object
void	setNumIndexingErrors(int numErrors) Sets the number of indexing errors that are present.
void	setNumRecordsResults(java.lang.String numResults) Sets the numRecordsResults attribute of the DCSAdminForm object
void	setRepositoryIdentifier(java.lang.String value) Sets the repositoryIdentifier attribute of the DCSAdminForm object
void	setRepositoryName(java.lang.String name) Sets the repositoryName attribute of the DCSAdminForm object
void	setSessionBeans(java.util.List sessionBeans)
void	setSets(java.util.ArrayList setInfos) Sets the sets attribute of the DCSAdminForm object
void	setSortSetsBy(java.lang.String sortSetsBy) Sets the sortSetsBy attribute of the DCSAdminForm object
void	setStemmingBoostFactor(java.lang.String boostFactor) Sets the boosting factor used to rank items with matching stemmed terms.
void	setStemmingEnabled(java.lang.String stemmingEnabled) Sets whether stemming support is enabled.
void	setTitleBoostFactor(java.lang.String boostFactor) Sets the boosting factor used to rank items with matching terms in the title field.
void	setTrustedWsIps(java.lang.String val)
void	setUnloadedFrameworks(java.util.List formats)
void	setUpdateFrequency(int frequency) Sets the frequency by which the index is updated to reflect changes that occur in the metadata files.
void	setXmlError(java.lang.String xmlError) Sets the xmlError attribute of the DCSAdminForm object
org.apache.struts.action.ActionErrors	validate(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.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, reset, setMultipartRequestHandler, setServlet, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

DCSAdminForm

public DCSAdminForm()

Constructor for the DCSAdminForm Bean object

Method Detail

getDcsXml

public java.lang.String getDcsXml()

setDcsXml

public void setDcsXml(java.lang.String xml)

getDcsId

public java.lang.String getDcsId()

setDcsId

public void setDcsId(java.lang.String id)

getSessionBeans

public java.util.List getSessionBeans()

setSessionBeans

public void setSessionBeans(java.util.List sessionBeans)

getFrameworks

public java.util.Map getFrameworks()

setFrameworks

public void setFrameworks(java.util.Map map)

setUnloadedFrameworks

public void setUnloadedFrameworks(java.util.List formats)

getUnloadedFrameworks

public java.util.List getUnloadedFrameworks()

getCollectionPrefix

public java.lang.String getCollectionPrefix()

setCollectionPrefix

public void setCollectionPrefix(java.lang.String prefix)

getCollectionKey

public java.lang.String getCollectionKey()

setCollectionKey

public void setCollectionKey(java.lang.String key)

getTrustedWsIps

public java.lang.String getTrustedWsIps()

setTrustedWsIps

public void setTrustedWsIps(java.lang.String val)

getMetadataGroupsLoaderFile

public java.lang.String getMetadataGroupsLoaderFile()

setLockedRecords

public void setLockedRecords(java.util.Map lockedRecords)

getLockedRecords

public java.util.Map getLockedRecords()

getNumIdentifiersResults

public java.lang.String getNumIdentifiersResults()

Gets the numIdentifiersResults attribute of the DCSAdminForm object

Returns:

The numIdentifiersResults value

setNumIdentifiersResults

public void setNumIdentifiersResults(java.lang.String numResults)

Sets the numIdentifiersResults attribute of the DCSAdminForm object

Parameters:

numResults - The new numIdentifiersResults value

getNumRecordsResults

public java.lang.String getNumRecordsResults()

Gets the numRecordsResults attribute of the DCSAdminForm object

Returns:

The numRecordsResults value

setNumRecordsResults

public void setNumRecordsResults(java.lang.String numResults)

Sets the numRecordsResults attribute of the DCSAdminForm object

Parameters:

numResults - The new numRecordsResults value

getUpdateFrequency

public java.lang.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 java.lang.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 java.lang.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(java.util.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 java.lang.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 java.lang.String getRemoveInvalidRecords()

Gets the removeInvalidRecords attribute of the DCSAdminForm object

Returns:

The removeInvalidRecords value

getValidateRecords

public java.lang.String getValidateRecords()

Gets the validateRecords attribute of the DCSAdminForm object

Returns:

The validateRecords value

setRepositoryName

public void setRepositoryName(java.lang.String name)

Sets the repositoryName attribute of the DCSAdminForm object

Parameters:

name - The new repositoryName value

setRepositoryIdentifier

public void setRepositoryIdentifier(java.lang.String value)

Sets the repositoryIdentifier attribute of the DCSAdminForm object

Parameters:

value - The new repositoryIdentifier value

getRepositoryIdentifier

public java.lang.String getRepositoryIdentifier()

Gets the repositoryIdentifier attribute of the DCSAdminForm object

Overrides:

getRepositoryIdentifier in class RepositoryForm

Returns:

The repositoryIdentifier value

setCurrentAdminEmail

public void setCurrentAdminEmail(java.lang.String value)

Sets the currentAdminEmail attribute of the DCSAdminForm object

Parameters:

value - The new currentAdminEmail value

getCurrentAdminEmail

public java.lang.String getCurrentAdminEmail()

Gets the currentAdminEmail attribute of the DCSAdminForm object

Returns:

The currentAdminEmail value

getExampleId

public java.lang.String getExampleId()

Gets the exampleId attribute of the DCSAdminForm object

Returns:

The exampleId value

setCurrentDescription

public void setCurrentDescription(java.lang.String value)

Sets the currentDescription attribute of the DCSAdminForm object

Parameters:

value - The new currentDescription value

getCurrentDescription

public java.lang.String getCurrentDescription()

Gets the currentDescription attribute of the DCSAdminForm object

Returns:

The currentDescription value

setAdd

public void setAdd(java.lang.String value)

Sets the add attribute of the DCSAdminForm object

Parameters:

value - The new add value

getAdd

public java.lang.String getAdd()

Gets the add attribute of the DCSAdminForm object

Returns:

The add value

setMetadataRecordsLocation

public void setMetadataRecordsLocation(java.lang.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(java.lang.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 java.lang.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 java.lang.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(java.lang.String value)

Sets the currentSetDescription attribute of the DCSAdminForm object

Parameters:

value - The new currentSetDescription value

getCurrentSetDescription

public java.lang.String getCurrentSetDescription()

Gets the currentSetDescription attribute of the DCSAdminForm object

Returns:

The currentSetDescription value

setCurrentSetName

public void setCurrentSetName(java.lang.String value)

Sets the currentSetName attribute of the DCSAdminForm object

Parameters:

value - The new currentSetName value

getCurrentSetName

public java.lang.String getCurrentSetName()

Gets the currentSetName attribute of the DCSAdminForm object

Returns:

The currentSetName value

setCurrentSetSpec

public void setCurrentSetSpec(java.lang.String value)

Sets the currentSetSpec attribute of the DCSAdminForm object

Parameters:

value - The new currentSetSpec value

getCurrentSetSpec

public java.lang.String getCurrentSetSpec()

Gets the currentSetSpec attribute of the DCSAdminForm object

Returns:

The currentSetSpec value

setCurrentSetDirectory

public void setCurrentSetDirectory(java.lang.String value)

Sets the currentSetDirectory attribute of the DCSAdminForm object

Parameters:

value - The new currentSetDirectory value

getCurrentSetDirectory

public java.lang.String getCurrentSetDirectory()

Gets the currentSetDirectory attribute of the DCSAdminForm object

Returns:

The currentSetDirectory value

getSortSetsBy

public java.lang.String getSortSetsBy()

Gets the sortSetsBy attribute of the DCSAdminForm object

Returns:

The sortSetsBy value

setSortSetsBy

public void setSortSetsBy(java.lang.String sortSetsBy)

Sets the sortSetsBy attribute of the DCSAdminForm object

Parameters:

sortSetsBy - The new sortSetsBy value

getSets

public java.util.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(java.util.ArrayList setInfos)

Sets the sets attribute of the DCSAdminForm object

Parameters:

sets - The new sets value

setCurrentSetFormat

public void setCurrentSetFormat(java.lang.String value)

Sets the currentSetFormat attribute of the DCSAdminForm object

Parameters:

value - The new currentSetFormat value

getCurrentSetFormat

public java.lang.String getCurrentSetFormat()

Gets the currentSetFormat attribute of the DCSAdminForm object

Returns:

The currentSetFormat value

setDrcBoostFactor

public void setDrcBoostFactor(java.lang.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(java.lang.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(java.lang.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(java.lang.String stemmingEnabled)

Sets whether stemming support is enabled.

Parameters:

stemmingEnabled - The new stemmingEnabled value

setStemmingBoostFactor

public void setStemmingBoostFactor(java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.String getTitleBoostFactor()

Gets the titleBoostFactor attribute of the DCSAdminForm object

Returns:

The titleBoostFactor value

getStemmingEnabled

public java.lang.String getStemmingEnabled()

Indicates whether stemming support is enabled.

Returns:

true if stemming is enabled, false otherwise.

setMessage

public void setMessage(java.lang.String message)

Sets the message attribute of the DCSAdminForm object

Parameters:

message - The new message value

getMessage

public java.lang.String getMessage()

Gets the message attribute of the DCSAdminForm object

Returns:

The message value

setXmlError

public void setXmlError(java.lang.String xmlError)

Sets the xmlError attribute of the DCSAdminForm object

Parameters:

xmlError - The new xmlError value

getXmlError

public java.lang.String getXmlError()

Gets the xmlError attribute of the DCSAdminForm object

Returns:

The xmlError value

getCollectionsBaseDir

public java.lang.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 java.util.ArrayList getValidCollectionKeys()

Grabs the collection keys from the DPC keys schema.

Returns:

A list of valid colleciton keys.

getValidMetadataFormats

public java.util.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,
                                                      javax.servlet.http.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.