gov.nih.nlm.mms.browser
Class AtomDataSelector

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

public class AtomDataSelector
extends Object

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

Constructor Summary

AtomDataSelector()
Instantiates an empty AtomDataSelector.

Method Summary

AdditionalRelationshipLabel[]	getAdditionalRelationshipLabelSelection() Returns which AdditionalRelationshipLabels are to be retrieved on the Contexts, Mappings, or Relationships of the Concept.
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 AtomDataSelector	getIncludeAllDataSelector() Returns an AtomDataSelector indicating that all data should be included.
RelationshipLabel[]	getRelationshipLabelSelection() Returns which RelationshipLabels are used to select Mappings or Relationships of the Concept to be retrieved.
static AtomDataSelector	getRemoveAllDataSelector() Returns an AtomDataSelector indicating that all data should be 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.
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	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	isAttributes() Indicates whether or not to retrieve all Attributes 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	isRelationships() Indicates whether or not to retrieve all Relationships 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	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	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	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	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	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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AtomDataSelector

public AtomDataSelector()

Instantiates an empty AtomDataSelector.

Method Detail

getRemoveAllDataSelector

public static AtomDataSelector getRemoveAllDataSelector()

Returns an AtomDataSelector indicating that all data should be removed.

Returns:

AtomDataSelector

getIncludeAllDataSelector

public static AtomDataSelector getIncludeAllDataSelector()

Returns an AtomDataSelector indicating that all data should be included.

Returns:

AtomDataSelector

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;

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;

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;

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;

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;