gov.nih.nlm.mms.browser
Interface BrowserRestrictor

All Superinterfaces:

Comparable, Comparator, Configurable, GUIConfigurable, Restrictor

All Known Implementing Classes:

AbstractBrowserRestrictor, ContentViewBrowserRestrictor, SemanticTypesBrowserRestrictor, ShowAllBrowserRestrictor, SourceBrowserRestrictor

public interface BrowserRestrictor
extends GUIConfigurable, Restrictor

Generically represents an object that holds criteria for how to restrict or highlight content in finder searches or concept view displays.

Author:

Deborah Shapiro

Method Summary

List<Color>	getColor(Object o) Returns a List of Colors for which the given parameter matches in the BrowserRestrictor's key.
ConceptDataSelector	getConceptDataSelector() Returns a ConceptDataSelector.
List<String>	getStyle(Object o) Returns a List of font styles for which the given parameter matches in the BrowserRestrictor's key.
String	getStyleLegend() Returns a HTML string containing a key for how elements from the browser restrictor should be displayed, indicating the color and font style.
boolean	isBold() Indicates whether or not the restricted data will be displayed using bold.
boolean	isConceptViewHideModeEnabled() Indicates if hide mode is enabled, so restricted data will be hidden from view.
boolean	isConceptViewHighlightModeEnabled() Indicates if highlight mode is enabled, so restricted data will be highlighted when viewed.
boolean	isFinderRestrictionEnabled() Indicates if restrictions will be enacted on Finders.
boolean	isItalics() Indicates whether or not the restricted data will be displayed using italics.
boolean	isUnderline() Indicates whether or not the restricted data will be displayed using underline.
void	setBold(boolean b) Sets whether or not the restricted data will be displayed using bold.
void	setConceptViewHideModeEnabled(boolean b) Sets hide mode to be enabled, so restricted data will be hidden from view.
void	setConceptViewHighlightModeEnabled(boolean b) Sets highlight mode to be enabled, so restricted data will be highlighted when viewed.
void	setFinderRestrictionEnabled(boolean b) Sets restrictions to be enacted on Finders.
void	setItalics(boolean b) Sets whether or not the restricted data will be displayed using italics.
void	setUnderline(boolean b) Sets whether or not the restricted data will be displayed using underline.

Methods inherited from interface gov.nih.nlm.mms.GUIConfigurable

addDataChangeListener, getColor, getGUIConfigurableForValidationFailure, getHelpPanel, getName, getPanel, getTabDescription, getValidationErrors, getValidationWarnings, hasAdvancedOptions, hasDataChanged, removeDataChangeListener, resetDataChanged, setDataChanged, setPanelSelections, showOptions, validate

Methods inherited from interface gov.nih.nlm.mms.Configurable

getConfigurationDetails, getProperties, resetToDefaults, setConfiguration, setConfiguration, setProperties

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface gov.nih.nlm.umls.meta.Restrictor

keep

Methods inherited from interface java.util.Comparator

compare, equals

Method Detail

getConceptDataSelector

ConceptDataSelector getConceptDataSelector()

Returns a ConceptDataSelector.

Returns:

a ConceptDataSelector

isItalics

boolean isItalics()

Indicates whether or not the restricted data will be displayed using italics.

Returns:

true if italics will be used; false otherwise

setItalics

void setItalics(boolean b)

Sets whether or not the restricted data will be displayed using italics.

Parameters:

true - if italics will be used; false otherwise

isBold

boolean isBold()

Indicates whether or not the restricted data will be displayed using bold.

Returns:

true if bold will be used; false otherwise

setBold

void setBold(boolean b)

Sets whether or not the restricted data will be displayed using bold.

Parameters:

true - if bold will be used; false otherwise

isUnderline

boolean isUnderline()

Indicates whether or not the restricted data will be displayed using underline.

Returns:

true if underline will be used; false otherwise

setUnderline

void setUnderline(boolean b)

Sets whether or not the restricted data will be displayed using underline.

Parameters:

true - if underline will be used; false otherwise

setFinderRestrictionEnabled

void setFinderRestrictionEnabled(boolean b)

Sets restrictions to be enacted on Finders.

Parameters:

b - true if finder restriction is enabled; false otherwise

isFinderRestrictionEnabled

boolean isFinderRestrictionEnabled()

Indicates if restrictions will be enacted on Finders.

Returns:

true if restrictions will be enacted on Finders false otherwise

setConceptViewHideModeEnabled

void setConceptViewHideModeEnabled(boolean b)

Sets hide mode to be enabled, so restricted data will be hidden from view.

Parameters:

b - true if hide mode should be enabled; false otherwise

isConceptViewHideModeEnabled

boolean isConceptViewHideModeEnabled()

Indicates if hide mode is enabled, so restricted data will be hidden from view.

Returns:

true if hide mode is enabled false otherwise

setConceptViewHighlightModeEnabled

void setConceptViewHighlightModeEnabled(boolean b)

Sets highlight mode to be enabled, so restricted data will be highlighted when viewed.

Parameters:

b - true if highlight mode is enabled false otherwise

isConceptViewHighlightModeEnabled

boolean isConceptViewHighlightModeEnabled()

Indicates if highlight mode is enabled, so restricted data will be highlighted when viewed.

Returns:

true if highlight mode is enabled false otherwise

getStyleLegend

String getStyleLegend()

Returns a HTML string containing a key for how elements from the browser restrictor should be displayed, indicating the color and font style.

Returns:

legend indicating color and font style meanings

getColor

List<Color> getColor(Object o)

Returns a List of Colors for which the given parameter matches in the BrowserRestrictor's key.

Parameters:

o - Object

Returns:

list of colors

getStyle

List<String> getStyle(Object o)

Returns a List of font styles for which the given parameter matches in the BrowserRestrictor's key.

Parameters:

o - Object

Returns:

list of styles, such as bold, underline, italic, regular