org.dlese.dpc.schemedit.standards.asn
Class AsnSuggestionServiceHelper

java.lang.Object
  org.dlese.dpc.schemedit.standards.CATServiceHelper
      org.dlese.dpc.schemedit.standards.asn.AsnSuggestionServiceHelper

All Implemented Interfaces:

SuggestionServiceHelper

Direct Known Subclasses:

ResQualSuggestionServiceHelper

public class AsnSuggestionServiceHelper
extends CATServiceHelper

SuggestionsServiceHelper for the CAT REST standards suggestion service, operating over ASN Standards.

Author:

ostwald

Field Summary

Fields inherited from class org.dlese.dpc.schemedit.standards.CATServiceHelper

ALL_CONTENT, BOTH_CONTENT, LIST_MODE, SELECTED_CONTENT, SUGGESTIONS_CONTENT, TREE_MODE

Constructor Summary

AsnSuggestionServiceHelper(SchemEditForm sef, CATHelperPlugin frameworkPlugin)
Constructor for the AsnSuggestionServiceHelper object

Method Summary

void	displaySuggestions(List standardsList) Debugging
List	getAvailableDocs() Gets the availableDocs attribute of the AsnSuggestionServiceHelper object
String	getCurrentDoc() Gets the currentDoc attribute of the AsnSuggestionServiceHelper object
String	getDefaultDoc() Gets the defaultDoc attribute of the AsnSuggestionServiceHelper object
protected String	getIdFromCATStandard(CATStandard std) Gets the idFromCATStandard attribute of the AsnSuggestionServiceHelper object
Map	getOtherSelectedStandards() Gets the otherSelectedStandards attribute of the AsnSuggestionServiceHelper object
SelectedStandardsBean	getSelectedStandardsBean() Gets the selectedStandardsBean attribute of the AsnSuggestionServiceHelper object
AsnStandardsDocument	getStandardsDocument() Gets the current standardsDocument if one has been assigned, or fetches the "defaultDoc" from the StandardsRegistry.
String	getStandardsFormat() Gets the standardsFormat attribute of the AsnSuggestionServiceHelper object (hardcoded to "asn").
AsnStandardsManager	getStandardsManager() Gets the standardsManager attribute of the AsnSuggestionServiceHelper object
void	setStandardsDocument(String key) Sets the asnDocument attribute of the AsnSuggestionServiceHelper object
void	updateSelectedStandardsBean() Write the list of selected standards, as well as the currentStandards Doc to the SelectedStandardsBean

Methods inherited from class org.dlese.dpc.schemedit.standards.CATServiceHelper

getActionForm, getAuthor, getConstraints, getDerivedCATEndGrade, getDerivedCATStartGrade, getDisplayContent, getDisplayMode, getFramework, getFrameworkPlugin, getGradeRangeOptions, getInstance, getInstanceDocument, getKeywordWeighting, getNumSelectedStandards, getOptionalCatUIFields, getRecordDescription, getRecordGradeRanges, getRecordKeywords, getRecordSubjects, getRecordUrl, getRootStandardNode, getSelectedGradeRanges, getSelectedKeywords, getSelectedStandards, getSelectedStandards, getServiceIsActive, getStandardsNodes, getSuggestedStandards, getTopic, getUrl, getUseDescription, getUseGradeRanges, getUseKeywords, getUseSubjects, getXmlFormat, getXpath, moreLikeThis, setDisplayContent, setDisplayMode, setFrameworkPlugin, setKeywordWeighting, setSelectedGradeRanges, setSelectedKeywords, setServiceIsActive, setSuggestedStandards, setUrl, setUseDescription, setUseGradeRanges, setUseKeywords, setUseSubjects, updateDisplayControls, updateStandardsDisplay, updateSuggestions, updateSuggestions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AsnSuggestionServiceHelper

public AsnSuggestionServiceHelper(SchemEditForm sef,
                                  CATHelperPlugin frameworkPlugin)

Constructor for the AsnSuggestionServiceHelper object

Parameters:

sef - NOT YET DOCUMENTED

frameworkPlugin - NOT YET DOCUMENTED

Method Detail

getStandardsDocument

public AsnStandardsDocument getStandardsDocument()

Gets the current standardsDocument if one has been assigned, or fetches the "defaultDoc" from the StandardsRegistry.

Specified by:

getStandardsDocument in class CATServiceHelper

Returns:

The standardsDocument value

getStandardsFormat

public String getStandardsFormat()

Gets the standardsFormat attribute of the AsnSuggestionServiceHelper object (hardcoded to "asn").

Specified by:

getStandardsFormat in class CATServiceHelper

Returns:

The standardsFormat value

getStandardsManager

public AsnStandardsManager getStandardsManager()

Gets the standardsManager attribute of the AsnSuggestionServiceHelper object

Specified by:

getStandardsManager in interface SuggestionServiceHelper

Overrides:

getStandardsManager in class CATServiceHelper

Returns:

The standardsManager value

getOtherSelectedStandards

public Map getOtherSelectedStandards()

Gets the otherSelectedStandards attribute of the AsnSuggestionServiceHelper object

Overrides:

getOtherSelectedStandards in class CATServiceHelper

Returns:

The otherSelectedStandards value

updateSelectedStandardsBean

public void updateSelectedStandardsBean()

Write the list of selected standards, as well as the currentStandards Doc to the SelectedStandardsBean

getSelectedStandardsBean

public SelectedStandardsBean getSelectedStandardsBean()

Gets the selectedStandardsBean attribute of the AsnSuggestionServiceHelper object

Returns:

The selectedStandardsBean value

getAvailableDocs

public List getAvailableDocs()

Gets the availableDocs attribute of the AsnSuggestionServiceHelper object

Overrides:

getAvailableDocs in class CATServiceHelper

Returns:

The availableDocs value

getCurrentDoc

public String getCurrentDoc()

Gets the currentDoc attribute of the AsnSuggestionServiceHelper object

Specified by:

getCurrentDoc in interface SuggestionServiceHelper

Overrides:

getCurrentDoc in class CATServiceHelper

Returns:

The currentDoc value

getDefaultDoc

public String getDefaultDoc()

Gets the defaultDoc attribute of the AsnSuggestionServiceHelper object

Returns:

The defaultDoc value

setStandardsDocument

public void setStandardsDocument(String key)
                          throws Exception

Sets the asnDocument attribute of the AsnSuggestionServiceHelper object

Parameters:

key - The new asnDocument value

Throws:

Exception - Description of the Exception

getIdFromCATStandard

protected String getIdFromCATStandard(CATStandard std)

Gets the idFromCATStandard attribute of the AsnSuggestionServiceHelper object

Specified by:

getIdFromCATStandard in class CATServiceHelper

Parameters:

std - NOT YET DOCUMENTED

Returns:

The idFromCATStandard value

displaySuggestions

public void displaySuggestions(List standardsList)

Debugging

Overrides:

displaySuggestions in class CATServiceHelper

Parameters:

standardsList - A list of StandardsWrapper instances to display.