gov.nih.nci.mageom.domain.Array.impl
Class FiducialImpl

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.Array.impl.FiducialImpl
All Implemented Interfaces:
Fiducial, Describable, Extendable, java.io.Serializable

public class FiducialImpl
extends DescribableImpl
implements Fiducial

A marking on the surface of the array that can be used to identify the array's origin, the coordinates of which are the fiducial's centroid.

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

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  DistanceUnit distanceUnit
          DOCUMENT ME
protected  java.lang.Long distanceUnitId
          The internal ID of the associated distanceUnit object.
protected  OntologyEntry fiducialType
          DOCUMENT ME
protected  java.lang.Long fiducialTypeId
          The internal ID of the associated fiducialType object.
protected  Position position
          DOCUMENT ME
protected  java.lang.Long positionId
          The internal ID of the associated position object.
 
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
FiducialImpl()
          Default constructor
 
Method Summary
 DistanceUnit getDistanceUnit()
          Returns the value of this Fiducial object's distanceUnit attribute.
 OntologyEntry getFiducialType()
          Returns the value of this Fiducial object's fiducialType attribute.
 Position getPosition()
          Returns the value of this Fiducial object's position attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 Fiducial[] searchFiducials(FiducialSearchCriteria criteria)
          Returns an array of Fiducial objects that satisfy the given FiducialSearchCriteria.
 void setDistanceUnit(DistanceUnit p_distanceUnit)
          Sets the distanceUnit attribute.
 void setFiducialType(OntologyEntry p_fiducialType)
          Sets the fiducialType attribute.
 void setPosition(Position p_position)
          Sets the position 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.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.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

distanceUnit

protected DistanceUnit distanceUnit
DOCUMENT ME


distanceUnitId

protected java.lang.Long distanceUnitId
The internal ID of the associated distanceUnit object.


fiducialType

protected OntologyEntry fiducialType
DOCUMENT ME


fiducialTypeId

protected java.lang.Long fiducialTypeId
The internal ID of the associated fiducialType object.


position

protected Position position
DOCUMENT ME


positionId

protected java.lang.Long positionId
The internal ID of the associated position object.

Constructor Detail

FiducialImpl

public FiducialImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class DescribableImpl

searchFiducials

public Fiducial[] searchFiducials(FiducialSearchCriteria criteria)
                           throws gov.nih.nci.common.search.SearchException
Returns an array of Fiducial objects that satisfy the given FiducialSearchCriteria.

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

setDistanceUnit

public void setDistanceUnit(DistanceUnit p_distanceUnit)
Sets the distanceUnit attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Fiducial object.

Specified by:
setDistanceUnit in interface Fiducial
Parameters:
p_distanceUnit - The new value for distanceUnit.
See Also:
Fiducial.getDistanceUnit()

getDistanceUnit

public DistanceUnit getDistanceUnit()
Description copied from interface: Fiducial
Returns the value of this Fiducial object's distanceUnit attribute.

Specified by:
getDistanceUnit in interface Fiducial
Returns:
gov.nih.nci.mageom.bean.Measurement.DistanceUnit The value of distanceUnit.
See Also:
Fiducial.getDistanceUnit()

setFiducialType

public void setFiducialType(OntologyEntry p_fiducialType)
Sets the fiducialType attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Fiducial object.

Specified by:
setFiducialType in interface Fiducial
Parameters:
p_fiducialType - The new value for fiducialType.
See Also:
Fiducial.getFiducialType()

getFiducialType

public OntologyEntry getFiducialType()
Description copied from interface: Fiducial
Returns the value of this Fiducial object's fiducialType attribute.

Specified by:
getFiducialType in interface Fiducial
Returns:
gov.nih.nci.mageom.bean.Description.OntologyEntry The value of fiducialType.
See Also:
Fiducial.getFiducialType()

setPosition

public void setPosition(Position p_position)
Sets the position attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Fiducial object.

Specified by:
setPosition in interface Fiducial
Parameters:
p_position - The new value for position.
See Also:
Fiducial.getPosition()

getPosition

public Position getPosition()
Description copied from interface: Fiducial
Returns the value of this Fiducial object's position attribute.

Specified by:
getPosition in interface Fiducial
Returns:
gov.nih.nci.mageom.bean.DesignElement.Position The value of position.
See Also:
Fiducial.getPosition()

toXML

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

toXMLDoc

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

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