gov.nih.nci.mageom.domain.Array
Interface Array

All Superinterfaces:
Describable, Extendable, Identifiable
All Known Implementing Classes:
ArrayImpl

public interface Array
extends Identifiable

The physical substrate along with its features and their annotation

Version:
%I%, %G%

Method Summary
 ArrayDesign getArrayDesign()
          Returns the value of this Array object's arrayDesign attribute.
 ArrayGroup getArrayGroup()
          Returns the value of this Array object's arrayGroup attribute.
 java.lang.String getArrayIdentifier()
          Returns the value of this Array object's arrayIdentifier attribute.
 ArrayManufactureDeviation[] getArrayManufactureDeviations()
          Returns the value of this Array object's arrayManufactureDeviations attribute.
 java.lang.Float getArrayXOrigin()
          Returns the value of this Array object's arrayXOrigin attribute.
 java.lang.Float getArrayYOrigin()
          Returns the value of this Array object's arrayYOrigin attribute.
 ArrayManufacture getInformation()
          Returns the value of this Array object's information attribute.
 java.lang.String getOriginRelativeTo()
          Returns the value of this Array object's originRelativeTo attribute.
 void setArrayDesign(ArrayDesign p_arrayDesign)
          Sets the arrayDesign attribute.
 void setArrayGroup(ArrayGroup p_arrayGroup)
          Sets the arrayGroup attribute.
 void setArrayIdentifier(java.lang.String p_arrayIdentifier)
          Sets the arrayIdentifier attribute.
 void setArrayManufactureDeviations(ArrayManufactureDeviation[] p_arrayManufactureDeviations)
          Sets the arrayManufactureDeviations attribute.
 void setArrayXOrigin(java.lang.Float p_arrayXOrigin)
          Sets the arrayXOrigin attribute.
 void setArrayYOrigin(java.lang.Float p_arrayYOrigin)
          Sets the arrayYOrigin attribute.
 void setInformation(ArrayManufacture p_information)
          Sets the information attribute.
 void setOriginRelativeTo(java.lang.String p_originRelativeTo)
          Sets the originRelativeTo attribute.
 
Methods inherited from interface gov.nih.nci.mageom.domain.Identifiable
getIdentifier, getName, setIdentifier, setName
 
Methods inherited from interface gov.nih.nci.mageom.domain.Describable
getAuditTrail, getDescriptions, getSecurity, setAuditTrail, setDescriptions, setSecurity
 
Methods inherited from interface gov.nih.nci.mageom.domain.Extendable
getPropertySets, setPropertySets
 

Method Detail

setArrayIdentifier

void setArrayIdentifier(java.lang.String p_arrayIdentifier)
Sets the arrayIdentifier attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Array object.

Parameters:
p_arrayIdentifier - The new value for arrayIdentifier.
See Also:
getArrayIdentifier()

getArrayIdentifier

java.lang.String getArrayIdentifier()
Returns the value of this Array object's arrayIdentifier attribute. Description of arrayIdentifier: An identifying string, e.g. a barcode.

Returns:
String The value of arrayIdentifier.

setArrayXOrigin

void setArrayXOrigin(java.lang.Float p_arrayXOrigin)
Sets the arrayXOrigin attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Array object.

Parameters:
p_arrayXOrigin - The new value for arrayXOrigin.
See Also:
getArrayXOrigin()

getArrayXOrigin

java.lang.Float getArrayXOrigin()
Returns the value of this Array object's arrayXOrigin attribute. Description of arrayXOrigin: This can indicate the x position on a slide, chip, etc. of the first Feature and is usually specified relative to the fiducial.

Returns:
float The value of arrayXOrigin.

setArrayYOrigin

void setArrayYOrigin(java.lang.Float p_arrayYOrigin)
Sets the arrayYOrigin attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Array object.

Parameters:
p_arrayYOrigin - The new value for arrayYOrigin.
See Also:
getArrayYOrigin()

getArrayYOrigin

java.lang.Float getArrayYOrigin()
Returns the value of this Array object's arrayYOrigin attribute. Description of arrayYOrigin: This can indicate the y position on a slide, chip, etc. of the first Feature and is usually specified relative to the fiducial.

Returns:
float The value of arrayYOrigin.

setOriginRelativeTo

void setOriginRelativeTo(java.lang.String p_originRelativeTo)
Sets the originRelativeTo attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Array object.

Parameters:
p_originRelativeTo - The new value for originRelativeTo.
See Also:
getOriginRelativeTo()

getOriginRelativeTo

java.lang.String getOriginRelativeTo()
Returns the value of this Array object's originRelativeTo attribute. Description of originRelativeTo: What the array origin is relative to, e.g. upper left corner, fiducial, etc.

Returns:
String The value of originRelativeTo.

setArrayDesign

void setArrayDesign(ArrayDesign p_arrayDesign)
Sets the arrayDesign attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Array object.

Parameters:
p_arrayDesign - The new value for arrayDesign.
See Also:
getArrayDesign()

getArrayDesign

ArrayDesign getArrayDesign()
Returns the value of this Array object's arrayDesign attribute.

Returns:
gov.nih.nci.mageom.bean.ArrayDesign.ArrayDesign The value of arrayDesign.
See Also:
ArrayDesign

setArrayGroup

void setArrayGroup(ArrayGroup p_arrayGroup)
Sets the arrayGroup attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Array object.

Parameters:
p_arrayGroup - The new value for arrayGroup.
See Also:
getArrayGroup()

getArrayGroup

ArrayGroup getArrayGroup()
Returns the value of this Array object's arrayGroup attribute.

Returns:
gov.nih.nci.mageom.bean.Array.ArrayGroup The value of arrayGroup.
See Also:
ArrayGroup

setInformation

void setInformation(ArrayManufacture p_information)
Sets the information attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Array object.

Parameters:
p_information - The new value for information.
See Also:
getInformation()

getInformation

ArrayManufacture getInformation()
Returns the value of this Array object's information attribute.

Returns:
gov.nih.nci.mageom.bean.Array.ArrayManufacture The value of information.
See Also:
ArrayManufacture

setArrayManufactureDeviations

void setArrayManufactureDeviations(ArrayManufactureDeviation[] p_arrayManufactureDeviations)
Sets the arrayManufactureDeviations attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Array object.

Parameters:
p_arrayManufactureDeviations - The new value for arrayManufactureDeviations.
See Also:
getArrayManufactureDeviations()

getArrayManufactureDeviations

ArrayManufactureDeviation[] getArrayManufactureDeviations()
Returns the value of this Array object's arrayManufactureDeviations attribute.

Returns:
gov.nih.nci.mageom.bean.Array.ArrayManufactureDeviation[] The value of arrayManufactureDeviations.
See Also:
ArrayManufactureDeviation