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

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
All Implemented Interfaces:
Describable, Extendable, java.io.Serializable
Direct Known Subclasses:
AuditImpl, BibliographicReferenceImpl, DescriptionImpl, ExperimentDesignImpl, FiducialImpl, IdentifiableImpl, ManufactureLIMSImpl, NodeContentsImpl, NodeImpl, ParameterizableApplicationImpl, SeqFeatureImpl

public class DescribableImpl
extends ExtendableImpl
implements Describable

Abstract class that allows subclasses to inherit the association to Description, for detailed annotations such as Ontology entries and Database references, the association to Audit, for tracking changes, and the association to Security for indicating permissions.

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

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  Audit[] auditTrail
          DOCUMENT ME
protected  int auditTrailCount
          The count of Audit objects.
protected  Description[] descriptions
          DOCUMENT ME
protected  int descriptionsCount
          The count of Description objects.
protected  Security security
          DOCUMENT ME
protected  java.lang.Long securityId
          The internal ID of the associated security object.
 
Fields inherited from class gov.nih.nci.mageom.domain.impl.ExtendableImpl
propertySets, propertySetsCount, securedElementId
 
Constructor Summary
DescribableImpl()
          Default constructor
 
Method Summary
 Audit[] getAuditTrail()
          Returns the value of this Describable object's auditTrail attribute.
 int getAuditTrailCount()
          Returns the count of all Audit associated with this Describable object.
 Description[] getDescriptions()
          Returns the value of this Describable object's descriptions attribute.
 int getDescriptionsCount()
          Returns the count of all Description associated with this Describable object.
 Security getSecurity()
          Returns the value of this Describable object's security attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 Describable[] searchDescribables(DescribableSearchCriteria criteria)
          Returns an array of Describable objects that satisfy the given DescribableSearchCriteria.
 void setAuditTrail(Audit[] p_auditTrail)
          Sets the auditTrail attribute.
 void setDescriptions(Description[] p_descriptions)
          Sets the descriptions attribute.
 void setSecurity(Security p_security)
          Sets the security 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

descriptionsCount

protected int descriptionsCount
The count of Description objects.


descriptions

protected Description[] descriptions
DOCUMENT ME


auditTrailCount

protected int auditTrailCount
The count of Audit objects.


auditTrail

protected Audit[] auditTrail
DOCUMENT ME


security

protected Security security
DOCUMENT ME


securityId

protected java.lang.Long securityId
The internal ID of the associated security object.

Constructor Detail

DescribableImpl

public DescribableImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class ExtendableImpl

searchDescribables

public Describable[] searchDescribables(DescribableSearchCriteria criteria)
                                 throws gov.nih.nci.common.search.SearchException
Returns an array of Describable objects that satisfy the given DescribableSearchCriteria.

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

setDescriptions

public void setDescriptions(Description[] p_descriptions)
Sets the descriptions attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Describable object.

Specified by:
setDescriptions in interface Describable
Parameters:
p_descriptions - The new value for descriptions.
See Also:
Describable.getDescriptions()

getDescriptions

public Description[] getDescriptions()
Description copied from interface: Describable
Returns the value of this Describable object's descriptions attribute.

Specified by:
getDescriptions in interface Describable
Returns:
gov.nih.nci.mageom.bean.Description.Description[] The value of descriptions.
See Also:
Describable.getDescriptions()

setAuditTrail

public void setAuditTrail(Audit[] p_auditTrail)
Sets the auditTrail attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Describable object.

Specified by:
setAuditTrail in interface Describable
Parameters:
p_auditTrail - The new value for auditTrail.
See Also:
Describable.getAuditTrail()

getAuditTrail

public Audit[] getAuditTrail()
Description copied from interface: Describable
Returns the value of this Describable object's auditTrail attribute.

Specified by:
getAuditTrail in interface Describable
Returns:
gov.nih.nci.mageom.bean.AuditAndSecurity.Audit[] The value of auditTrail.
See Also:
Describable.getAuditTrail()

setSecurity

public void setSecurity(Security p_security)
Sets the security attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Describable object.

Specified by:
setSecurity in interface Describable
Parameters:
p_security - The new value for security.
See Also:
Describable.getSecurity()

getSecurity

public Security getSecurity()
Description copied from interface: Describable
Returns the value of this Describable object's security attribute.

Specified by:
getSecurity in interface Describable
Returns:
gov.nih.nci.mageom.bean.AuditAndSecurity.Security The value of security.
See Also:
Describable.getSecurity()

getDescriptionsCount

public int getDescriptionsCount()
Returns the count of all Description associated with this Describable object.

Returns:
the count
See Also:
Describable.getDescriptions()

getAuditTrailCount

public int getAuditTrailCount()
Returns the count of all Audit associated with this Describable object.

Returns:
the count
See Also:
Describable.getAuditTrail()

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.