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

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.ArrayDesign.impl.ZoneLayoutImpl
All Implemented Interfaces:
ZoneLayout, Extendable, java.io.Serializable

public class ZoneLayoutImpl
extends ExtendableImpl
implements ZoneLayout

Specifies the layout of features in a rectangular grid.

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.Integer numFeaturesPerCol
          The number of features from top to bottom of the grid.
protected  java.lang.Integer numFeaturesPerRow
          The number of features from left to right.
protected  java.lang.Float spacingBetweenCols
          Spacing between the columns.
protected  java.lang.Float spacingBetweenRows
          Spacing between the rows.
 
Fields inherited from class gov.nih.nci.mageom.domain.impl.ExtendableImpl
propertySets, propertySetsCount, securedElementId
 
Constructor Summary
ZoneLayoutImpl()
          Default constructor
 
Method Summary
 DistanceUnit getDistanceUnit()
          Returns the value of this ZoneLayout object's distanceUnit attribute.
 java.lang.Integer getNumFeaturesPerCol()
          Returns the value of this ZoneLayout object's numFeaturesPerCol attribute.
 java.lang.Integer getNumFeaturesPerRow()
          Returns the value of this ZoneLayout object's numFeaturesPerRow attribute.
 java.lang.Float getSpacingBetweenCols()
          Returns the value of this ZoneLayout object's spacingBetweenCols attribute.
 java.lang.Float getSpacingBetweenRows()
          Returns the value of this ZoneLayout object's spacingBetweenRows attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 ZoneLayout[] searchZoneLayouts(ZoneLayoutSearchCriteria criteria)
          Returns an array of ZoneLayout objects that satisfy the given ZoneLayoutSearchCriteria.
 void setDistanceUnit(DistanceUnit p_distanceUnit)
          Sets the distanceUnit attribute.
 void setNumFeaturesPerCol(java.lang.Integer p_numFeaturesPerCol)
          Sets the numFeaturesPerCol attribute.
 void setNumFeaturesPerRow(java.lang.Integer p_numFeaturesPerRow)
          Sets the numFeaturesPerRow attribute.
 void setSpacingBetweenCols(java.lang.Float p_spacingBetweenCols)
          Sets the spacingBetweenCols attribute.
 void setSpacingBetweenRows(java.lang.Float p_spacingBetweenRows)
          Sets the spacingBetweenRows 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

numFeaturesPerRow

protected java.lang.Integer numFeaturesPerRow
The number of features from left to right.


numFeaturesPerCol

protected java.lang.Integer numFeaturesPerCol
The number of features from top to bottom of the grid.


spacingBetweenRows

protected java.lang.Float spacingBetweenRows
Spacing between the rows.


spacingBetweenCols

protected java.lang.Float spacingBetweenCols
Spacing between the columns.


distanceUnit

protected DistanceUnit distanceUnit
DOCUMENT ME


distanceUnitId

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

Constructor Detail

ZoneLayoutImpl

public ZoneLayoutImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class ExtendableImpl

searchZoneLayouts

public ZoneLayout[] searchZoneLayouts(ZoneLayoutSearchCriteria criteria)
                               throws gov.nih.nci.common.search.SearchException
Returns an array of ZoneLayout objects that satisfy the given ZoneLayoutSearchCriteria.

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

setNumFeaturesPerRow

public void setNumFeaturesPerRow(java.lang.Integer p_numFeaturesPerRow)
Sets the numFeaturesPerRow attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ZoneLayout object.

Specified by:
setNumFeaturesPerRow in interface ZoneLayout
Parameters:
p_numFeaturesPerRow - The new value for numFeaturesPerRow.
See Also:
ZoneLayout.getNumFeaturesPerRow()

getNumFeaturesPerRow

public java.lang.Integer getNumFeaturesPerRow()
Description copied from interface: ZoneLayout
Returns the value of this ZoneLayout object's numFeaturesPerRow attribute. Description of numFeaturesPerRow: The number of features from left to right.

Specified by:
getNumFeaturesPerRow in interface ZoneLayout
Returns:
int The value of numFeaturesPerRow.
See Also:
ZoneLayout.getNumFeaturesPerRow()

setNumFeaturesPerCol

public void setNumFeaturesPerCol(java.lang.Integer p_numFeaturesPerCol)
Sets the numFeaturesPerCol attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ZoneLayout object.

Specified by:
setNumFeaturesPerCol in interface ZoneLayout
Parameters:
p_numFeaturesPerCol - The new value for numFeaturesPerCol.
See Also:
ZoneLayout.getNumFeaturesPerCol()

getNumFeaturesPerCol

public java.lang.Integer getNumFeaturesPerCol()
Description copied from interface: ZoneLayout
Returns the value of this ZoneLayout object's numFeaturesPerCol attribute. Description of numFeaturesPerCol: The number of features from top to bottom of the grid.

Specified by:
getNumFeaturesPerCol in interface ZoneLayout
Returns:
int The value of numFeaturesPerCol.
See Also:
ZoneLayout.getNumFeaturesPerCol()

setSpacingBetweenRows

public void setSpacingBetweenRows(java.lang.Float p_spacingBetweenRows)
Sets the spacingBetweenRows attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ZoneLayout object.

Specified by:
setSpacingBetweenRows in interface ZoneLayout
Parameters:
p_spacingBetweenRows - The new value for spacingBetweenRows.
See Also:
ZoneLayout.getSpacingBetweenRows()

getSpacingBetweenRows

public java.lang.Float getSpacingBetweenRows()
Description copied from interface: ZoneLayout
Returns the value of this ZoneLayout object's spacingBetweenRows attribute. Description of spacingBetweenRows: Spacing between the rows.

Specified by:
getSpacingBetweenRows in interface ZoneLayout
Returns:
float The value of spacingBetweenRows.
See Also:
ZoneLayout.getSpacingBetweenRows()

setSpacingBetweenCols

public void setSpacingBetweenCols(java.lang.Float p_spacingBetweenCols)
Sets the spacingBetweenCols attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ZoneLayout object.

Specified by:
setSpacingBetweenCols in interface ZoneLayout
Parameters:
p_spacingBetweenCols - The new value for spacingBetweenCols.
See Also:
ZoneLayout.getSpacingBetweenCols()

getSpacingBetweenCols

public java.lang.Float getSpacingBetweenCols()
Description copied from interface: ZoneLayout
Returns the value of this ZoneLayout object's spacingBetweenCols attribute. Description of spacingBetweenCols: Spacing between the columns.

Specified by:
getSpacingBetweenCols in interface ZoneLayout
Returns:
float The value of spacingBetweenCols.
See Also:
ZoneLayout.getSpacingBetweenCols()

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

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

getDistanceUnit

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

Specified by:
getDistanceUnit in interface ZoneLayout
Returns:
gov.nih.nci.mageom.bean.Measurement.DistanceUnit The value of distanceUnit.
See Also:
ZoneLayout.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.