gov.nih.nlm.mms.filters
Class RelationshipTypesToRemoveFilter

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

All Implemented Interfaces:

Configurable, ConceptContentSelector, Filter, GUIConfigurable, SourcesToRemoveListener, SubsetListener, Comparable

public class RelationshipTypesToRemoveFilter
extends AbstractFilter
implements SourcesToRemoveListener, ConceptContentSelector

This Filter removes all CUIs with a given relationship type.

Author:

Deborah Shapiro

Field Summary

Fields inherited from class gov.nih.nlm.mms.filters.AbstractFilter

default_configuration, init_cui, subset_content, user_configuration, warnings

Constructor Summary

RelationshipTypesToRemoveFilter()
Every filter is required to have a no-arg constructor.

Method Summary

void	addRelationshipTypeToRemove(RelType relationship_type) This method adds a RelType to the data structure that holds the list of relationship types to be excluded.
void	applySelections(Concept concept) Method which determines if a given CUI will be removed from the release.
void	clearRelationshipTypesToRemove() This method clears the data structure that holds the list of relationship types to be excluded.
boolean	getAutomaticSelection() This method indicates whether the automatic_selection option has been chosen.
Color	getColor() Method indicates the Color that should be used to display the name.
String	getConfigurationDetails() Method returns a list of the relationship types to be excluded for display in the configuration file.
JPanel	getHelpPanel() Method provides a JPanel that will be added to the main GUI help menu to allow the user to consult a help window that is particular to this filter.
String	getName() Returns the name.
JPanel	getPanel() Method provides the GUI panel that will display the filter's screen as one of the tabs on the main GUI window.
Properties	getProperties() Method returns all properties specific to the filter.
RelType	getRelationshipTypeAtRow(int r) This method compensates for the RelTypes with sources to be excluded that are therefore not displayed in the attribute type table.
List	getRelationshipTypes() This method returns the List containing all RelTypes.
List	getRelationshipTypes(Source s) This method returns the List containing all RelTypes that share the same Source.
List	getRelationshipTypesToRemove() This method returns the List containing all RelTypes to be excluded.
Set	getRelTypesAsSet(Source s) This method returns the Set containing all RelTypes that share the same Source.
int	getRowForRelationshipType(RelType rt) This method compensates for the RelTypes with sources to be excluded that are therefore not displayed in the relationship type table.
String	getTabDescription() Method provides the description of the filter's screen and includes instructions on use.
boolean	isEfficientEnabled() Indicates if Filter can use the efficient mode during the "Initialize Cuis" phase of the subsetting process.
boolean	isRelationshipTypeToRemove(RelType relationship_type) This method returns true if the given RelType is on the list of those to be exluded from the subset.
void	removeRelationshipTypeToRemove(RelType relationship_type) This method removes a relationship_type from the data structure that holds the list of relationship_types to be excluded.
boolean	removeSelectedRelationships() This method indicates whether the selections represent relationship types to be excluded or relationship types to be kept.
void	resetToDefaults() Method allows the user to reset the filter's settings to defaults.
void	setConfiguration(ApplicationConfiguration c) Method provides the filter with values from the default properties file.
void	setConfiguration(UserConfiguration c) Method provides the filter with values from the user configuration file.
void	setPanelSelections() This method is responsible for selecting the rows of the table based on the properties for this filter.
void	setProperties(Properties props) Method provides the filter with all properties specific to the filter.
void	setRelationshipTypesToRemove(List rtr) This method replaces the list of RelTypes to exclude with the one provided.
void	setRemoveSelectedRelationships(boolean b) This method sets whether or not the selections represent relationship types to be excluded or relationship types to be kept.
void	sourcesToRemoveChanged(SourcesToRemoveEvent e) This method is called when there is a change to the selections on the sources to exclude tab.

Methods inherited from class gov.nih.nlm.mms.filters.AbstractFilter

addDataChangeListener, applyFilter, beginInitializeCuiList, beginSubsetContent, compareTo, endInitializeCuiList, endSubsetContent, fireDataChanged, fireNotUndoableDataChanged, getGUIConfigurableForValidationFailure, getValidateMessage, getValidationErrors, getValidationWarnings, getWarnings, hasAdvancedOptions, hasDataChanged, removeDataChangeListener, resetDataChanged, setCuiList, setDataChanged, 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

applyFilter, getWarnings

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

addDataChangeListener, getGUIConfigurableForValidationFailure, getValidationErrors, getValidationWarnings, hasAdvancedOptions, hasDataChanged, removeDataChangeListener, resetDataChanged, setDataChanged, showOptions, validate

Methods inherited from interface java.lang.Comparable

compareTo

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

beginInitializeCuiList, beginSubsetContent, endInitializeCuiList, endSubsetContent, setCuiList

Constructor Detail

RelationshipTypesToRemoveFilter

public RelationshipTypesToRemoveFilter()

Every filter is required to have a no-arg constructor.

Method Detail

getPanel

public JPanel getPanel()

Method provides the GUI panel that will display the filter's screen as one of the tabs on the main GUI window. The code can assume that this method is called after setConfiguration(ApplicationConfiguration) and setProperties(Properties). There is no data change as a result of calling this method.

Specified by:

getPanel in interface GUIConfigurable

Returns:

JPanel that displays graphical interface for the filter

setPanelSelections

public void setPanelSelections()

This method is responsible for selecting the rows of the table based on the properties for this filter.

Specified by:

setPanelSelections in interface GUIConfigurable

getTabDescription

public String getTabDescription()

Method provides the description of the filter's screen and includes instructions on use.

Specified by:

getTabDescription in interface GUIConfigurable

Returns:

String text of instructions for use of panel

resetToDefaults

public void resetToDefaults()

Method allows the user to reset the filter's settings to defaults.

Specified by:

resetToDefaults in interface Configurable

getHelpPanel

public JPanel getHelpPanel()

Method provides a JPanel that will be added to the main GUI help menu to allow the user to consult a help window that is particular to this filter.

Specified by:

getHelpPanel in interface GUIConfigurable

Overrides:

getHelpPanel in class AbstractFilter

Returns:

JPanel to be added to the Options menu

setConfiguration

public void setConfiguration(ApplicationConfiguration c)

Method provides the filter with values from the default properties file. This is the first method called after the class is constructed.

Specified by:

setConfiguration in interface Configurable

Overrides:

setConfiguration in class AbstractFilter

Parameters:

c - ApplicationConfiguration default values

getProperties

public Properties getProperties()

Method returns all properties specific to the filter.

Specified by:

getProperties in interface Configurable

Returns:

Properties only those directly restyed to the filter. They will start with the filter's class name which will be concatenated to the name of the property. Filter.property_name

setProperties

public void setProperties(Properties props)

Method provides the filter with all properties specific to the filter.

Specified by:

setProperties in interface Configurable

Parameters:

props - Properties

applySelections

public void applySelections(Concept concept)

Method which determines if a given CUI will be removed from the release.

Specified by:

applySelections in interface ConceptContentSelector

Parameters:

concept - Concept

getName

public String getName()

Returns the name.

Specified by:

getName in interface GUIConfigurable

Returns:

String

getConfigurationDetails

public String getConfigurationDetails()

Method returns a list of the relationship types to be excluded for display in the configuration file.

Specified by:

getConfigurationDetails in interface Configurable

Returns:

String

getRelationshipTypes

public List getRelationshipTypes()

This method returns the List containing all RelTypes.

Returns:

List of RelTypes

getRelationshipTypes

public List getRelationshipTypes(Source s)

This method returns the List containing all RelTypes that share the same Source.

Parameters:

s - Source

Returns:

List of RelTypes

getRelTypesAsSet

public Set getRelTypesAsSet(Source s)

This method returns the Set containing all RelTypes that share the same Source.

Parameters:

s - Source

Returns:

Set of RelTypes

clearRelationshipTypesToRemove

public void clearRelationshipTypesToRemove()

This method clears the data structure that holds the list of relationship types to be excluded.

addRelationshipTypeToRemove

public void addRelationshipTypeToRemove(RelType relationship_type)

This method adds a RelType to the data structure that holds the list of relationship types to be excluded.

Parameters:

relationship_type - RelType

removeRelationshipTypeToRemove

public void removeRelationshipTypeToRemove(RelType relationship_type)

This method removes a relationship_type from the data structure that holds the list of relationship_types to be excluded.

Parameters:

relationship_type - RelType

isRelationshipTypeToRemove

public boolean isRelationshipTypeToRemove(RelType relationship_type)

This method returns true if the given RelType is on the list of those to be exluded from the subset.

Parameters:

relationship_type - RelType

Returns:

boolean

getRelationshipTypesToRemove

public List getRelationshipTypesToRemove()

This method returns the List containing all RelTypes to be excluded.

Returns:

List

setRelationshipTypesToRemove

public void setRelationshipTypesToRemove(List rtr)

This method replaces the list of RelTypes to exclude with the one provided.

Parameters:

rtr - List of RelTypes

removeSelectedRelationships

public boolean removeSelectedRelationships()

This method indicates whether the selections represent relationship types to be excluded or relationship types to be kept.

Returns:

true selected relationship types will be excluded false selected relationship types will be kept

setRemoveSelectedRelationships

public void setRemoveSelectedRelationships(boolean b)

This method sets whether or not the selections represent relationship types to be excluded or relationship types to be kept.

Parameters:

b - boolean

getAutomaticSelection

public boolean getAutomaticSelection()

This method indicates whether the automatic_selection option has been chosen. Automatic selection allows the application to select relationship types sharing the same source without prompting the user.

Returns:

automatic_selection booleantrue false

setConfiguration

public void setConfiguration(UserConfiguration c)

Method provides the filter with values from the user configuration file.

Specified by:

setConfiguration in interface Configurable

Overrides:

setConfiguration in class AbstractFilter

Parameters:

c - UserConfiguration

getRowForRelationshipType

public int getRowForRelationshipType(RelType rt)

This method compensates for the RelTypes with sources to be excluded that are therefore not displayed in the relationship type table.

Parameters:

rt - RelType

Returns:

int row where given RelType is displayed

getRelationshipTypeAtRow

public RelType getRelationshipTypeAtRow(int r)

This method compensates for the RelTypes with sources to be excluded that are therefore not displayed in the attribute type table.

Parameters:

r - int row number where RelType is requested

Returns:

RelType at given row

sourcesToRemoveChanged

public void sourcesToRemoveChanged(SourcesToRemoveEvent e)

This method is called when there is a change to the selections on the sources to exclude tab. It resets the relationship type table model to only include those attribute types that are not from excluded sources.

Specified by:

sourcesToRemoveChanged in interface SourcesToRemoveListener

Parameters:

e - SourcesToRemoveEvent

getColor

public Color getColor()

Method indicates the Color that should be used to display the name.

Specified by:

getColor in interface GUIConfigurable

Overrides:

getColor in class AbstractFilter

Returns:

Color

isEfficientEnabled

public boolean isEfficientEnabled()

Indicates if Filter can use the efficient mode during the "Initialize Cuis" phase of the subsetting process. The efficient mode reads only MRCONSO and MRSTY during the "Initialize Cuis" phase.

Specified by:

isEfficientEnabled in interface Filter

Returns:

true if efficient mode is acceptable false if efficient mode is not acceptable