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

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.ZoneGroupImpl
All Implemented Interfaces:
ZoneGroup, Extendable, java.io.Serializable

public class ZoneGroupImpl
extends ExtendableImpl
implements ZoneGroup

Specifies a repeating area on an array. This is useful for printing when the same pattern is repeated in a regular fashion.

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 spacingsBetweenZonesX
          Spacing between zones, if applicable.
protected  java.lang.Float spacingsBetweenZonesY
          Spacing between zones, if applicable.
protected  ZoneLayout zoneLayout
          DOCUMENT ME
protected  java.lang.Long zoneLayoutId
          The internal ID of the associated zoneLayout object.
protected  Zone[] zoneLocations
          DOCUMENT ME
protected  int zoneLocationsCount
          The count of Zone objects.
protected  java.lang.Integer zonesPerX
          The number of zones on the x-axis.
protected  java.lang.Integer zonesPerY
          The number of zones on the y-axis.
 
Fields inherited from class gov.nih.nci.mageom.domain.impl.ExtendableImpl
propertySets, propertySetsCount, securedElementId
 
Constructor Summary
ZoneGroupImpl()
          Default constructor
 
Method Summary
 DistanceUnit getDistanceUnit()
          Returns the value of this ZoneGroup object's distanceUnit attribute.
 java.lang.Float getSpacingsBetweenZonesX()
          Returns the value of this ZoneGroup object's spacingsBetweenZonesX attribute.
 java.lang.Float getSpacingsBetweenZonesY()
          Returns the value of this ZoneGroup object's spacingsBetweenZonesY attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
 ZoneLayout getZoneLayout()
          Returns the value of this ZoneGroup object's zoneLayout attribute.
 Zone[] getZoneLocations()
          Returns the value of this ZoneGroup object's zoneLocations attribute.
 int getZoneLocationsCount()
          Returns the count of all Zone associated with this ZoneGroup object.
 java.lang.Integer getZonesPerX()
          Returns the value of this ZoneGroup object's zonesPerX attribute.
 java.lang.Integer getZonesPerY()
          Returns the value of this ZoneGroup object's zonesPerY attribute.
protected  void init()
           
 ZoneGroup[] searchZoneGroups(ZoneGroupSearchCriteria criteria)
          Returns an array of ZoneGroup objects that satisfy the given ZoneGroupSearchCriteria.
 void setDistanceUnit(DistanceUnit p_distanceUnit)
          Sets the distanceUnit attribute.
 void setSpacingsBetweenZonesX(java.lang.Float p_spacingsBetweenZonesX)
          Sets the spacingsBetweenZonesX attribute.
 void setSpacingsBetweenZonesY(java.lang.Float p_spacingsBetweenZonesY)
          Sets the spacingsBetweenZonesY attribute.
 void setZoneLayout(ZoneLayout p_zoneLayout)
          Sets the zoneLayout attribute.
 void setZoneLocations(Zone[] p_zoneLocations)
          Sets the zoneLocations attribute.
 void setZonesPerX(java.lang.Integer p_zonesPerX)
          Sets the zonesPerX attribute.
 void setZonesPerY(java.lang.Integer p_zonesPerY)
          Sets the zonesPerY 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

spacingsBetweenZonesX

protected java.lang.Float spacingsBetweenZonesX
Spacing between zones, if applicable.


spacingsBetweenZonesY

protected java.lang.Float spacingsBetweenZonesY
Spacing between zones, if applicable.


zonesPerX

protected java.lang.Integer zonesPerX
The number of zones on the x-axis.


zonesPerY

protected java.lang.Integer zonesPerY
The number of zones on the y-axis.


zoneLocationsCount

protected int zoneLocationsCount
The count of Zone objects.


zoneLocations

protected Zone[] zoneLocations
DOCUMENT ME


zoneLayout

protected ZoneLayout zoneLayout
DOCUMENT ME


zoneLayoutId

protected java.lang.Long zoneLayoutId
The internal ID of the associated zoneLayout object.


distanceUnit

protected DistanceUnit distanceUnit
DOCUMENT ME


distanceUnitId

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

Constructor Detail

ZoneGroupImpl

public ZoneGroupImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class ExtendableImpl

searchZoneGroups

public ZoneGroup[] searchZoneGroups(ZoneGroupSearchCriteria criteria)
                             throws gov.nih.nci.common.search.SearchException
Returns an array of ZoneGroup objects that satisfy the given ZoneGroupSearchCriteria.

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

setSpacingsBetweenZonesX

public void setSpacingsBetweenZonesX(java.lang.Float p_spacingsBetweenZonesX)
Sets the spacingsBetweenZonesX attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ZoneGroup object.

Specified by:
setSpacingsBetweenZonesX in interface ZoneGroup
Parameters:
p_spacingsBetweenZonesX - The new value for spacingsBetweenZonesX.
See Also:
ZoneGroup.getSpacingsBetweenZonesX()

getSpacingsBetweenZonesX

public java.lang.Float getSpacingsBetweenZonesX()
Description copied from interface: ZoneGroup
Returns the value of this ZoneGroup object's spacingsBetweenZonesX attribute. Description of spacingsBetweenZonesX: Spacing between zones, if applicable.

Specified by:
getSpacingsBetweenZonesX in interface ZoneGroup
Returns:
float The value of spacingsBetweenZonesX.
See Also:
ZoneGroup.getSpacingsBetweenZonesX()

setSpacingsBetweenZonesY

public void setSpacingsBetweenZonesY(java.lang.Float p_spacingsBetweenZonesY)
Sets the spacingsBetweenZonesY attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ZoneGroup object.

Specified by:
setSpacingsBetweenZonesY in interface ZoneGroup
Parameters:
p_spacingsBetweenZonesY - The new value for spacingsBetweenZonesY.
See Also:
ZoneGroup.getSpacingsBetweenZonesY()

getSpacingsBetweenZonesY

public java.lang.Float getSpacingsBetweenZonesY()
Description copied from interface: ZoneGroup
Returns the value of this ZoneGroup object's spacingsBetweenZonesY attribute. Description of spacingsBetweenZonesY: Spacing between zones, if applicable.

Specified by:
getSpacingsBetweenZonesY in interface ZoneGroup
Returns:
float The value of spacingsBetweenZonesY.
See Also:
ZoneGroup.getSpacingsBetweenZonesY()

setZonesPerX

public void setZonesPerX(java.lang.Integer p_zonesPerX)
Sets the zonesPerX attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ZoneGroup object.

Specified by:
setZonesPerX in interface ZoneGroup
Parameters:
p_zonesPerX - The new value for zonesPerX.
See Also:
ZoneGroup.getZonesPerX()

getZonesPerX

public java.lang.Integer getZonesPerX()
Description copied from interface: ZoneGroup
Returns the value of this ZoneGroup object's zonesPerX attribute. Description of zonesPerX: The number of zones on the x-axis.

Specified by:
getZonesPerX in interface ZoneGroup
Returns:
int The value of zonesPerX.
See Also:
ZoneGroup.getZonesPerX()

setZonesPerY

public void setZonesPerY(java.lang.Integer p_zonesPerY)
Sets the zonesPerY attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ZoneGroup object.

Specified by:
setZonesPerY in interface ZoneGroup
Parameters:
p_zonesPerY - The new value for zonesPerY.
See Also:
ZoneGroup.getZonesPerY()

getZonesPerY

public java.lang.Integer getZonesPerY()
Description copied from interface: ZoneGroup
Returns the value of this ZoneGroup object's zonesPerY attribute. Description of zonesPerY: The number of zones on the y-axis.

Specified by:
getZonesPerY in interface ZoneGroup
Returns:
int The value of zonesPerY.
See Also:
ZoneGroup.getZonesPerY()

setZoneLocations

public void setZoneLocations(Zone[] p_zoneLocations)
Sets the zoneLocations attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ZoneGroup object.

Specified by:
setZoneLocations in interface ZoneGroup
Parameters:
p_zoneLocations - The new value for zoneLocations.
See Also:
ZoneGroup.getZoneLocations()

getZoneLocations

public Zone[] getZoneLocations()
Description copied from interface: ZoneGroup
Returns the value of this ZoneGroup object's zoneLocations attribute.

Specified by:
getZoneLocations in interface ZoneGroup
Returns:
gov.nih.nci.mageom.bean.ArrayDesign.Zone[] The value of zoneLocations.
See Also:
ZoneGroup.getZoneLocations()

setZoneLayout

public void setZoneLayout(ZoneLayout p_zoneLayout)
Sets the zoneLayout attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ZoneGroup object.

Specified by:
setZoneLayout in interface ZoneGroup
Parameters:
p_zoneLayout - The new value for zoneLayout.
See Also:
ZoneGroup.getZoneLayout()

getZoneLayout

public ZoneLayout getZoneLayout()
Description copied from interface: ZoneGroup
Returns the value of this ZoneGroup object's zoneLayout attribute.

Specified by:
getZoneLayout in interface ZoneGroup
Returns:
gov.nih.nci.mageom.bean.ArrayDesign.ZoneLayout The value of zoneLayout.
See Also:
ZoneGroup.getZoneLayout()

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

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

getDistanceUnit

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

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

getZoneLocationsCount

public int getZoneLocationsCount()
Returns the count of all Zone associated with this ZoneGroup object.

Returns:
the count
See Also:
ZoneGroup.getZoneLocations()

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.