gov.nih.nlm.mms.browser
Class ConceptDataSelector

java.lang.Object
  gov.nih.nlm.mms.browser.ConceptDataSelector

public class ConceptDataSelector
extends Object

This class is used for Concept or Atom retrieval, to specify how much information should be kept.

Constructor Summary

ConceptDataSelector()
Constructor

Method Summary

AdditionalRelationshipLabel[]	getAdditionalRelationshipLabelSelection() Returns which AdditionalRelationshipLabels are to be retrieved on the Contexts, Mappings, or Relationships of the Concept.
static ConceptDataSelector	getAtomsOnlyDataSelector() Returns a ConceptDataSelector containing only atoms.
AttributeName[]	getAttributeNameSelection() Returns which AttributeNames are to be retrieved on the Mappings or Attributes of the Concept.
CoocurrenceType[]	getCoocurrenceTypeSelection() Returns which CoocurrenceTypes are to be used to select Coocurrences of the Concept to retrieve.
static ConceptDataSelector	getIncludeAllDataSelector() Returns a ConceptDataSelector containing all Concept data.
Language[]	getLanguageSelection() Returns which Languages are to used to select which Atoms of the Concept are to be retrieved.
RelationshipLabel[]	getRelationshipLabelSelection() Returns which RelationshipLabels are used to select Mappings or Relationships of the Concept to be retrieved.
static ConceptDataSelector	getRemoveAllDataSelector() Returns a ConceptDataSelector with all data removed.
Source[]	getSourceSelection() Returns Sources from which elements of the Concept are to be retrieved.
Suppressible[]	getSuppressibleSelection() Returns which Suppressibles are used to select Atoms, Attributes, Definitions, or Relationships of the Concept to be retrieved.
TermTypeGroup[]	getTermTypeGroupSelection() Returns which TermTypeGroups and therefore which TermTypes are to be used to select Atoms of the Concept to retrieve.
TermType[]	getTermTypeSelection() Returns which TermTypes are used to select Atoms of the Concept to retrieve.
boolean	isAllAdditionalRelationshipLabels() Indicates whether or not to retrieve all AdditionalRelationshipLabels of the Contexts, Mappings, or Relationships of the Concept.
boolean	isAllAttributeNames() Indicates whether or not to retrieve all AttributeNames of the Mappings or Attributes of the Concept.
boolean	isAllCoocurrenceTypes() Indicates whether or not to use all CoocurrenceTypes to select Coocurrences of the Concept to retrieve.
boolean	isAllLanguages() Indicates whether or not to use all Languages when selecting Atoms of the Concept to retrieve.
boolean	isAllRelationshipLabels() Indicates whether or not to use all RelationshipLabels to select Mappings or Relationships of the Concept to retrieve.
boolean	isAllSources() Indicates whether or not to retrieve elements of the Concept from all Sources.
boolean	isAllSuppressibles() Indicates whether or not to use all Suppressibles to select Atoms, Attributes, Definitions, or Relationships of the Concept to retrieve.
boolean	isAllTermTypeGroups() Indicates whether or not to use all TermTypes which belong to a TermTypeGroup to select Atoms of the Concept to retrieve.
boolean	isAllTermTypes() Indicates whether or not to use all TermTypes to select Atoms of the Concept to retrieve.
boolean	isAtoms() Indicates whether or not to retrieve all Atoms of the Concept.
boolean	isAttributes() Indicates whether or not to retrieve all Attributes of the Concept.
boolean	isComponentHistories() Indicates whether or not to retrieve all ComponentHistorys of the Concept.
boolean	isContexts() Indicates whether or not to retrieve all Contexts of the Concept.
boolean	isCoocurrences() Indicates whether or not to retrieve all Coocurrences of the Concept.
boolean	isDefinitions() Indicates whether or not to retrieve all Definitions of the Concept.
boolean	isMappings() Indicates whether or not to retrieve all Mappings of the Concept.
boolean	isRelationships() Indicates whether or not to retrieve all Relationships of the Concept.
boolean	isSemanticTypes() Indicates whether or not to retrieve all SemanticTypes of the Concept.
void	setAdditionalRelationshipLabelSelection(AdditionalRelationshipLabel[] additionalRelationshipLabelSelection) Sets which AdditionalRelationshipLabels are to be retrieved on the Contexts, Mappings, or Relationships of the Concept.
void	setAllAdditionalRelationshipLabels(boolean allAdditionalRelationshipLabels) Sets whether or not to retrieve all AdditionalRelationshipLabels of the Contexts, Mappings, or Relationships of the Concept.
void	setAllAttributeNames(boolean allAttributeNames) Sets whether or not to retrieve all AttributeNames of the Mappings or Attributes of the Concept.
void	setAllCoocurrenceTypes(boolean allCoocurrenceTypes) Sets whether or not to use all CoocurrenceTypes to select Coocurrences of the Concept to retrieve.
void	setAllLanguages(boolean allLanguages) Sets whether or not to use all Languages when selecting Atoms of the Concept to retrieve.
void	setAllRelationshipLabels(boolean allRelationshipLabels) Sets whether or not to use all RelationshipLabels to select Mappings or Relationships of the Concept to retrieve.
void	setAllSources(boolean allSources) Sets whether or not to retrieve elements of the Concept from all Sources.
void	setAllSuppressibles(boolean allSuppressibles) Sets whether or not to use all Suppressibles to select Atoms, Attributes, Definitions, or Relationships of the Concept to retrieve.
void	setAllTermTypeGroups(boolean allTermTypeGroups) Sets whether or not to use all TermTypes which belong to a TermTypeGroup to select Atoms of the Concept to retrieve.
void	setAllTermTypes(boolean allTermTypes) Sets whether or not to use all TermTypes to select Atoms of the Concept to retrieve.
void	setAtoms(boolean atoms) Sets whether or not to retrieve all Atoms of the Concept.
void	setAttributeNameSelection(AttributeName[] attributeNameSelection) Sets which AttributeNames are to be retrieved on the Mappings or Attributes of the Concept.
void	setAttributes(boolean attributes) Sets whether or not to retrieve all Attributes of the Concept.
void	setComponentHistories(boolean componentHistories) Sets whether or not to retrieve all ComponentHistorys of the Concept.
void	setContexts(boolean contexts) Sets whether or not to retrieve all Contexts of the Concept.
void	setCoocurrences(boolean coocurrences) Sets whether or not to retrieve all Coocurrences of the Concept.
void	setCoocurrenceTypeSelection(CoocurrenceType[] coocurrenceTypeSelection) Sets which CoocurrenceTypes are to be used to select Coocurrences of the Concept.
void	setDefinitions(boolean definitions) Sets whether or not to retrieve all Definitions of the Concept.
void	setLanguageSelection(Language[] languageSelection) Sets which Languages are to be used to select which Atoms of the Concept are to be retrieved.
void	setMappings(boolean mappings) Sets whether or not to retrieve all Mappings of the Concept.
void	setRelationshipLabelSelection(RelationshipLabel[] relationshipLabelSelection) Sets which RelationshipLabels are used to select Mappings or Relationships of the Concept to be retrieved.
void	setRelationships(boolean relationships) Sets whether or not to retrieve all Relationships of the Concept.
void	setSemanticTypes(boolean semanticTypes) Sets whether or not to retrieve all SemanticTypes of the Concept.
void	setSourceSelection(Source[] sourceSelection) Sets Sources from which elements of the Concept are to be retrieved.
void	setSuppressibleSelection(Suppressible[] suppressibleSelection) Sets which Suppressibles are used to select Atoms, Attributes, Definitions, or Relationships of the Concept to be retrieved.
void	setTermTypeGroupSelection(TermTypeGroup[] termTypeGroupSelection) Sets which TermTypeGroups and therefore which TermTypes are to be used to select Atoms of the Concept to retrieve.
void	setTermTypeSelection(TermType[] termTypeSelection) Sets which TermTypes are used to select Atoms of the Concept to retrieve.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConceptDataSelector

public ConceptDataSelector()

Constructor

Method Detail

getRemoveAllDataSelector

public static ConceptDataSelector getRemoveAllDataSelector()

Returns a ConceptDataSelector with all data removed.

Returns:

ConceptDataSelector

getAtomsOnlyDataSelector

public static ConceptDataSelector getAtomsOnlyDataSelector()

Returns a ConceptDataSelector containing only atoms.

Returns:

ConceptDataSelector

getIncludeAllDataSelector

public static ConceptDataSelector getIncludeAllDataSelector()

Returns a ConceptDataSelector containing all Concept data.

Returns:

ConceptDataSelector

isAtoms

public boolean isAtoms()

Indicates whether or not to retrieve all Atoms of the Concept.

Returns:

true if all Atoms are to be retrieved; false if not.

setAtoms

public void setAtoms(boolean atoms)

Sets whether or not to retrieve all Atoms of the Concept.

Parameters:

atoms - true if all Atoms are to be retrieved; false if not;

isAttributes

public boolean isAttributes()

Indicates whether or not to retrieve all Attributes of the Concept.

Returns:

true if all Attributes are to be retrieved; false if not.

setAttributes

public void setAttributes(boolean attributes)

Sets whether or not to retrieve all Attributes of the Concept.

Parameters:

attributes - true if all Attributes are to be retrieved; false if not;

isComponentHistories

public boolean isComponentHistories()

Indicates whether or not to retrieve all ComponentHistorys of the Concept.

Returns:

true if all ComponentHistorys are to be retrieved; false if not.

setComponentHistories

public void setComponentHistories(boolean componentHistories)

Sets whether or not to retrieve all ComponentHistorys of the Concept.

Parameters:

componentHistories - true if all ComponentHistorys are to be retrieved; false if not;

isContexts

public boolean isContexts()

Indicates whether or not to retrieve all Contexts of the Concept.

Returns:

true if all Contexts are to be retrieved; false if not.

setContexts

public void setContexts(boolean contexts)

Sets whether or not to retrieve all Contexts of the Concept.

Parameters:

contexts - true if all Contexts are to be retrieved; false if not;

isCoocurrences

public boolean isCoocurrences()

Indicates whether or not to retrieve all Coocurrences of the Concept.

Returns:

true if all Coocurrences are to be retrieved; false if not.

setCoocurrences

public void setCoocurrences(boolean coocurrences)

Sets whether or not to retrieve all Coocurrences of the Concept.

Parameters:

coocurrences - true if all Coocurrences are to be retrieved; false if not;

isDefinitions

public boolean isDefinitions()

Indicates whether or not to retrieve all Definitions of the Concept.

Returns:

true if all Definitions are to be retrieved; false if not.

setDefinitions

public void setDefinitions(boolean definitions)

Sets whether or not to retrieve all Definitions of the Concept.

Parameters:

definitions - true if all Definitions are to be retrieved; false if not;

isMappings

public boolean isMappings()

Indicates whether or not to retrieve all Mappings of the Concept.

Returns:

true if all Mappings are to be retrieved; false if not.

setMappings

public void setMappings(boolean mappings)

Sets whether or not to retrieve all Mappings of the Concept.

Parameters:

mappings - true if all Mappings are to be retrieved; false if not;

isRelationships

public boolean isRelationships()

Indicates whether or not to retrieve all Relationships of the Concept.

Returns:

true if all Relationships are to be retrieved; false if not.

setRelationships

public void setRelationships(boolean relationships)

Sets whether or not to retrieve all Relationships of the Concept.

Parameters:

relationships - true if all Relationships are to be retrieved; false if not;

isSemanticTypes

public boolean isSemanticTypes()

Indicates whether or not to retrieve all SemanticTypes of the Concept.

Returns:

true if all SemanticTypes are to be retrieved; false if not.

setSemanticTypes

public void setSemanticTypes(boolean semanticTypes)

Sets whether or not to retrieve all SemanticTypes of the Concept.

Parameters:

semanticTypes - true if all SemanticTypes are to be retrieved; false if not;

getAdditionalRelationshipLabelSelection

public AdditionalRelationshipLabel[] getAdditionalRelationshipLabelSelection()

Returns which AdditionalRelationshipLabels are to be retrieved on the Contexts, Mappings, or Relationships of the Concept.

Returns:

array of (@link AdditionalRelationshipLabel}s to retrieve.

setAdditionalRelationshipLabelSelection

public void setAdditionalRelationshipLabelSelection(AdditionalRelationshipLabel[] additionalRelationshipLabelSelection)

Sets which AdditionalRelationshipLabels are to be retrieved on the Contexts, Mappings, or Relationships of the Concept.

Parameters:

additionalRelationshipLabelSelection - array of (@link AdditionalRelationshipLabel}s to retrieve.

isAllAdditionalRelationshipLabels

public boolean isAllAdditionalRelationshipLabels()

Indicates whether or not to retrieve all AdditionalRelationshipLabels of the Contexts, Mappings, or Relationships of the Concept.

Returns:

true if all AdditionalRelationshipLabels are to be retrieved; false if not.

setAllAdditionalRelationshipLabels

public void setAllAdditionalRelationshipLabels(boolean allAdditionalRelationshipLabels)

Sets whether or not to retrieve all AdditionalRelationshipLabels of the Contexts, Mappings, or Relationships of the Concept.

Parameters:

allAdditionalRelationshipLabels - true if all AdditionalRelationshipLabels are to be retrieved; false if not;

getAttributeNameSelection

public AttributeName[] getAttributeNameSelection()

Returns which AttributeNames are to be retrieved on the Mappings or Attributes of the Concept.

Returns:

array of (@link AttributeName}s to retrieve.

setAttributeNameSelection

public void setAttributeNameSelection(AttributeName[] attributeNameSelection)

Sets which AttributeNames are to be retrieved on the Mappings or Attributes of the Concept.

Parameters:

attributeNameSelection - array of (@link AttributeName}s to retrieve.

isAllAttributeNames

public boolean isAllAttributeNames()

Indicates whether or not to retrieve all AttributeNames of the Mappings or Attributes of the Concept.

Returns:

true if all AttributeNames are to be retrieved; false if not.

setAllAttributeNames

public void setAllAttributeNames(boolean allAttributeNames)

Sets whether or not to retrieve all AttributeNames of the Mappings or Attributes of the Concept.

Parameters:

allAttributeNames - true if all AttributeNames are to be retrieved; false if not;

getCoocurrenceTypeSelection

public CoocurrenceType[] getCoocurrenceTypeSelection()

Returns which CoocurrenceTypes are to be used to select Coocurrences of the Concept to retrieve.

Returns:

array of (@link CoocurrenceType}s to use for selection.

setCoocurrenceTypeSelection

public void setCoocurrenceTypeSelection(CoocurrenceType[] coocurrenceTypeSelection)

Sets which CoocurrenceTypes are to be used to select Coocurrences of the Concept.

Parameters:

coocurrenceTypeSelection - array of (@link CoocurrenceType}s to use for selection.

isAllCoocurrenceTypes

public boolean isAllCoocurrenceTypes()

Indicates whether or not to use all CoocurrenceTypes to select Coocurrences of the Concept to retrieve.

Returns:

true if Coocurrences of all CoocurrenceTypes are to be retrieved; false if not.

setAllCoocurrenceTypes

public void setAllCoocurrenceTypes(boolean allCoocurrenceTypes)

Sets whether or not to use all CoocurrenceTypes to select Coocurrences of the Concept to retrieve.

Parameters:

allCoocurrenceTypes - true if Coocurrences of all CoocurrenceTypes are to be retrieved; false if not;

getLanguageSelection

public Language[] getLanguageSelection()

Returns which Languages are to used to select which Atoms of the Concept are to be retrieved.

Returns:

array of (@link Language}s to retrieve.

setLanguageSelection

public void setLanguageSelection(Language[] languageSelection)

Sets which Languages are to be used to select which Atoms of the Concept are to be retrieved.

Parameters:

languageSelection - array of (@link Language}s to retrieve.

isAllLanguages

public boolean isAllLanguages()

Indicates whether or not to use all Languages when selecting Atoms of the Concept to retrieve.

Returns:

true if all Languages are to be retrieved; false if not.

setAllLanguages

public void setAllLanguages(boolean allLanguages)

Sets whether or not to use all Languages when selecting Atoms of the Concept to retrieve.

Parameters:

allLanguages - true if all Languages are to be retrieved; false if not;

getRelationshipLabelSelection

public RelationshipLabel[] getRelationshipLabelSelection()

Returns which RelationshipLabels are used to select Mappings or Relationships of the Concept to be retrieved.

Returns:

array of (@link RelationshipLabel}s to use for selection.

setRelationshipLabelSelection

public void setRelationshipLabelSelection(RelationshipLabel[] relationshipLabelSelection)

Sets which RelationshipLabels are used to select Mappings or Relationships of the Concept to be retrieved.

Parameters:

relationshipLabelSelection - array of (@link RelationshipLabel}s to use for selection.

isAllRelationshipLabels

public boolean isAllRelationshipLabels()

Indicates whether or not to use all RelationshipLabels to select Mappings or Relationships of the Concept to retrieve.

Returns:

true if all RelationshipLabels are to be used for selection; false if not.

setAllRelationshipLabels

public void setAllRelationshipLabels(boolean allRelationshipLabels)

Sets whether or not to use all RelationshipLabels to select Mappings or Relationships of the Concept to retrieve.

Parameters:

allRelationshipLabels - true if all RelationshipLabels are to be used for selection; false if not;

getSourceSelection

public Source[] getSourceSelection()

Returns Sources from which elements of the Concept are to be retrieved.

Returns:

array of (@link Source}s to retrieve.

setSourceSelection

public void setSourceSelection(Source[] sourceSelection)

Sets Sources from which elements of the Concept are to be retrieved.

Parameters:

sourceSelection - array of (@link Source}s to retrieve.

isAllSources

public boolean isAllSources()

Indicates whether or not to retrieve elements of the Concept from all Sources.

Returns:

true if elements from all Sources are to be be retrieved; false if not.

setAllSources

public void setAllSources(boolean allSources)

Sets whether or not to retrieve elements of the Concept from all Sources.

Parameters:

allSources - true if elements from all Sources are to be retrieved; false if not;

getSuppressibleSelection

public Suppressible[] getSuppressibleSelection()

Returns which Suppressibles are used to select Atoms, Attributes, Definitions, or Relationships of the Concept to be retrieved.

Returns:

array of (@link Suppressible}s to use for selection.

setSuppressibleSelection

public void setSuppressibleSelection(Suppressible[] suppressibleSelection)

Sets which Suppressibles are used to select Atoms, Attributes, Definitions, or Relationships of the Concept to be retrieved.

Parameters:

suppressibleSelection - array of (@link Suppressible}s to use for selection.

isAllSuppressibles

public boolean isAllSuppressibles()

Indicates whether or not to use all Suppressibles to select Atoms, Attributes, Definitions, or Relationships of the Concept to retrieve.

Returns:

true if all Suppressibles are to be used for selection; false if not.

setAllSuppressibles

public void setAllSuppressibles(boolean allSuppressibles)

Sets whether or not to use all Suppressibles to select Atoms, Attributes, Definitions, or Relationships of the Concept to retrieve.

Parameters:

allSuppressibles - true if all Suppressibles are to be used for selection; false if not;

getTermTypeSelection

public TermType[] getTermTypeSelection()

Returns which TermTypes are used to select Atoms of the Concept to retrieve.

Returns:

array of (@link TermType}s to retrieve.

setTermTypeSelection

public void setTermTypeSelection(TermType[] termTypeSelection)

Sets which TermTypes are used to select Atoms of the Concept to retrieve.

Parameters:

termTypeSelection - array of (@link TermType}s to retrieve.

isAllTermTypes

public boolean isAllTermTypes()

Indicates whether or not to use all TermTypes to select Atoms of the Concept to retrieve.

Returns:

true if all TermTypes are to be used for selection; false if not.

setAllTermTypes

public void setAllTermTypes(boolean allTermTypes)

Sets whether or not to use all TermTypes to select Atoms of the Concept to retrieve.

Parameters:

allTermTypes - true if all TermTypes are to be used for selection; false if not;

getTermTypeGroupSelection

public TermTypeGroup[] getTermTypeGroupSelection()

Returns which TermTypeGroups and therefore which TermTypes are to be used to select Atoms of the Concept to retrieve.

Returns:

array of (@link TermTypeGroup}s to retrieve.

setTermTypeGroupSelection

public void setTermTypeGroupSelection(TermTypeGroup[] termTypeGroupSelection)

Sets which TermTypeGroups and therefore which TermTypes are to be used to select Atoms of the Concept to retrieve.

Parameters:

termTypeGroupSelection - array of (@link TermTypeGroup}s to retrieve.

isAllTermTypeGroups

public boolean isAllTermTypeGroups()

Indicates whether or not to use all TermTypes which belong to a TermTypeGroup to select Atoms of the Concept to retrieve.

Returns:

true if all TermTypeGroups are to be used for selection; false if not.

setAllTermTypeGroups

public void setAllTermTypeGroups(boolean allTermTypeGroups)

Sets whether or not to use all TermTypes which belong to a TermTypeGroup to select Atoms of the Concept to retrieve.

Parameters:

allTermTypeGroups - true if all TermTypeGroups are to be used for selection; false if not;