gov.nih.nci.mageom.domain.impl
Class ExtendableImpl

java.lang.Object
  extended by gov.nih.nci.mageom.domain.impl.MAGEOMObject
      extended by gov.nih.nci.mageom.domain.impl.ExtendableImpl
All Implemented Interfaces:
Extendable, java.io.Serializable
Direct Known Subclasses:
ArrayManufactureDeviationImpl, BioAssayDatumImpl, BioAssayMappingImpl, BioDataValuesImpl, BioMaterialMeasurementImpl, CompoundMeasurementImpl, DatabaseEntryImpl, DescribableImpl, DesignElementMappingImpl, ExternalReferenceImpl, FeatureDefectImpl, FeatureInformationImpl, FeatureLocationImpl, MeasurementImpl, MismatchInformationImpl, NodeValueImpl, OntologyEntryImpl, ParameterValueImpl, PositionDeltaImpl, PositionImpl, QuantitationTypeMappingImpl, SeqFeatureLocationImpl, SequencePositionImpl, UnitImpl, ZoneDefectImpl, ZoneGroupImpl, ZoneLayoutImpl

public class ExtendableImpl
extends MAGEOMObject
implements Extendable

Abstract class that specifies for subclasses an association to NameValueTypes. These can be used, for instance, to specify proprietary properties and in-house processing hints.

Version:
%I%, %G%
See Also:
Serialized Form

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  NameValueType[] propertySets
          DOCUMENT ME
protected  int propertySetsCount
          The count of NameValueType objects.
protected  java.lang.String securedElementId
           
 
Constructor Summary
ExtendableImpl()
          Default constructor
 
Method Summary
 NameValueType[] getPropertySets()
          Returns the value of this Extendable object's propertySets attribute.
 int getPropertySetsCount()
          Returns the count of all NameValueType associated with this Extendable object.
 java.lang.String getSecuredElementId()
           
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 Extendable[] searchExtendables(ExtendableSearchCriteria criteria)
          Returns an array of Extendable objects that satisfy the given ExtendableSearchCriteria.
 void setPropertySets(NameValueType[] p_propertySets)
          Sets the propertySets attribute.
 void setSecuredElementId(java.lang.String securedElementId)
           
 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.MAGEOMObject
getId, getIsEditable, setId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

allAssociationMethods

protected static java.util.ArrayList allAssociationMethods

associationMethods

protected static java.util.Hashtable associationMethods

securedElementId

protected java.lang.String securedElementId

propertySetsCount

protected int propertySetsCount
The count of NameValueType objects.


propertySets

protected NameValueType[] propertySets
DOCUMENT ME

Constructor Detail

ExtendableImpl

public ExtendableImpl()
Default constructor

Method Detail

init

protected void init()

searchExtendables

public Extendable[] searchExtendables(ExtendableSearchCriteria criteria)
                               throws gov.nih.nci.common.search.SearchException
Returns an array of Extendable objects that satisfy the given ExtendableSearchCriteria.

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

setPropertySets

public void setPropertySets(NameValueType[] p_propertySets)
Sets the propertySets attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Extendable object.

Specified by:
setPropertySets in interface Extendable
Parameters:
p_propertySets - The new value for propertySets.
See Also:
Extendable.getPropertySets()

getPropertySets

public NameValueType[] getPropertySets()
Description copied from interface: Extendable
Returns the value of this Extendable object's propertySets attribute.

Specified by:
getPropertySets in interface Extendable
Returns:
gov.nih.nci.mageom.bean.NameValueType[] The value of propertySets.
See Also:
Extendable.getPropertySets()

getPropertySetsCount

public int getPropertySetsCount()
Returns the count of all NameValueType associated with this Extendable object.

Returns:
the count
See Also:
Extendable.getPropertySets()

toXML

public org.w3c.dom.Element toXML(org.w3c.dom.Document doc)

toXMLDoc

public org.w3c.dom.Element toXMLDoc(org.w3c.dom.Document doc)

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.

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.

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 java.lang.Object
Returns:
the String representation.

getSecuredElementId

public java.lang.String getSecuredElementId()
Returns:
Returns the securedElementId.

setSecuredElementId

public void setSecuredElementId(java.lang.String securedElementId)
Parameters:
securedElementId - The securedElementId to set.