gov.nih.nci.mageom.domain.DesignElement.impl
Class PositionImpl

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.DesignElement.impl.PositionImpl
All Implemented Interfaces:
Position, Extendable, java.io.Serializable

public class PositionImpl
extends ExtendableImpl
implements Position

Specifies a position on an array.

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  java.lang.Float x
          The horizontal distance from the upper left corner of the array.
protected  java.lang.Float y
          The vertical distance from the upper left corner of the array.
 
Fields inherited from class gov.nih.nci.mageom.domain.impl.ExtendableImpl
propertySets, propertySetsCount, securedElementId
 
Constructor Summary
PositionImpl()
          Default constructor
 
Method Summary
 DistanceUnit getDistanceUnit()
          Returns the value of this Position object's distanceUnit attribute.
 java.lang.Float getX()
          Returns the value of this Position object's x attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
 java.lang.Float getY()
          Returns the value of this Position object's y attribute.
protected  void init()
           
 Position[] searchPositions(PositionSearchCriteria criteria)
          Returns an array of Position objects that satisfy the given PositionSearchCriteria.
 void setDistanceUnit(DistanceUnit p_distanceUnit)
          Sets the distanceUnit attribute.
 void setX(java.lang.Float p_x)
          Sets the x attribute.
 void setY(java.lang.Float p_y)
          Sets the y 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.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.Extendable
getPropertySets, setPropertySets
 

Field Detail

allAssociationMethods

protected static java.util.ArrayList allAssociationMethods

associationMethods

protected static java.util.Hashtable associationMethods

x

protected java.lang.Float x
The horizontal distance from the upper left corner of the array.


y

protected java.lang.Float y
The vertical distance from the upper left corner of the array.


distanceUnit

protected DistanceUnit distanceUnit
DOCUMENT ME


distanceUnitId

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

Constructor Detail

PositionImpl

public PositionImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class ExtendableImpl

searchPositions

public Position[] searchPositions(PositionSearchCriteria criteria)
                           throws gov.nih.nci.common.search.SearchException
Returns an array of Position objects that satisfy the given PositionSearchCriteria.

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

setX

public void setX(java.lang.Float p_x)
Sets the x attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Position object.

Specified by:
setX in interface Position
Parameters:
p_x - The new value for x.
See Also:
Position.getX()

getX

public java.lang.Float getX()
Description copied from interface: Position
Returns the value of this Position object's x attribute. Description of x: The horizontal distance from the upper left corner of the array.

Specified by:
getX in interface Position
Returns:
float The value of x.
See Also:
Position.getX()

setY

public void setY(java.lang.Float p_y)
Sets the y attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Position object.

Specified by:
setY in interface Position
Parameters:
p_y - The new value for y.
See Also:
Position.getY()

getY

public java.lang.Float getY()
Description copied from interface: Position
Returns the value of this Position object's y attribute. Description of y: The vertical distance from the upper left corner of the array.

Specified by:
getY in interface Position
Returns:
float The value of y.
See Also:
Position.getY()

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 Position object.

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

getDistanceUnit

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

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

toXML

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

toXMLDoc

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

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