gov.nih.nci.caarray.domain.data
Interface ArrayDataTypeDescriptor


public interface ArrayDataTypeDescriptor

Interface that enums of specific supported array data types must implement in order to register potentially new ArrayDataTypes with caArray.


Method Summary
 java.lang.String getName()
          Returns the name of this data type for display in the application (e.g.
 java.util.List<QuantitationTypeDescriptor> getQuantitationTypes()
          Returns the complete set of quantitation types that might be returned from a data file of this type.
 java.lang.String getVersion()
          Returns the version of this data type.
 boolean isEquivalent(ArrayDataType arrayDataType)
          Indicates whether the ArrayDataType given is equivalent to this descriptor, matching on name and version.
 

Method Detail

getName

java.lang.String getName()
Returns the name of this data type for display in the application (e.g. "Affymetrix CEL").

Returns:
the data type name.

getVersion

java.lang.String getVersion()
Returns the version of this data type. This may be null if there is only one handler for a given type. If different handlers are required for different versions (e.g. GenePix GPR versions differ in the QuantitationTypes that may be returned), then different versions should be registered that use the same name (e.g. "Genepix, Version 3.0", "Genepix, Version 4.0", etc.).

Returns:
the version.

getQuantitationTypes

java.util.List<QuantitationTypeDescriptor> getQuantitationTypes()
Returns the complete set of quantitation types that might be returned from a data file of this type.

Returns:
the quantitation types.

isEquivalent

boolean isEquivalent(ArrayDataType arrayDataType)
Indicates whether the ArrayDataType given is equivalent to this descriptor, matching on name and version.

Parameters:
arrayDataType - the type to check
Returns:
true if equivalent to this descriptor, false otherwise.