Package 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:
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:

  • Field Details

    • debug

      protected static boolean debug
      NOT YET DOCUMENTED

  • Constructor Details

    • FrameworkConfigReader

      public FrameworkConfigReader(File source) throws Exception
      Create a FrameworkConfigReader.
      Parameters:
      source - Description of the Parameter
      Throws:
      Exception - NOT YET DOCUMENTED

  • Method Details

    • 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 String getDiscussionURL()
      optional node
      Returns:
      The discussionURL value

    • setDiscussionURL

      public void setDiscussionURL(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 String getName()
      Gets the name attribute of the FrameworkConfigReader object
      Returns:
      The name value

    • setName

      public void setName(String s)
      Sets the name attribute of the FrameworkConfigReader object
      Parameters:
      s - The new name value

    • getRecordsDir

      public String getRecordsDir()
      Gets the recordsDir attribute of the FrameworkConfigReader object
      Returns:
      The recordsDir value

    • setRecordsDir

      public void setRecordsDir(String s)
      Sets the recordsDir attribute of the FrameworkConfigReader object
      Parameters:
      s - The new recordsDir value

    • getRenderer

      public String getRenderer()
      Gets the renderer attribute of the FrameworkConfigReader object
      Returns:
      The renderer value

    • setRenderer

      public void setRenderer(String s)
      Sets the renderer attribute of the FrameworkConfigReader object
      Parameters:
      s - The new renderer value

    • getBestPracticesLabel

      public String getBestPracticesLabel()
      Gets the renderer attribute of the FrameworkConfigReader object
      Returns:
      The renderer value

    • setBestPracticesLabel

      public void setBestPracticesLabel(String s)
      Sets the renderer attribute of the FrameworkConfigReader object
      Parameters:
      s - The new renderer value

    • getRootElementName

      public String getRootElementName()
      Gets the rootElementName attribute of the FrameworkConfigReader object
      Returns:
      The rootElementName value

    • setRootElementName

      public void setRootElementName(String s)
      Sets the rootElementName attribute of the FrameworkConfigReader object
      Parameters:
      s - The new rootElementName value

    • getSchemaURI

      public String getSchemaURI()
      Gets the schemaURI attribute of the FrameworkConfigReader object
      Returns:
      The schemaURI value

    • getVocabLayoutURI

      public String getVocabLayoutURI()
      Gets the vocabLayoutURI attribute of the FrameworkConfigReader object
      Returns:
      The vocabLayoutURI value

    • setSchemaURI

      public void setSchemaURI(String s)
      Sets the schemaURI attribute of the FrameworkConfigReader object
      Parameters:
      s - The new schemaURI value

    • getXmlFormat

      public String getXmlFormat()
      Gets the xmlFormat attribute of the FrameworkConfigReader object
      Returns:
      The xmlFormat value

    • setXmlFormat

      public void setXmlFormat(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(String s)
      Print a line to standard out.
      Parameters:
      s - The String to print.