gov.nih.nlm.mms.filters
Class AbstractFilter

java.lang.Object
  gov.nih.nlm.mms.AbstractGUIConfigurable
      gov.nih.nlm.mms.filters.AbstractFilter

All Implemented Interfaces:

Configurable, Filter, GUIConfigurable, SubsetListener, Comparable

Direct Known Subclasses:

AttributeTypesToRemoveFilter, ContentViewFilter, LanguagesToRemoveFilter, PrecedenceFilter, RelationshipTypesToRemoveFilter, RemoveByTermgroupFilter, SemanticTypesToRemoveFilter, SourcesToRemoveFilter, SuppressibleTermgroupsFilter

public abstract class AbstractFilter
extends AbstractGUIConfigurable
implements Filter

This is an abstract implementation of the filter class that manages the mechanisms for handling data changes.

Author:

Brian Carlsen

Field Summary

protected boolean	init_cui
protected boolean	subset_content
protected List<String>	warnings

Fields inherited from class gov.nih.nlm.mms.AbstractGUIConfigurable

data_changed, default_configuration, listeners, user_configuration

Constructor Summary

AbstractFilter()

Method Summary

void	applyFilter(Concept concept) Deprecated. Use one of the sub-interfaces instead
void	beginInitializeCuiList() Informs SubsetListener that the Initialize Cui List phase is starting.
void	beginSubsetContent() Informs SubsetListener that the Subset Content phase is starting.
void	endInitializeCuiList() Informs SubsetListener that the Initialize Cui List phase is ending.
void	endSubsetContent() Informs SubsetListener that the Subset Content phase is ending.
protected void	fireDataChanged() Enables filters to inform listeners of data changed event.
protected void	fireNotUndoableDataChanged() Enables filters to indicate that data has changed without notifying the listeners or making this change undoable.
String	getValidateMessage() This method is the default message for filters that don't check for validity.
String[]	getWarnings() Returns a String[] of warnings accumulated during processing of the input stream.
void	setCuiList(CuiList cui_list) Provides filter access to the cui list.

Methods inherited from class gov.nih.nlm.mms.AbstractGUIConfigurable

addDataChangeListener, addValidationError, addValidationWarning, clearValidationErrors, clearValidationWarnings, compareTo, getColor, getConfigurationDetails, getGUIConfigurableForValidationFailure, getHelpPanel, getName, getPanel, getProperties, getTabDescription, getValidationErrors, getValidationWarnings, hasAdvancedOptions, hasDataChanged, removeDataChangeListener, resetDataChanged, resetToDefaults, setConfiguration, setConfiguration, setDataChanged, setPanelSelections, setProperties, showOptions, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface gov.nih.nlm.mms.filters.Filter

isEfficientEnabled

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

Field Detail

init_cui

protected boolean init_cui

subset_content

protected boolean subset_content

warnings

protected List<String> warnings

Constructor Detail

AbstractFilter

public AbstractFilter()

Method Detail

fireNotUndoableDataChanged

protected void fireNotUndoableDataChanged()

Enables filters to indicate that data has changed without notifying the listeners or making this change undoable.

getValidateMessage

public String getValidateMessage()

This method is the default message for filters that don't check for validity. This won't be called on a valid filter.

Returns:

String

setCuiList

public void setCuiList(CuiList cui_list)

Provides filter access to the cui list.

Specified by:

setCuiList in interface SubsetListener

Parameters:

cui_list - CuiList

beginInitializeCuiList

public void beginInitializeCuiList()

Informs SubsetListener that the Initialize Cui List phase is starting.

Specified by:

beginInitializeCuiList in interface SubsetListener

endInitializeCuiList

public void endInitializeCuiList()

Informs SubsetListener that the Initialize Cui List phase is ending.

Specified by:

endInitializeCuiList in interface SubsetListener

beginSubsetContent

public void beginSubsetContent()

Informs SubsetListener that the Subset Content phase is starting.

Specified by:

beginSubsetContent in interface SubsetListener

endSubsetContent

public void endSubsetContent()

Informs SubsetListener that the Subset Content phase is ending.

Specified by:

endSubsetContent in interface SubsetListener

applyFilter

public void applyFilter(Concept concept)

Deprecated. Use one of the sub-interfaces instead

Method which removes a given Concept or its components from the release. Called during the subsetting process.

Specified by:

applyFilter in interface Filter

Parameters:

concept - Concept

getWarnings

public String[] getWarnings()

Returns a String[] of warnings accumulated during processing of the input stream.

Specified by:

getWarnings in interface Filter

Returns:

String[] of warnings

fireDataChanged

protected void fireDataChanged()

Enables filters to inform listeners of data changed event.

Overrides:

fireDataChanged in class AbstractGUIConfigurable