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

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.BioAssay.impl.ImageImpl
All Implemented Interfaces:
Image, Describable, Extendable, Identifiable, java.io.Serializable

public class ImageImpl
extends IdentifiableImpl
implements Image

An image is created by an imageAcquisition event, typically by scanning the hybridized array (the PhysicalBioAssay).

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

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  Channel[] channels
          DOCUMENT ME
protected  int channelsCount
          The count of Channel objects.
protected  OntologyEntry format
          DOCUMENT ME
protected  java.lang.Long formatId
          The internal ID of the associated format object.
protected  java.lang.String URI
          The file location in which an image may be found.
 
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
ImageImpl()
          Default constructor
 
Method Summary
 Channel[] getChannels()
          Returns the value of this Image object's channels attribute.
 int getChannelsCount()
          Returns the count of all Channel associated with this Image object.
 OntologyEntry getFormat()
          Returns the value of this Image object's format attribute.
 java.lang.String getURI()
          Returns the value of this Image object's URI attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 Image[] searchImages(ImageSearchCriteria criteria)
          Returns an array of Image objects that satisfy the given ImageSearchCriteria.
 void setChannels(Channel[] p_channels)
          Sets the channels attribute.
 void setFormat(OntologyEntry p_format)
          Sets the format attribute.
 void setURI(java.lang.String p_URI)
          Sets the URI 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.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.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

URI

protected java.lang.String URI
The file location in which an image may be found.


channelsCount

protected int channelsCount
The count of Channel objects.


channels

protected Channel[] channels
DOCUMENT ME


format

protected OntologyEntry format
DOCUMENT ME


formatId

protected java.lang.Long formatId
The internal ID of the associated format object.

Constructor Detail

ImageImpl

public ImageImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class IdentifiableImpl

searchImages

public Image[] searchImages(ImageSearchCriteria criteria)
                     throws gov.nih.nci.common.search.SearchException
Returns an array of Image objects that satisfy the given ImageSearchCriteria.

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

setURI

public void setURI(java.lang.String p_URI)
Sets the URI attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Image object.

Specified by:
setURI in interface Image
Parameters:
p_URI - The new value for URI.
See Also:
Image.getURI()

getURI

public java.lang.String getURI()
Description copied from interface: Image
Returns the value of this Image object's URI attribute. Description of URI: The file location in which an image may be found.

Specified by:
getURI in interface Image
Returns:
String The value of URI.
See Also:
Image.getURI()

setChannels

public void setChannels(Channel[] p_channels)
Sets the channels attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Image object.

Specified by:
setChannels in interface Image
Parameters:
p_channels - The new value for channels.
See Also:
Image.getChannels()

getChannels

public Channel[] getChannels()
Description copied from interface: Image
Returns the value of this Image object's channels attribute.

Specified by:
getChannels in interface Image
Returns:
gov.nih.nci.mageom.bean.BioAssay.Channel[] The value of channels.
See Also:
Image.getChannels()

setFormat

public void setFormat(OntologyEntry p_format)
Sets the format attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Image object.

Specified by:
setFormat in interface Image
Parameters:
p_format - The new value for format.
See Also:
Image.getFormat()

getFormat

public OntologyEntry getFormat()
Description copied from interface: Image
Returns the value of this Image object's format attribute.

Specified by:
getFormat in interface Image
Returns:
gov.nih.nci.mageom.bean.Description.OntologyEntry The value of format.
See Also:
Image.getFormat()

getChannelsCount

public int getChannelsCount()
Returns the count of all Channel associated with this Image object.

Returns:
the count
See Also:
Image.getChannels()

toXML

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

toXMLDoc

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

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 IdentifiableImpl
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 IdentifiableImpl
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 IdentifiableImpl
Returns:
the String representation.