Class NcsAnnoFrameworkPlugin

All Implemented Interfaces:
CATHelperPlugin

public class NcsAnnoFrameworkPlugin extends AsnCATPlugin
CATService FrameworkPlugin providing information specific to the ncs_anno framework.

NOTE: suggestion service is NOT active for this framework!

Author:
ostwald
  • Constructor Details

    • NcsAnnoFrameworkPlugin

      public NcsAnnoFrameworkPlugin()
  • Method Details

    • init

      public void init(CATServiceHelper helper)
      initialize the NcsAnnoFrameworkPlugin object so that the suggestion service is deactivated.
      Specified by:
      init in interface CATHelperPlugin
      Overrides:
      init in class AbstractCATHelperPlugin
      Parameters:
      helper - the CatServiceHelper for this plugin
    • gradeRangeHelperInit

      protected GradeRangeHelper gradeRangeHelperInit()
      Initialize a gradeRangeHelper instance for the ncs_item gradeRange Vocab values
      Specified by:
      gradeRangeHelperInit in class AsnCATPlugin
      Returns:
      a GradeRangeHelper instance
      See Also:
    • getOptionalCatUIFields

      public List getOptionalCatUIFields()
      Gets the optionalCatUIFields attribute of the NcsAnnoFrameworkPlugin object
      Specified by:
      getOptionalCatUIFields in interface CATHelperPlugin
      Specified by:
      getOptionalCatUIFields in class AsnCATPlugin
      Returns:
      The optionalCatUIFields value
    • getGradeRangePath

      public String getGradeRangePath()
      Gets the gradeRangePath attribute of the NcsAnnoSuggestionServiceHelper object
      Specified by:
      getGradeRangePath in class AsnCATPlugin
      Returns:
      The gradeRangePath value
    • getKeywordPath

      public String getKeywordPath()
      Gets the keywordPath attribute of the NcsAnnoSuggestionServiceHelper object
      Specified by:
      getKeywordPath in class AsnCATPlugin
      Returns:
      The keywordPath value
    • getDescriptionPath

      public String getDescriptionPath()
      Gets the descriptionPath attribute of the NcsAnnoFrameworkPlugin object
      Specified by:
      getDescriptionPath in class AsnCATPlugin
      Returns:
      The descriptionPath value
    • getSubjectPath

      public String getSubjectPath()
      Gets the subjectPath attribute of the NcsAnnoFrameworkPlugin object
      Specified by:
      getSubjectPath in class AsnCATPlugin
      Returns:
      The subjectPath value
    • getGradeRangeOptions

      public List getGradeRangeOptions()
      Gets the gradeRanges corresponding to the grades searchable in the Suggestion service (and which can be specified in the control box).

      NOTE: the "values" should correspond to what the service expects, while the "labels" are human-meaningful representations of the values. E.g., one member of the gradeRangeOption list might be (value: "1", label: "1st Grade")

      Specified by:
      getGradeRangeOptions in interface CATHelperPlugin
      Specified by:
      getGradeRangeOptions in class AsnCATPlugin
      Returns:
      The gradeRanges value