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

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.DesignElement.impl.FeatureLocationImpl
All Implemented Interfaces:
FeatureLocation, Extendable, java.io.Serializable

public class FeatureLocationImpl
extends ExtendableImpl
implements FeatureLocation

Specifies where a feature is located relative to a grid.

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 Zone.
protected  java.lang.Integer row
          row position in the Zone
 
Fields inherited from class gov.nih.nci.mageom.domain.impl.ExtendableImpl
propertySets, propertySetsCount, securedElementId
 
Constructor Summary
FeatureLocationImpl()
          Default constructor
 
Method Summary
 java.lang.Integer getColumn()
          Returns the value of this FeatureLocation object's column attribute.
 java.lang.Integer getRow()
          Returns the value of this FeatureLocation object's row attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 FeatureLocation[] searchFeatureLocations(FeatureLocationSearchCriteria criteria)
          Returns an array of FeatureLocation objects that satisfy the given FeatureLocationSearchCriteria.
 void setColumn(java.lang.Integer p_column)
          Sets the column attribute.
 void setRow(java.lang.Integer p_row)
          Sets the row 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

row

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


column

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

Constructor Detail

FeatureLocationImpl

public FeatureLocationImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class ExtendableImpl

searchFeatureLocations

public FeatureLocation[] searchFeatureLocations(FeatureLocationSearchCriteria criteria)
                                         throws gov.nih.nci.common.search.SearchException
Returns an array of FeatureLocation objects that satisfy the given FeatureLocationSearchCriteria.

Parameters:
criteria - The FeatureLocationSearchCriteria which represents a query for FeatureLocation objects.
Returns:
An array of FeatureLocation 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 FeatureLocation object.

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

getRow

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

Specified by:
getRow in interface FeatureLocation
Returns:
int The value of row.
See Also:
FeatureLocation.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 FeatureLocation object.

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

getColumn

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

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

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.