DLESE Tools
v1.6.0

org.dlese.dpc.schemedit.config
Class CollectionConfigReader

java.lang.Object
  extended by org.dlese.dpc.schemedit.config.AbstractConfigReader
      extended by org.dlese.dpc.schemedit.config.CollectionConfigReader
All Implemented Interfaces:
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
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
CollectionConfigReader(File source)
          Create a CollectionConfigReader.
 
Method Summary
 void clearNdrInfo()
          Remove all ndrInfo from the CollectionConfig and set "authority" to "dcs".
 String getAgentHandle()
          Gets the agentHandle attribute of the CollectionConfigReader object
 String getAggregatorHandle()
          Gets the aggregatorHandle attribute of the CollectionConfigReader object
 boolean getAllowSuggestions()
           
 String getAuthority()
          Gets the authority attribute of the CollectionConfigReader object
 String getExportDirectory()
          Gets the name attribute of the CollectionConfigReader object
 String getFinalStatusLabel()
          Gets the finalStatusLabel attribute of the CollectionConfigReader object
 String getId()
          optional node
 String getIdPrefix()
          optional node
 String getMetadataProviderHandle()
          Gets the metadataProviderHandle attribute of the CollectionConfigReader object
 String getNdrOaiLink()
          Gets the ndrOaiLink attribute of the CollectionConfigReader object
 String getNdrServer()
          Gets the ndrServer attribute of the CollectionConfigReader object
 Map getStatusMap()
          Gets the statusMap attribute of the CollectionConfigReader object
 Map getTupleMap()
          Gets the tupleMap attribute of the CollectionConfigReader object
 String getXmlFormat()
          Gets the xmlFormat attribute of the CollectionConfigReader object
protected static void prtln(String s)
          Print a line to standard out.
 void refresh()
          Force update by clearing cached values
 void setAgentHandle(String pid)
          Sets the agentHandle attribute of the CollectionConfigReader object
 void setAggregatorHandle(String pid)
          Sets the aggregatorHandle attribute of the CollectionConfigReader object
 void setAllowSuggestions(boolean value)
           
 void setAuthority(String s)
          Sets the authority attribute of the CollectionConfigReader object
 void setExportDirectory(String s)
          Sets the exportDirectory attribute of the CollectionConfigReader object
 void setFinalStatusLabel(String s)
          Sets the finalStatusLabel attribute of the CollectionConfigReader object
 void setId(String s)
          Sets the discussionURL attribute of the CollectionConfigReader object
 void setIdPrefix(String s)
          Sets the idPrefix attribute of the CollectionConfigReader object
 void setMetadataProviderHandle(String handle)
          Sets the metadataProviderHandle attribute of the CollectionConfigReader object
 void setNdrOaiLink(String link)
          Sets the ndrOaiLink attribute of the CollectionConfigReader object
 void setNdrServer(String server)
          Sets the ndrServer attribute of the CollectionConfigReader object
 void setStatusMap(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(Map tMap)
          Sets the tupleMap attribute of the CollectionConfigReader object
 void setXmlFormat(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(File source)
                       throws Exception
Create a CollectionConfigReader.

Parameters:
source - Description of the Parameter
Throws:
Exception - NOT YET DOCUMENTED
Method Detail

getId

public String getId()
optional node

Returns:
The discussionURL value

setId

public void setId(String s)
Sets the discussionURL attribute of the CollectionConfigReader object

Parameters:
s - The new discussionURL value

getIdPrefix

public String getIdPrefix()
optional node

Returns:
The idPrefix value

setIdPrefix

public void setIdPrefix(String s)
Sets the idPrefix attribute of the CollectionConfigReader object

Parameters:
s - The new idPrefix value

getExportDirectory

public String getExportDirectory()
Gets the name attribute of the CollectionConfigReader object

Returns:
The name value

setExportDirectory

public void setExportDirectory(String s)
Sets the exportDirectory attribute of the CollectionConfigReader object

Parameters:
s - The new exportDirectory value

getXmlFormat

public String getXmlFormat()
Gets the xmlFormat attribute of the CollectionConfigReader object

Returns:
The xmlFormat value

setXmlFormat

public void setXmlFormat(String s)
Sets the xmlFormat attribute of the CollectionConfigReader object

Parameters:
s - The new xmlFormat value

getAuthority

public String getAuthority()
Gets the authority attribute of the CollectionConfigReader object

Returns:
The authority value

setAuthority

public void setAuthority(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 String getMetadataProviderHandle()
Gets the metadataProviderHandle attribute of the CollectionConfigReader object

Returns:
The metadataProviderHandle value

setMetadataProviderHandle

public void setMetadataProviderHandle(String handle)
Sets the metadataProviderHandle attribute of the CollectionConfigReader object

Parameters:
handle - The new metadataProviderHandle value

getAggregatorHandle

public String getAggregatorHandle()
Gets the aggregatorHandle attribute of the CollectionConfigReader object

Returns:
The aggregatorHandle value

setAggregatorHandle

public void setAggregatorHandle(String pid)
Sets the aggregatorHandle attribute of the CollectionConfigReader object

Parameters:
pid - The new aggregatorHandle value

getAgentHandle

public String getAgentHandle()
Gets the agentHandle attribute of the CollectionConfigReader object

Returns:
The agentHandle value

setAgentHandle

public void setAgentHandle(String pid)
Sets the agentHandle attribute of the CollectionConfigReader object

Parameters:
pid - The new agentHandle value

getNdrOaiLink

public String getNdrOaiLink()
Gets the ndrOaiLink attribute of the CollectionConfigReader object

Returns:
The ndrOaiLink value

setNdrOaiLink

public void setNdrOaiLink(String link)
Sets the ndrOaiLink attribute of the CollectionConfigReader object

Parameters:
link - The new ndrOaiLink value

getNdrServer

public String getNdrServer()
Gets the ndrServer attribute of the CollectionConfigReader object

Returns:
The ndrServer value

setNdrServer

public void setNdrServer(String server)
Sets the ndrServer attribute of the CollectionConfigReader object

Parameters:
link - The new ndrServer value

getFinalStatusLabel

public String getFinalStatusLabel()
Gets the finalStatusLabel attribute of the CollectionConfigReader object

Returns:
The finalStatusLabel value

setFinalStatusLabel

public void setFinalStatusLabel(String s)
Sets the finalStatusLabel attribute of the CollectionConfigReader object

Parameters:
s - The new finalStatusLabel value

getStatusMap

public Map getStatusMap()
Gets the statusMap attribute of the CollectionConfigReader object

Returns:
The statusMap value

setStatusMap

public void setStatusMap(Map sMap)
                  throws 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:
Exception - NOT YET DOCUMENTED

getTupleMap

public Map getTupleMap()
Gets the tupleMap attribute of the CollectionConfigReader object

Returns:
The tupleMap value

setTupleMap

public void setTupleMap(Map tMap)
                 throws Exception
Sets the tupleMap attribute of the CollectionConfigReader object

Parameters:
tMap - The new tupleMap value
Throws:
Exception - NOT YET DOCUMENTED

refresh

public void refresh()
Force update by clearing cached values

Overrides:
refresh in class AbstractConfigReader

prtln

protected static void prtln(String s)
Print a line to standard out.

Parameters:
s - The String to print.

DLESE Tools
v1.6.0