Package org.dlese.dpc.schemedit.config

Class SchemaPathMap

java.lang.Object
org.dlese.dpc.schemedit.config.SchemaPathMap
public class SchemaPathMap extends Object
Map holding SchemaPath instances that are defined in the framework configuration files, instantiated by FrameworkConfigReader instances, and accessed by MetaDataFramework.
Author:
ostwald

  • Constructor Details

    • SchemaPathMap

      public SchemaPathMap()
      Constructor for the SchemaPathMap object

  • Method Details

    • getCopyRecordPaths

      public List getCopyRecordPaths()
      CopyRecordPaths represent schema fields that will be copied to new records during record copy operations.
      Returns:
      SchemaPaths having value of "true" for the "requiredByCopyRecord" attribute

    • getCollectionConfigPaths

      public List getCollectionConfigPaths()
      CollectionConfigPaths represent schema fields that hold default information that will be inserted in new records.

      For example, the ADN framework config contains collectionConfig paths for "termsOfUse", among others.

      Returns:
      SchemaPaths having value "collectionConfig" for the valueType attribute

    • getMinimalRecordPaths

      public List getMinimalRecordPaths()
      MinimalRecordPaths represent fields that are required for new records.
      Returns:
      SchemaPaths having value of "true" for the "requiredByMinimalRecord" attribute

    • getInputHelperPaths

      public List getInputHelperPaths()

    • getInitialFieldCollapsePaths

      public List getInitialFieldCollapsePaths()
      Return a list of xpaths for which an initialFieldCollapse state has been specified"

    • getSchemaPathsByValueTypes

      public List getSchemaPathsByValueTypes(List valueTypes)
      Returns list of SchemaPath instances whose valueType is contained in the given list of pathTypes.
      Parameters:
      valueTypes - NOT YET DOCUMENTED
      Returns:
      SchemaPaths having requested valueTypes

    • getSchemaPathsByValueType

      public List getSchemaPathsByValueType(String valueType)
      Returns list of SchemaPath instances having specified valueType.
      Parameters:
      valueType - A SchemaPath valueType
      Returns:
      SchemaPath instances of requested type

    • getReadOnlyPaths

      public List getReadOnlyPaths()
      Returns lists of xpaths instances representing fields configured as "readOnly".

      For example, ID fields are sometimes desireable to be read only"

      Returns:
      xPaths for read only fields.

    • putPath

      public void putPath(SchemaPath schemaPath)
      Add a SchemaPath.
      Parameters:
      schemaPath - SchemaPath instance to be added.

    • getPathByPath

      public SchemaPath getPathByPath(String xpath)
      Gets a SchemaPath for specified xpath.
      Parameters:
      xpath - xpath for SchemaPath
      Returns:
      A SchemaPath instance or null if none found.

    • getPathByName

      public SchemaPath getPathByName(String name)
      Gets a SchemaPath for specified pathName.
      Parameters:
      name - pathName defined in the framework config
      Returns:
      A SchemaPath instance or null if none found.

    • clearPaths

      public void clearPaths()
      NOT YET DOCUMENTED

    • toString

      public String toString()
      NOT YET DOCUMENTED
      Overrides:
      toString in class Object
      Returns:
      NOT YET DOCUMENTED

    • prtln

      public static void prtln(String s)
      Description of the Method
      Parameters:
      s - Description of the Parameter