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

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.DesignElement.impl.DesignElementImpl
                      extended by gov.nih.nci.mageom.domain.DesignElement.impl.FeatureImpl
All Implemented Interfaces:
Describable, DesignElement, Feature, Extendable, Identifiable, java.io.Serializable

public class FeatureImpl
extends DesignElementImpl
implements Feature

An intended 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  Feature[] controlFeatures
          DOCUMENT ME
protected  int controlFeaturesCount
          The count of Feature objects.
protected  Feature[] controlledFeatures
          DOCUMENT ME
protected  int controlledFeaturesCount
          The count of Feature objects.
protected  FeatureGroup featureGroup
          DOCUMENT ME
protected  java.lang.Long featureGroupId
          The internal ID of the associated featureGroup object.
protected  FeatureLocation featureLocation
          DOCUMENT ME
protected  java.lang.Long featureLocationId
          The internal ID of the associated featureLocation object.
protected  Position position
          DOCUMENT ME
protected  java.lang.Long positionId
          The internal ID of the associated position object.
protected  Zone zone
          DOCUMENT ME
protected  java.lang.Long zoneId
          The internal ID of the associated zone object.
 
Fields inherited from class gov.nih.nci.mageom.domain.DesignElement.impl.DesignElementImpl
controlType, controlTypeId
 
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
FeatureImpl()
          Default constructor
 
Method Summary
 Feature[] getControlFeatures()
          Returns the value of this Feature object's controlFeatures attribute.
 int getControlFeaturesCount()
          Returns the count of all Feature associated with this Feature object.
 Feature[] getControlledFeatures()
          Returns the value of this Feature object's controlledFeatures attribute.
 int getControlledFeaturesCount()
          Returns the count of all Feature associated with this Feature object.
 FeatureGroup getFeatureGroup()
          Returns the value of this Feature object's featureGroup attribute.
 FeatureLocation getFeatureLocation()
          Returns the value of this Feature object's featureLocation attribute.
 Position getPosition()
          Returns the value of this Feature object's position attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
 Zone getZone()
          Returns the value of this Feature object's zone attribute.
protected  void init()
           
 Feature[] searchFeatures(FeatureSearchCriteria criteria)
          Returns an array of Feature objects that satisfy the given FeatureSearchCriteria.
 void setControlFeatures(Feature[] p_controlFeatures)
          Sets the controlFeatures attribute.
 void setControlledFeatures(Feature[] p_controlledFeatures)
          Sets the controlledFeatures attribute.
 void setFeatureGroup(FeatureGroup p_featureGroup)
          Sets the featureGroup attribute.
 void setFeatureLocation(FeatureLocation p_featureLocation)
          Sets the featureLocation attribute.
 void setPosition(Position p_position)
          Sets the position attribute.
 void setZone(Zone p_zone)
          Sets the zone 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.DesignElement.impl.DesignElementImpl
getControlType, searchDesignElements, setControlType
 
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.DesignElement.DesignElement
getControlType, setControlType
 
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

featureGroup

protected FeatureGroup featureGroup
DOCUMENT ME


featureGroupId

protected java.lang.Long featureGroupId
The internal ID of the associated featureGroup object.


controlledFeaturesCount

protected int controlledFeaturesCount
The count of Feature objects.


controlledFeatures

protected Feature[] controlledFeatures
DOCUMENT ME


controlFeaturesCount

protected int controlFeaturesCount
The count of Feature objects.


controlFeatures

protected Feature[] controlFeatures
DOCUMENT ME


zone

protected Zone zone
DOCUMENT ME


zoneId

protected java.lang.Long zoneId
The internal ID of the associated zone object.


featureLocation

protected FeatureLocation featureLocation
DOCUMENT ME


featureLocationId

protected java.lang.Long featureLocationId
The internal ID of the associated featureLocation object.


position

protected Position position
DOCUMENT ME


positionId

protected java.lang.Long positionId
The internal ID of the associated position object.

Constructor Detail

FeatureImpl

public FeatureImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class DesignElementImpl

searchFeatures

public Feature[] searchFeatures(FeatureSearchCriteria criteria)
                         throws gov.nih.nci.common.search.SearchException
Returns an array of Feature objects that satisfy the given FeatureSearchCriteria.

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

setFeatureGroup

public void setFeatureGroup(FeatureGroup p_featureGroup)
Sets the featureGroup attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Feature object.

Specified by:
setFeatureGroup in interface Feature
Parameters:
p_featureGroup - The new value for featureGroup.
See Also:
Feature.getFeatureGroup()

getFeatureGroup

public FeatureGroup getFeatureGroup()
Description copied from interface: Feature
Returns the value of this Feature object's featureGroup attribute.

Specified by:
getFeatureGroup in interface Feature
Returns:
gov.nih.nci.mageom.bean.ArrayDesign.FeatureGroup The value of featureGroup.
See Also:
Feature.getFeatureGroup()

setControlledFeatures

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

Specified by:
setControlledFeatures in interface Feature
Parameters:
p_controlledFeatures - The new value for controlledFeatures.
See Also:
Feature.getControlledFeatures()

getControlledFeatures

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

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

setControlFeatures

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

Specified by:
setControlFeatures in interface Feature
Parameters:
p_controlFeatures - The new value for controlFeatures.
See Also:
Feature.getControlFeatures()

getControlFeatures

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

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

setZone

public void setZone(Zone p_zone)
Sets the zone attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Feature object.

Specified by:
setZone in interface Feature
Parameters:
p_zone - The new value for zone.
See Also:
Feature.getZone()

getZone

public Zone getZone()
Description copied from interface: Feature
Returns the value of this Feature object's zone attribute.

Specified by:
getZone in interface Feature
Returns:
gov.nih.nci.mageom.bean.ArrayDesign.Zone The value of zone.
See Also:
Feature.getZone()

setFeatureLocation

public void setFeatureLocation(FeatureLocation p_featureLocation)
Sets the featureLocation attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Feature object.

Specified by:
setFeatureLocation in interface Feature
Parameters:
p_featureLocation - The new value for featureLocation.
See Also:
Feature.getFeatureLocation()

getFeatureLocation

public FeatureLocation getFeatureLocation()
Description copied from interface: Feature
Returns the value of this Feature object's featureLocation attribute.

Specified by:
getFeatureLocation in interface Feature
Returns:
gov.nih.nci.mageom.bean.DesignElement.FeatureLocation The value of featureLocation.
See Also:
Feature.getFeatureLocation()

setPosition

public void setPosition(Position p_position)
Sets the position attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Feature object.

Specified by:
setPosition in interface Feature
Parameters:
p_position - The new value for position.
See Also:
Feature.getPosition()

getPosition

public Position getPosition()
Description copied from interface: Feature
Returns the value of this Feature object's position attribute.

Specified by:
getPosition in interface Feature
Returns:
gov.nih.nci.mageom.bean.DesignElement.Position The value of position.
See Also:
Feature.getPosition()

getControlledFeaturesCount

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

Returns:
the count
See Also:
Feature.getControlledFeatures()

getControlFeaturesCount

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

Returns:
the count
See Also:
Feature.getControlFeatures()

toXML

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

toXMLDoc

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

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