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

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.DesignElementGroupImpl
                      extended by gov.nih.nci.mageom.domain.ArrayDesign.impl.FeatureGroupImpl
All Implemented Interfaces:
DesignElementGroup, FeatureGroup, Describable, Extendable, Identifiable, java.io.Serializable

public class FeatureGroupImpl
extends DesignElementGroupImpl
implements FeatureGroup

A collection of like features.

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 featureHeight
          The height of the feature.
protected  java.lang.Float featureLength
          The length of the feature.
protected  Feature[] features
          DOCUMENT ME
protected  int featuresCount
          The count of Feature objects.
protected  OntologyEntry featureShape
          DOCUMENT ME
protected  java.lang.Long featureShapeId
          The internal ID of the associated featureShape object.
protected  java.lang.Float featureWidth
          The width of the feature.
protected  OntologyEntry technologyType
          DOCUMENT ME
protected  java.lang.Long technologyTypeId
          The internal ID of the associated technologyType object.
 
Fields inherited from class gov.nih.nci.mageom.domain.ArrayDesign.impl.DesignElementGroupImpl
species, speciesId, types, typesCount
 
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
FeatureGroupImpl()
          Default constructor
 
Method Summary
 DistanceUnit getDistanceUnit()
          Returns the value of this FeatureGroup object's distanceUnit attribute.
 java.lang.Float getFeatureHeight()
          Returns the value of this FeatureGroup object's featureHeight attribute.
 java.lang.Float getFeatureLength()
          Returns the value of this FeatureGroup object's featureLength attribute.
 Feature[] getFeatures()
          Returns the value of this FeatureGroup object's features attribute.
 int getFeaturesCount()
          Returns the count of all Feature associated with this FeatureGroup object.
 OntologyEntry getFeatureShape()
          Returns the value of this FeatureGroup object's featureShape attribute.
 java.lang.Float getFeatureWidth()
          Returns the value of this FeatureGroup object's featureWidth attribute.
 OntologyEntry getTechnologyType()
          Returns the value of this FeatureGroup object's technologyType attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 FeatureGroup[] searchFeatureGroups(FeatureGroupSearchCriteria criteria)
          Returns an array of FeatureGroup objects that satisfy the given FeatureGroupSearchCriteria.
 void setDistanceUnit(DistanceUnit p_distanceUnit)
          Sets the distanceUnit attribute.
 void setFeatureHeight(java.lang.Float p_featureHeight)
          Sets the featureHeight attribute.
 void setFeatureLength(java.lang.Float p_featureLength)
          Sets the featureLength attribute.
 void setFeatures(Feature[] p_features)
          Sets the features attribute.
 void setFeatureShape(OntologyEntry p_featureShape)
          Sets the featureShape attribute.
 void setFeatureWidth(java.lang.Float p_featureWidth)
          Sets the featureWidth attribute.
 void setTechnologyType(OntologyEntry p_technologyType)
          Sets the technologyType 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.ArrayDesign.impl.DesignElementGroupImpl
getSpecies, getTypes, getTypesCount, searchDesignElementGroups, setSpecies, setTypes
 
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.ArrayDesign.DesignElementGroup
getSpecies, getTypes, setSpecies, setTypes
 
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

featureWidth

protected java.lang.Float featureWidth
The width of the feature.


featureLength

protected java.lang.Float featureLength
The length of the feature.


featureHeight

protected java.lang.Float featureHeight
The height of the feature.


featuresCount

protected int featuresCount
The count of Feature objects.


features

protected Feature[] features
DOCUMENT ME


technologyType

protected OntologyEntry technologyType
DOCUMENT ME


technologyTypeId

protected java.lang.Long technologyTypeId
The internal ID of the associated technologyType object.


featureShape

protected OntologyEntry featureShape
DOCUMENT ME


featureShapeId

protected java.lang.Long featureShapeId
The internal ID of the associated featureShape object.


distanceUnit

protected DistanceUnit distanceUnit
DOCUMENT ME


distanceUnitId

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

Constructor Detail

FeatureGroupImpl

public FeatureGroupImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class DesignElementGroupImpl

searchFeatureGroups

public FeatureGroup[] searchFeatureGroups(FeatureGroupSearchCriteria criteria)
                                   throws gov.nih.nci.common.search.SearchException
Returns an array of FeatureGroup objects that satisfy the given FeatureGroupSearchCriteria.

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

setFeatureWidth

public void setFeatureWidth(java.lang.Float p_featureWidth)
Sets the featureWidth attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a FeatureGroup object.

Specified by:
setFeatureWidth in interface FeatureGroup
Parameters:
p_featureWidth - The new value for featureWidth.
See Also:
FeatureGroup.getFeatureWidth()

getFeatureWidth

public java.lang.Float getFeatureWidth()
Description copied from interface: FeatureGroup
Returns the value of this FeatureGroup object's featureWidth attribute. Description of featureWidth: The width of the feature.

Specified by:
getFeatureWidth in interface FeatureGroup
Returns:
float The value of featureWidth.
See Also:
FeatureGroup.getFeatureWidth()

setFeatureLength

public void setFeatureLength(java.lang.Float p_featureLength)
Sets the featureLength attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a FeatureGroup object.

Specified by:
setFeatureLength in interface FeatureGroup
Parameters:
p_featureLength - The new value for featureLength.
See Also:
FeatureGroup.getFeatureLength()

getFeatureLength

public java.lang.Float getFeatureLength()
Description copied from interface: FeatureGroup
Returns the value of this FeatureGroup object's featureLength attribute. Description of featureLength: The length of the feature.

Specified by:
getFeatureLength in interface FeatureGroup
Returns:
float The value of featureLength.
See Also:
FeatureGroup.getFeatureLength()

setFeatureHeight

public void setFeatureHeight(java.lang.Float p_featureHeight)
Sets the featureHeight attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a FeatureGroup object.

Specified by:
setFeatureHeight in interface FeatureGroup
Parameters:
p_featureHeight - The new value for featureHeight.
See Also:
FeatureGroup.getFeatureHeight()

getFeatureHeight

public java.lang.Float getFeatureHeight()
Description copied from interface: FeatureGroup
Returns the value of this FeatureGroup object's featureHeight attribute. Description of featureHeight: The height of the feature.

Specified by:
getFeatureHeight in interface FeatureGroup
Returns:
float The value of featureHeight.
See Also:
FeatureGroup.getFeatureHeight()

setFeatures

public void setFeatures(Feature[] p_features)
Sets the features attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a FeatureGroup object.

Specified by:
setFeatures in interface FeatureGroup
Parameters:
p_features - The new value for features.
See Also:
FeatureGroup.getFeatures()

getFeatures

public Feature[] getFeatures()
Description copied from interface: FeatureGroup
Returns the value of this FeatureGroup object's features attribute.

Specified by:
getFeatures in interface FeatureGroup
Returns:
gov.nih.nci.mageom.bean.DesignElement.Feature[] The value of features.
See Also:
FeatureGroup.getFeatures()

setTechnologyType

public void setTechnologyType(OntologyEntry p_technologyType)
Sets the technologyType attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a FeatureGroup object.

Specified by:
setTechnologyType in interface FeatureGroup
Parameters:
p_technologyType - The new value for technologyType.
See Also:
FeatureGroup.getTechnologyType()

getTechnologyType

public OntologyEntry getTechnologyType()
Description copied from interface: FeatureGroup
Returns the value of this FeatureGroup object's technologyType attribute.

Specified by:
getTechnologyType in interface FeatureGroup
Returns:
gov.nih.nci.mageom.bean.Description.OntologyEntry The value of technologyType.
See Also:
FeatureGroup.getTechnologyType()

setFeatureShape

public void setFeatureShape(OntologyEntry p_featureShape)
Sets the featureShape attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a FeatureGroup object.

Specified by:
setFeatureShape in interface FeatureGroup
Parameters:
p_featureShape - The new value for featureShape.
See Also:
FeatureGroup.getFeatureShape()

getFeatureShape

public OntologyEntry getFeatureShape()
Description copied from interface: FeatureGroup
Returns the value of this FeatureGroup object's featureShape attribute.

Specified by:
getFeatureShape in interface FeatureGroup
Returns:
gov.nih.nci.mageom.bean.Description.OntologyEntry The value of featureShape.
See Also:
FeatureGroup.getFeatureShape()

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

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

getDistanceUnit

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

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

getFeaturesCount

public int getFeaturesCount()
Returns the count of all Feature associated with this FeatureGroup object.

Returns:
the count
See Also:
FeatureGroup.getFeatures()

toXML

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

toXMLDoc

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

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