org.geworkbench.bison.datastructure.properties
Interface DSExtendable

All Known Subinterfaces:
DSAlignmentResultSet, DSAncillaryDataSet<T>, DSAnovaResultSet<T>, DSBioObject, DSClusterDataSet, DSDataSet<T>, DSDemandResultSet, DSGSEAResultDataSet, DSHierClusterDataSet, DSMasterRagulatorResultSet<T>, DSMasterRegulatorTableResultSet, DSMatrixReduceExperiment, DSMatrixReduceSet, DSMicroarray, DSMicroarraySet, DSPCADataSet, DSPositionSpecificAffintyMatrix, DSProbeIntensityArray, DSProteinStructure, DSSequence, DSSequenceSet<T>, DSSignificanceResultSet<T>, DSSOMClusterDataSet, DSTTestResultSet<T>
All Known Implementing Classes:
AdjacencyMatrixDataSet, AracneResult, CSAlignmentResultSet, CSAncillaryDataSet, CSAnovaResultSet, CSClassifier, CSDataSet, CSDemandResultSet, CSExtendable, CSGSEAResultDataSet, CSHierClusterDataSet, CSMasterRegulatorResultSet, CSMasterRegulatorTableResultSet, CSMatrixReduceExperiment, CSMatrixReduceSet, CSMicroarray, CSMicroarraySet, CSPCADataSet, CSPositionSpecificAffinityMatrix, CSProbeIntensityArray, CSProteinStructure, CSSequence, CSSequenceSet, CSSignificanceResultSet, CSSOMClusterDataSet, CSTTestResultSet, CSVisualClassifier, EdgeListDataSet, FoldChangeResult, GoAnalysisResult, IdeaResultDataSet, ImageData, KMeansResult, KMeansResultMarkers, LincsDataSet, MarkUsResultDataSet, MedusaDataSet, MindyDataSet, NetBoostDataSet, PatternResult, PudgeResultSet, SamResultData, SelectorResult, SkybaseResultSet, SkyLineResultDataSet, SVMResultSet

public interface DSExtendable

Copyright: Copyright (c) 2003

Company: First Genetic Trust Inc.

The concept behind interface DSExtendable is borrowed directly from the definition of the Extendable interface in MAGE-OM. It provides a generic mechanism for attaching arbitrary infromation (in the form of name-value pairs) to an implementing class. Since the semanitcs of such information is use-specific, scant use of this mechanism is advisable.

Version:
1.0
Author:
First Genetic Trust Inc.

Method Summary
 void addNameValuePair(java.lang.String name, java.lang.Object value)
          Adds a new name-value mapping.
 void allowMultipleValues(java.lang.String name)
          Conjugate method for forceUniqueValue.
 void clearName(java.lang.String name)
          Removes all values associated with the given name.
 void forceUniqueValue(java.lang.String name)
          Forces that the name be associated with at most one value.
 java.lang.Object[] getValuesForName(java.lang.String name)
          Returns all values mapped to the designated name.
 boolean isUniqueValue(java.lang.String name)
          Check if forceUniqueValue() is in effect for the designated name.
 

Method Detail

addNameValuePair

void addNameValuePair(java.lang.String name,
                      java.lang.Object value)
Adds a new name-value mapping.

Parameters:
name -
value -

getValuesForName

java.lang.Object[] getValuesForName(java.lang.String name)
Returns all values mapped to the designated name.

Parameters:
name -
Returns:
All values associated with the argument name.

forceUniqueValue

void forceUniqueValue(java.lang.String name)
Forces that the name be associated with at most one value. Attempting to add a name-value pair for a 'name' that already has an associate value, results in old name-value association be replaced by the new one.

Calling this method for an existing 'name' results in all the associated name-value pairs to be cleared.

Parameters:
name - The 'name' upon which uniqueness of value will be enforced.

allowMultipleValues

void allowMultipleValues(java.lang.String name)
Conjugate method for forceUniqueValue. Enables a 'name' to accept mulptiple name-value asscociations.

Parameters:
name - The 'name' for which multiplicity of value is enabled.

isUniqueValue

boolean isUniqueValue(java.lang.String name)
Check if forceUniqueValue() is in effect for the designated name.

Parameters:
name -
Returns:

clearName

void clearName(java.lang.String name)
Removes all values associated with the given name.

Parameters:
name -