org.dlese.dpc.schemedit.config

Class FrameworkConfigReader

java.lang.Object

org.dlese.dpc.schemedit.config.AbstractConfigReader

org.dlese.dpc.schemedit.config.FrameworkConfigReader

All Implemented Interfaces:

java.io.Serializable

public class FrameworkConfigReader
extends AbstractConfigReader

Extracts info to augment that of the Schema from a framework configuration file.

Used by the MetaDataFramework and is required for each of 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
FrameworkConfigReader(java.io.File source) Create a FrameworkConfigReader.

Method Summary

Modifier and Type	Method and Description
int	getBaseRenderLevel() Gets the baseRenderLevel attribute of the FrameworkConfigReader object
java.lang.String	getBestPracticesLabel() Gets the renderer attribute of the FrameworkConfigReader object
java.lang.String	getDiscussionURL() optional node
FieldInfoMap	getFieldInfoMap() Create a FieldInfoMap containing information about each fieldInfo path specified in the config file.
java.lang.String	getName() Gets the name attribute of the FrameworkConfigReader object
PageList	getPageList() Gets the pageList attribute of the FrameworkConfigReader object
boolean	getRebuildOnStart() Gets the rebuildOnStart attribute of the FrameworkConfigReader object.
java.lang.String	getRecordsDir() Gets the recordsDir attribute of the FrameworkConfigReader object
java.lang.String	getRenderer() Gets the renderer attribute of the FrameworkConfigReader object
java.lang.String	getRootElementName() Gets the rootElementName attribute of the FrameworkConfigReader object
SchemaPathMap	getSchemaPathMap() Gets the schemaPathMap attribute of the FrameworkConfigReader object
SchemaPathMap	getSchemaPathMapNew() Not currently used - designed for future "pathSpec" which will be more flexible in specifying path-specific attributes and behaviours.
java.lang.String	getSchemaURI() Gets the schemaURI attribute of the FrameworkConfigReader object
UserInfo	getUserInfo()
java.lang.String	getVocabLayoutURI() Gets the vocabLayoutURI attribute of the FrameworkConfigReader object
java.lang.String	getXmlFormat() Gets the xmlFormat attribute of the FrameworkConfigReader object
protected static void	prtln(java.lang.String s) Print a line to standard out.
void	refresh() Force update by clearing cached values
void	setBaseRenderLevel(int level) Sets the baseRenderLevel attribute of the FrameworkConfigReader object
void	setBestPracticesLabel(java.lang.String s) Sets the renderer attribute of the FrameworkConfigReader object
void	setDiscussionURL(java.lang.String s) Sets the discussionURL attribute of the FrameworkConfigReader object
void	setName(java.lang.String s) Sets the name attribute of the FrameworkConfigReader object
void	setRebuildOnStart(boolean bool) Sets the rebuildOnStart attribute of the FrameworkConfigReader object
void	setRecordsDir(java.lang.String s) Sets the recordsDir attribute of the FrameworkConfigReader object
void	setRenderer(java.lang.String s) Sets the renderer attribute of the FrameworkConfigReader object
void	setRootElementName(java.lang.String s) Sets the rootElementName attribute of the FrameworkConfigReader object
void	setSchemaURI(java.lang.String s) Sets the schemaURI attribute of the FrameworkConfigReader object
void	setXmlFormat(java.lang.String s) Sets the xmlFormat attribute of the FrameworkConfigReader 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

FrameworkConfigReader

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

Create a FrameworkConfigReader.

Parameters:

source - Description of the Parameter

Throws:

java.lang.Exception - NOT YET DOCUMENTED

Method Detail

refresh

public void refresh()

Force update by clearing cached values

Overrides:

refresh in class AbstractConfigReader

getBaseRenderLevel

public int getBaseRenderLevel()

Gets the baseRenderLevel attribute of the FrameworkConfigReader object

Returns:

The baseRenderLevel value

setBaseRenderLevel

public void setBaseRenderLevel(int level)

Sets the baseRenderLevel attribute of the FrameworkConfigReader object

Parameters:

level - The new baseRenderLevel value

getDiscussionURL

public java.lang.String getDiscussionURL()

optional node

Returns:

The discussionURL value

setDiscussionURL

public void setDiscussionURL(java.lang.String s)

Sets the discussionURL attribute of the FrameworkConfigReader object

Parameters:

s - The new discussionURL value

getRebuildOnStart

public boolean getRebuildOnStart()

Gets the rebuildOnStart attribute of the FrameworkConfigReader object. If no value is provided, or if the value is not "false", return "true".

Returns:

The rebuildOnStart value

setRebuildOnStart

public void setRebuildOnStart(boolean bool)

Sets the rebuildOnStart attribute of the FrameworkConfigReader object

Parameters:

bool - The new rebuildOnStart value

getSchemaPathMap

public SchemaPathMap getSchemaPathMap()

Gets the schemaPathMap attribute of the FrameworkConfigReader object

Returns:

The schemaPathMap value

getUserInfo

public UserInfo getUserInfo()

getSchemaPathMapNew

public SchemaPathMap getSchemaPathMapNew()

Not currently used - designed for future "pathSpec" which will be more flexible in specifying path-specific attributes and behaviours.

Returns:

The schemaPathMapNew value

getName

public java.lang.String getName()

Gets the name attribute of the FrameworkConfigReader object

Returns:

The name value

setName

public void setName(java.lang.String s)

Sets the name attribute of the FrameworkConfigReader object

Parameters:

s - The new name value

getRecordsDir

public java.lang.String getRecordsDir()

Gets the recordsDir attribute of the FrameworkConfigReader object

Returns:

The recordsDir value

setRecordsDir

public void setRecordsDir(java.lang.String s)

Sets the recordsDir attribute of the FrameworkConfigReader object

Parameters:

s - The new recordsDir value

getRenderer

public java.lang.String getRenderer()

Gets the renderer attribute of the FrameworkConfigReader object

Returns:

The renderer value

setRenderer

public void setRenderer(java.lang.String s)

Sets the renderer attribute of the FrameworkConfigReader object

Parameters:

s - The new renderer value

getBestPracticesLabel

public java.lang.String getBestPracticesLabel()

Gets the renderer attribute of the FrameworkConfigReader object

Returns:

The renderer value

setBestPracticesLabel

public void setBestPracticesLabel(java.lang.String s)

Sets the renderer attribute of the FrameworkConfigReader object

Parameters:

s - The new renderer value

getRootElementName

public java.lang.String getRootElementName()

Gets the rootElementName attribute of the FrameworkConfigReader object

Returns:

The rootElementName value

setRootElementName

public void setRootElementName(java.lang.String s)

Sets the rootElementName attribute of the FrameworkConfigReader object

Parameters:

s - The new rootElementName value

getSchemaURI

public java.lang.String getSchemaURI()

Gets the schemaURI attribute of the FrameworkConfigReader object

Returns:

The schemaURI value

getVocabLayoutURI

public java.lang.String getVocabLayoutURI()

Gets the vocabLayoutURI attribute of the FrameworkConfigReader object

Returns:

The vocabLayoutURI value

setSchemaURI

public void setSchemaURI(java.lang.String s)

Sets the schemaURI attribute of the FrameworkConfigReader object

Parameters:

s - The new schemaURI value

getXmlFormat

public java.lang.String getXmlFormat()

Gets the xmlFormat attribute of the FrameworkConfigReader object

Returns:

The xmlFormat value

setXmlFormat

public void setXmlFormat(java.lang.String s)

Sets the xmlFormat attribute of the FrameworkConfigReader object

Parameters:

s - The new xmlFormat value

getPageList

public PageList getPageList()

Gets the pageList attribute of the FrameworkConfigReader object

Returns:

The pageList value

getFieldInfoMap

public FieldInfoMap getFieldInfoMap()

Create a FieldInfoMap containing information about each fieldInfo path specified in the config file. FieldInfo elements point to a FieldInfo file containing best practices, definitions, and other information about a particular element in this framework.

Returns:

The fieldInfoMap value

prtln

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

Print a line to standard out.

Parameters:

s - The String to print.