gov.nih.nci.mageom.domain.ArrayDesign.impl
Class ZoneImpl

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.ArrayDesign.impl.ZoneImpl
All Implemented Interfaces:
Zone, Describable, Extendable, Identifiable, java.io.Serializable

public class ZoneImpl
extends IdentifiableImpl
implements Zone

Specifies the location of a zone 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  java.lang.Integer column
          column position in the ZoneGroup.
protected  DistanceUnit distanceUnit
          DOCUMENT ME
protected  java.lang.Long distanceUnitId
          The internal ID of the associated distanceUnit object.
protected  java.lang.Float lowerRightX
          Boundary vertical lower right position relative to (0,0).
protected  java.lang.Float lowerRightY
          Boundary horizontal lower right position relative to (0,0).
protected  java.lang.Integer row
          row position in the ZoneGroup
protected  java.lang.Float upperLeftX
          Boundary vertical upper left position relative to (0,0).
protected  java.lang.Float upperLeftY
          Boundary horizontal upper left position relative to (0,0).
 
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
ZoneImpl()
          Default constructor
 
Method Summary
 java.lang.Integer getColumn()
          Returns the value of this Zone object's column attribute.
 DistanceUnit getDistanceUnit()
          Returns the value of this Zone object's distanceUnit attribute.
 java.lang.Float getLowerRightX()
          Returns the value of this Zone object's lowerRightX attribute.
 java.lang.Float getLowerRightY()
          Returns the value of this Zone object's lowerRightY attribute.
 java.lang.Integer getRow()
          Returns the value of this Zone object's row attribute.
 java.lang.Float getUpperLeftX()
          Returns the value of this Zone object's upperLeftX attribute.
 java.lang.Float getUpperLeftY()
          Returns the value of this Zone object's upperLeftY attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 Zone[] searchZones(ZoneSearchCriteria criteria)
          Returns an array of Zone objects that satisfy the given ZoneSearchCriteria.
 void setColumn(java.lang.Integer p_column)
          Sets the column attribute.
 void setDistanceUnit(DistanceUnit p_distanceUnit)
          Sets the distanceUnit attribute.
 void setLowerRightX(java.lang.Float p_lowerRightX)
          Sets the lowerRightX attribute.
 void setLowerRightY(java.lang.Float p_lowerRightY)
          Sets the lowerRightY attribute.
 void setRow(java.lang.Integer p_row)
          Sets the row attribute.
 void setUpperLeftX(java.lang.Float p_upperLeftX)
          Sets the upperLeftX attribute.
 void setUpperLeftY(java.lang.Float p_upperLeftY)
          Sets the upperLeftY 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

row

protected java.lang.Integer row
row position in the ZoneGroup


column

protected java.lang.Integer column
column position in the ZoneGroup.


upperLeftX

protected java.lang.Float upperLeftX
Boundary vertical upper left position relative to (0,0).


upperLeftY

protected java.lang.Float upperLeftY
Boundary horizontal upper left position relative to (0,0).


lowerRightX

protected java.lang.Float lowerRightX
Boundary vertical lower right position relative to (0,0).


lowerRightY

protected java.lang.Float lowerRightY
Boundary horizontal lower right position relative to (0,0).


distanceUnit

protected DistanceUnit distanceUnit
DOCUMENT ME


distanceUnitId

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

Constructor Detail

ZoneImpl

public ZoneImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class IdentifiableImpl

searchZones

public Zone[] searchZones(ZoneSearchCriteria criteria)
                   throws gov.nih.nci.common.search.SearchException
Returns an array of Zone objects that satisfy the given ZoneSearchCriteria.

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

setRow

public void setRow(java.lang.Integer p_row)
Sets the row attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Zone object.

Specified by:
setRow in interface Zone
Parameters:
p_row - The new value for row.
See Also:
Zone.getRow()

getRow

public java.lang.Integer getRow()
Description copied from interface: Zone
Returns the value of this Zone object's row attribute. Description of row: row position in the ZoneGroup

Specified by:
getRow in interface Zone
Returns:
int The value of row.
See Also:
Zone.getRow()

setColumn

public void setColumn(java.lang.Integer p_column)
Sets the column attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Zone object.

Specified by:
setColumn in interface Zone
Parameters:
p_column - The new value for column.
See Also:
Zone.getColumn()

getColumn

public java.lang.Integer getColumn()
Description copied from interface: Zone
Returns the value of this Zone object's column attribute. Description of column: column position in the ZoneGroup.

Specified by:
getColumn in interface Zone
Returns:
int The value of column.
See Also:
Zone.getColumn()

setUpperLeftX

public void setUpperLeftX(java.lang.Float p_upperLeftX)
Sets the upperLeftX attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Zone object.

Specified by:
setUpperLeftX in interface Zone
Parameters:
p_upperLeftX - The new value for upperLeftX.
See Also:
Zone.getUpperLeftX()

getUpperLeftX

public java.lang.Float getUpperLeftX()
Description copied from interface: Zone
Returns the value of this Zone object's upperLeftX attribute. Description of upperLeftX: Boundary vertical upper left position relative to (0,0).

Specified by:
getUpperLeftX in interface Zone
Returns:
float The value of upperLeftX.
See Also:
Zone.getUpperLeftX()

setUpperLeftY

public void setUpperLeftY(java.lang.Float p_upperLeftY)
Sets the upperLeftY attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Zone object.

Specified by:
setUpperLeftY in interface Zone
Parameters:
p_upperLeftY - The new value for upperLeftY.
See Also:
Zone.getUpperLeftY()

getUpperLeftY

public java.lang.Float getUpperLeftY()
Description copied from interface: Zone
Returns the value of this Zone object's upperLeftY attribute. Description of upperLeftY: Boundary horizontal upper left position relative to (0,0).

Specified by:
getUpperLeftY in interface Zone
Returns:
float The value of upperLeftY.
See Also:
Zone.getUpperLeftY()

setLowerRightX

public void setLowerRightX(java.lang.Float p_lowerRightX)
Sets the lowerRightX attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Zone object.

Specified by:
setLowerRightX in interface Zone
Parameters:
p_lowerRightX - The new value for lowerRightX.
See Also:
Zone.getLowerRightX()

getLowerRightX

public java.lang.Float getLowerRightX()
Description copied from interface: Zone
Returns the value of this Zone object's lowerRightX attribute. Description of lowerRightX: Boundary vertical lower right position relative to (0,0).

Specified by:
getLowerRightX in interface Zone
Returns:
float The value of lowerRightX.
See Also:
Zone.getLowerRightX()

setLowerRightY

public void setLowerRightY(java.lang.Float p_lowerRightY)
Sets the lowerRightY attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Zone object.

Specified by:
setLowerRightY in interface Zone
Parameters:
p_lowerRightY - The new value for lowerRightY.
See Also:
Zone.getLowerRightY()

getLowerRightY

public java.lang.Float getLowerRightY()
Description copied from interface: Zone
Returns the value of this Zone object's lowerRightY attribute. Description of lowerRightY: Boundary horizontal lower right position relative to (0,0).

Specified by:
getLowerRightY in interface Zone
Returns:
float The value of lowerRightY.
See Also:
Zone.getLowerRightY()

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

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

getDistanceUnit

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

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

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.