org.dlese.dpc.schemedit.config

Class CollectionConfigReader

java.lang.Object

org.dlese.dpc.schemedit.config.AbstractConfigReader

org.dlese.dpc.schemedit.config.CollectionConfigReader

All Implemented Interfaces:

java.io.Serializable

public class CollectionConfigReader
extends AbstractConfigReader

Extracts info from a Collection configuration document. Used to populate CollectionConfig objects for each of the frameworks supported by DCS.

Author:

ostwald

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	debug NOT YET DOCUMENTED

Fields inherited from class org.dlese.dpc.schemedit.config.AbstractConfigReader

df, docMap, nameSpaceInfo, rootElementName, source, writeOnDestroy

Constructor Summary

Constructors

Constructor and Description
CollectionConfigReader(java.io.File source) Create a CollectionConfigReader.

Method Summary

Modifier and Type	Method and Description
void	clearNdrInfo() Remove all ndrInfo from the CollectionConfig and set "authority" to "dcs".
java.lang.String	getAgentHandle() Gets the agentHandle attribute of the CollectionConfigReader object
java.lang.String	getAggregatorHandle() Gets the aggregatorHandle attribute of the CollectionConfigReader object
boolean	getAllowSuggestions()
java.lang.String	getAuthority() Gets the authority attribute of the CollectionConfigReader object
java.lang.String	getExportDirectory() Gets the name attribute of the CollectionConfigReader object
java.lang.String	getFinalStatusLabel() Gets the finalStatusLabel attribute of the CollectionConfigReader object
java.lang.String	getId() optional node
java.lang.String	getIdPrefix() optional node
java.lang.String	getMetadataProviderHandle() Gets the metadataProviderHandle attribute of the CollectionConfigReader object
java.lang.String	getNdrOaiLink() Gets the ndrOaiLink attribute of the CollectionConfigReader object
java.lang.String	getNdrServer() Gets the ndrServer attribute of the CollectionConfigReader object
java.util.Map	getStatusMap() Gets the statusMap attribute of the CollectionConfigReader object
java.util.Map	getTupleMap() Gets the tupleMap attribute of the CollectionConfigReader object
java.lang.String	getXmlFormat() Gets the xmlFormat attribute of the CollectionConfigReader object
protected static void	prtln(java.lang.String s) Print a line to standard out.
void	refresh() Force update by clearing cached values
void	setAgentHandle(java.lang.String pid) Sets the agentHandle attribute of the CollectionConfigReader object
void	setAggregatorHandle(java.lang.String pid) Sets the aggregatorHandle attribute of the CollectionConfigReader object
void	setAllowSuggestions(boolean value)
void	setAuthority(java.lang.String s) Sets the authority attribute of the CollectionConfigReader object
void	setExportDirectory(java.lang.String s) Sets the exportDirectory attribute of the CollectionConfigReader object
void	setFinalStatusLabel(java.lang.String s) Sets the finalStatusLabel attribute of the CollectionConfigReader object
void	setId(java.lang.String s) Sets the discussionURL attribute of the CollectionConfigReader object
void	setIdPrefix(java.lang.String s) Sets the idPrefix attribute of the CollectionConfigReader object
void	setMetadataProviderHandle(java.lang.String handle) Sets the metadataProviderHandle attribute of the CollectionConfigReader object
void	setNdrOaiLink(java.lang.String link) Sets the ndrOaiLink attribute of the CollectionConfigReader object
void	setNdrServer(java.lang.String server) Sets the ndrServer attribute of the CollectionConfigReader object
void	setStatusMap(java.util.Map sMap) NOTE: if we edit the config record via schemedit, the record is automatically updated and then we have to reload it.
void	setTupleMap(java.util.Map tMap) Sets the tupleMap attribute of the CollectionConfigReader object
void	setXmlFormat(java.lang.String s) Sets the xmlFormat attribute of the CollectionConfigReader object

Methods inherited from class org.dlese.dpc.schemedit.config.AbstractConfigReader

destroy, flush, getDelocalizedDoc, getDocMap, getDocument, getNode, getNodes, getNodeText, getSource, getSourcePath, setNodeText, setSource

Methods inherited from class java.lang.Object

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

Field Detail

debug

protected static boolean debug

NOT YET DOCUMENTED

Constructor Detail

CollectionConfigReader

public CollectionConfigReader(java.io.File source)
                       throws java.lang.Exception

Create a CollectionConfigReader.

Parameters:

source - Description of the Parameter

Throws:

java.lang.Exception - NOT YET DOCUMENTED

Method Detail

getId

public java.lang.String getId()

optional node

Returns:

The discussionURL value

setId

public void setId(java.lang.String s)

Sets the discussionURL attribute of the CollectionConfigReader object

Parameters:

s - The new discussionURL value

getIdPrefix

public java.lang.String getIdPrefix()

optional node

Returns:

The idPrefix value

setIdPrefix

public void setIdPrefix(java.lang.String s)

Sets the idPrefix attribute of the CollectionConfigReader object

Parameters:

s - The new idPrefix value

getExportDirectory

public java.lang.String getExportDirectory()

Gets the name attribute of the CollectionConfigReader object

Returns:

The name value

setExportDirectory

public void setExportDirectory(java.lang.String s)

Sets the exportDirectory attribute of the CollectionConfigReader object

Parameters:

s - The new exportDirectory value

getXmlFormat

public java.lang.String getXmlFormat()

Gets the xmlFormat attribute of the CollectionConfigReader object

Returns:

The xmlFormat value

setXmlFormat

public void setXmlFormat(java.lang.String s)

Sets the xmlFormat attribute of the CollectionConfigReader object

Parameters:

s - The new xmlFormat value

getAuthority

public java.lang.String getAuthority()

Gets the authority attribute of the CollectionConfigReader object

Returns:

The authority value

setAuthority

public void setAuthority(java.lang.String s)

Sets the authority attribute of the CollectionConfigReader object

Parameters:

s - The new authority value

getAllowSuggestions

public boolean getAllowSuggestions()

setAllowSuggestions

public void setAllowSuggestions(boolean value)

clearNdrInfo

public void clearNdrInfo()

Remove all ndrInfo from the CollectionConfig and set "authority" to "dcs".

getMetadataProviderHandle

public java.lang.String getMetadataProviderHandle()

Gets the metadataProviderHandle attribute of the CollectionConfigReader object

Returns:

The metadataProviderHandle value

setMetadataProviderHandle

public void setMetadataProviderHandle(java.lang.String handle)

Sets the metadataProviderHandle attribute of the CollectionConfigReader object

Parameters:

handle - The new metadataProviderHandle value

getAggregatorHandle

public java.lang.String getAggregatorHandle()

Gets the aggregatorHandle attribute of the CollectionConfigReader object

Returns:

The aggregatorHandle value

setAggregatorHandle

public void setAggregatorHandle(java.lang.String pid)

Sets the aggregatorHandle attribute of the CollectionConfigReader object

Parameters:

pid - The new aggregatorHandle value

getAgentHandle

public java.lang.String getAgentHandle()

Gets the agentHandle attribute of the CollectionConfigReader object

Returns:

The agentHandle value

setAgentHandle

public void setAgentHandle(java.lang.String pid)

Sets the agentHandle attribute of the CollectionConfigReader object

Parameters:

pid - The new agentHandle value

getNdrOaiLink

public java.lang.String getNdrOaiLink()

Gets the ndrOaiLink attribute of the CollectionConfigReader object

Returns:

The ndrOaiLink value

setNdrOaiLink

public void setNdrOaiLink(java.lang.String link)

Sets the ndrOaiLink attribute of the CollectionConfigReader object

Parameters:

link - The new ndrOaiLink value

getNdrServer

public java.lang.String getNdrServer()

Gets the ndrServer attribute of the CollectionConfigReader object

Returns:

The ndrServer value

setNdrServer

public void setNdrServer(java.lang.String server)

Sets the ndrServer attribute of the CollectionConfigReader object

Parameters:

link - The new ndrServer value

getFinalStatusLabel

public java.lang.String getFinalStatusLabel()

Gets the finalStatusLabel attribute of the CollectionConfigReader object

Returns:

The finalStatusLabel value

setFinalStatusLabel

public void setFinalStatusLabel(java.lang.String s)

Sets the finalStatusLabel attribute of the CollectionConfigReader object

Parameters:

s - The new finalStatusLabel value

getStatusMap

public java.util.Map getStatusMap()

Gets the statusMap attribute of the CollectionConfigReader object

Returns:

The statusMap value

setStatusMap

public void setStatusMap(java.util.Map sMap)
                  throws java.lang.Exception

NOTE: if we edit the config record via schemedit, the record is automatically updated and then we have to reload it. But if we edit the statusMap via another editor, then this method is necessary to update the config file

Parameters:

sMap - The new statusMap value

Throws:

java.lang.Exception - NOT YET DOCUMENTED

getTupleMap

public java.util.Map getTupleMap()

Gets the tupleMap attribute of the CollectionConfigReader object

Returns:

The tupleMap value

setTupleMap

public void setTupleMap(java.util.Map tMap)
                 throws java.lang.Exception

Sets the tupleMap attribute of the CollectionConfigReader object

Parameters:

tMap - The new tupleMap value

Throws:

java.lang.Exception - NOT YET DOCUMENTED

refresh

public void refresh()

Force update by clearing cached values

Overrides:

refresh in class AbstractConfigReader

prtln

protected static void prtln(java.lang.String s)

Print a line to standard out.

Parameters:

s - The String to print.