gov.nih.nci.mageom.domain.BioAssay.impl
Class ImageAcquisitionImpl

java.lang.Object
  extended by gov.nih.nci.mageom.domain.impl.MAGEOMObject
      extended by gov.nih.nci.mageom.domain.impl.ExtendableImpl
          extended by gov.nih.nci.mageom.domain.impl.DescribableImpl
              extended by gov.nih.nci.mageom.domain.impl.IdentifiableImpl
                  extended by gov.nih.nci.mageom.domain.BioEvent.impl.BioEventImpl
                      extended by gov.nih.nci.mageom.domain.BioAssay.impl.BioAssayTreatmentImpl
                          extended by gov.nih.nci.mageom.domain.BioAssay.impl.ImageAcquisitionImpl
All Implemented Interfaces:
BioAssayTreatment, ImageAcquisition, BioEvent, Describable, Extendable, Identifiable, java.io.Serializable

public class ImageAcquisitionImpl
extends BioAssayTreatmentImpl
implements ImageAcquisition

The process by which an image is generated (typically scanning).

Version:
%I%, %G%
See Also:
Serialized Form

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  Image[] images
          DOCUMENT ME
protected  int imagesCount
          The count of Image objects.
 
Fields inherited from class gov.nih.nci.mageom.domain.BioAssay.impl.BioAssayTreatmentImpl
physicalBioAssay, physicalBioAssayId, target, targetId
 
Fields inherited from class gov.nih.nci.mageom.domain.BioEvent.impl.BioEventImpl
protocolApplications, protocolApplicationsCount
 
Fields inherited from class gov.nih.nci.mageom.domain.impl.IdentifiableImpl
identifier, name
 
Fields inherited from class gov.nih.nci.mageom.domain.impl.DescribableImpl
auditTrail, auditTrailCount, descriptions, descriptionsCount, security, securityId
 
Fields inherited from class gov.nih.nci.mageom.domain.impl.ExtendableImpl
propertySets, propertySetsCount, securedElementId
 
Constructor Summary
ImageAcquisitionImpl()
          Default constructor
 
Method Summary
 Image[] getImages()
          Returns the value of this ImageAcquisition object's images attribute.
 int getImagesCount()
          Returns the count of all Image associated with this ImageAcquisition object.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 ImageAcquisition[] searchImageAcquisitions(ImageAcquisitionSearchCriteria criteria)
          Returns an array of ImageAcquisition objects that satisfy the given ImageAcquisitionSearchCriteria.
 void setImages(Image[] p_images)
          Sets the images attribute.
 java.lang.String toString()
          Returns a String representation of this object suitable for console display.
 org.w3c.dom.Element toXML(org.w3c.dom.Document doc)
           
 org.w3c.dom.Element toXMLDoc(org.w3c.dom.Document doc)
           
 org.w3c.dom.Element toXMLProcessor(org.w3c.dom.Document doc, java.util.ArrayList fillOutValues)
          Returns an XML representation of the object.
 
Methods inherited from class gov.nih.nci.mageom.domain.BioAssay.impl.BioAssayTreatmentImpl
getPhysicalBioAssay, getTarget, searchBioAssayTreatments, setPhysicalBioAssay, setTarget
 
Methods inherited from class gov.nih.nci.mageom.domain.BioEvent.impl.BioEventImpl
getProtocolApplications, getProtocolApplicationsCount, searchBioEvents, setProtocolApplications
 
Methods inherited from class gov.nih.nci.mageom.domain.impl.IdentifiableImpl
getIdentifier, getName, searchIdentifiables, setIdentifier, setName
 
Methods inherited from class gov.nih.nci.mageom.domain.impl.DescribableImpl
getAuditTrail, getAuditTrailCount, getDescriptions, getDescriptionsCount, getSecurity, searchDescribables, setAuditTrail, setDescriptions, setSecurity
 
Methods inherited from class gov.nih.nci.mageom.domain.impl.ExtendableImpl
getPropertySets, getPropertySetsCount, getSecuredElementId, searchExtendables, setPropertySets, setSecuredElementId
 
Methods inherited from class gov.nih.nci.mageom.domain.impl.MAGEOMObject
getId, getIsEditable, setId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface gov.nih.nci.mageom.domain.BioAssay.BioAssayTreatment
getPhysicalBioAssay, getTarget, setPhysicalBioAssay, setTarget
 
Methods inherited from interface gov.nih.nci.mageom.domain.BioEvent.BioEvent
getProtocolApplications, setProtocolApplications
 
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
 

Field Detail

allAssociationMethods

protected static java.util.ArrayList allAssociationMethods

associationMethods

protected static java.util.Hashtable associationMethods

imagesCount

protected int imagesCount
The count of Image objects.


images

protected Image[] images
DOCUMENT ME

Constructor Detail

ImageAcquisitionImpl

public ImageAcquisitionImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class BioAssayTreatmentImpl

searchImageAcquisitions

public ImageAcquisition[] searchImageAcquisitions(ImageAcquisitionSearchCriteria criteria)
                                           throws gov.nih.nci.common.search.SearchException
Returns an array of ImageAcquisition objects that satisfy the given ImageAcquisitionSearchCriteria.

Parameters:
criteria - The ImageAcquisitionSearchCriteria which represents a query for ImageAcquisition objects.
Returns:
An array of ImageAcquisition objects.
Throws:
A - gov.nih.nci.common.search.SearchException if there is a problem searching.
gov.nih.nci.common.search.SearchException

setImages

public void setImages(Image[] p_images)
Sets the images attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ImageAcquisition object.

Specified by:
setImages in interface ImageAcquisition
Parameters:
p_images - The new value for images.
See Also:
ImageAcquisition.getImages()

getImages

public Image[] getImages()
Description copied from interface: ImageAcquisition
Returns the value of this ImageAcquisition object's images attribute.

Specified by:
getImages in interface ImageAcquisition
Returns:
gov.nih.nci.mageom.bean.BioAssay.Image[] The value of images.
See Also:
ImageAcquisition.getImages()

getImagesCount

public int getImagesCount()
Returns the count of all Image associated with this ImageAcquisition object.

Returns:
the count
See Also:
ImageAcquisition.getImages()

toXML

public org.w3c.dom.Element toXML(org.w3c.dom.Document doc)
Overrides:
toXML in class BioAssayTreatmentImpl

toXMLDoc

public org.w3c.dom.Element toXMLDoc(org.w3c.dom.Document doc)
Overrides:
toXMLDoc in class BioAssayTreatmentImpl

toXMLProcessor

public org.w3c.dom.Element toXMLProcessor(org.w3c.dom.Document doc,
                                          java.util.ArrayList fillOutValues)
Returns an XML representation of the object. The document is not modified.

Overrides:
toXMLProcessor in class BioAssayTreatmentImpl
Parameters:
doc - the working document
fillOutValues - a list of attribute names that should have full XML for their values.
Returns:
org.w3c.dom.Element an XML representation

getXMLMethodDescriptors

public java.util.Hashtable getXMLMethodDescriptors()
Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.

Overrides:
getXMLMethodDescriptors in class BioAssayTreatmentImpl
Returns:
Hashtable The Hashtable of descriptors.

toString

public java.lang.String toString()
Returns a String representation of this object suitable for console display.

Overrides:
toString in class BioAssayTreatmentImpl
Returns:
the String representation.