gov.nih.nci.mageom.domain.Description.impl
Class DescriptionImpl

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.Description.impl.DescriptionImpl
All Implemented Interfaces:
Describable, Description, Extendable, java.io.Serializable

public class DescriptionImpl
extends DescribableImpl
implements Description

A free text description of an object.

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

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected  OntologyEntry[] annotations
          DOCUMENT ME
protected  int annotationsCount
          The count of OntologyEntry objects.
protected static java.util.Hashtable associationMethods
           
protected  BibliographicReference[] bibliographicReferences
          DOCUMENT ME
protected  int bibliographicReferencesCount
          The count of BibliographicReference objects.
protected  DatabaseEntry[] databaseReferences
          DOCUMENT ME
protected  int databaseReferencesCount
          The count of DatabaseEntry objects.
protected  ExternalReference externalReference
          DOCUMENT ME
protected  java.lang.Long externalReferenceId
          The internal ID of the associated externalReference object.
protected  java.lang.String text
          The description.
protected  java.lang.String URI
          A reference to the location and type of an outside resource.
 
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
DescriptionImpl()
          Default constructor
 
Method Summary
 OntologyEntry[] getAnnotations()
          Returns the value of this Description object's annotations attribute.
 int getAnnotationsCount()
          Returns the count of all OntologyEntry associated with this Description object.
 BibliographicReference[] getBibliographicReferences()
          Returns the value of this Description object's bibliographicReferences attribute.
 int getBibliographicReferencesCount()
          Returns the count of all BibliographicReference associated with this Description object.
 DatabaseEntry[] getDatabaseReferences()
          Returns the value of this Description object's databaseReferences attribute.
 int getDatabaseReferencesCount()
          Returns the count of all DatabaseEntry associated with this Description object.
 ExternalReference getExternalReference()
          Returns the value of this Description object's externalReference attribute.
 java.lang.String getText()
          Returns the value of this Description object's text attribute.
 java.lang.String getURI()
          Returns the value of this Description object's URI attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 Description[] searchDescriptions(DescriptionSearchCriteria criteria)
          Returns an array of Description objects that satisfy the given DescriptionSearchCriteria.
 void setAnnotations(OntologyEntry[] p_annotations)
          Sets the annotations attribute.
 void setBibliographicReferences(BibliographicReference[] p_bibliographicReferences)
          Sets the bibliographicReferences attribute.
 void setDatabaseReferences(DatabaseEntry[] p_databaseReferences)
          Sets the databaseReferences attribute.
 void setExternalReference(ExternalReference p_externalReference)
          Sets the externalReference attribute.
 void setText(java.lang.String p_text)
          Sets the text attribute.
 void setURI(java.lang.String p_URI)
          Sets the URI 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.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.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

text

protected java.lang.String text
The description.


URI

protected java.lang.String URI
A reference to the location and type of an outside resource.


databaseReferencesCount

protected int databaseReferencesCount
The count of DatabaseEntry objects.


databaseReferences

protected DatabaseEntry[] databaseReferences
DOCUMENT ME


bibliographicReferencesCount

protected int bibliographicReferencesCount
The count of BibliographicReference objects.


bibliographicReferences

protected BibliographicReference[] bibliographicReferences
DOCUMENT ME


externalReference

protected ExternalReference externalReference
DOCUMENT ME


externalReferenceId

protected java.lang.Long externalReferenceId
The internal ID of the associated externalReference object.


annotationsCount

protected int annotationsCount
The count of OntologyEntry objects.


annotations

protected OntologyEntry[] annotations
DOCUMENT ME

Constructor Detail

DescriptionImpl

public DescriptionImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class DescribableImpl

searchDescriptions

public Description[] searchDescriptions(DescriptionSearchCriteria criteria)
                                 throws gov.nih.nci.common.search.SearchException
Returns an array of Description objects that satisfy the given DescriptionSearchCriteria.

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

setText

public void setText(java.lang.String p_text)
Sets the text attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Description object.

Specified by:
setText in interface Description
Parameters:
p_text - The new value for text.
See Also:
Description.getText()

getText

public java.lang.String getText()
Description copied from interface: Description
Returns the value of this Description object's text attribute. Description of text: The description.

Specified by:
getText in interface Description
Returns:
String The value of text.
See Also:
Description.getText()

setURI

public void setURI(java.lang.String p_URI)
Sets the URI attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Description object.

Specified by:
setURI in interface Description
Parameters:
p_URI - The new value for URI.
See Also:
Description.getURI()

getURI

public java.lang.String getURI()
Description copied from interface: Description
Returns the value of this Description object's URI attribute. Description of URI: A reference to the location and type of an outside resource.

Specified by:
getURI in interface Description
Returns:
String The value of URI.
See Also:
Description.getURI()

setDatabaseReferences

public void setDatabaseReferences(DatabaseEntry[] p_databaseReferences)
Sets the databaseReferences attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Description object.

Specified by:
setDatabaseReferences in interface Description
Parameters:
p_databaseReferences - The new value for databaseReferences.
See Also:
Description.getDatabaseReferences()

getDatabaseReferences

public DatabaseEntry[] getDatabaseReferences()
Description copied from interface: Description
Returns the value of this Description object's databaseReferences attribute.

Specified by:
getDatabaseReferences in interface Description
Returns:
gov.nih.nci.mageom.bean.Description.DatabaseEntry[] The value of databaseReferences.
See Also:
Description.getDatabaseReferences()

setBibliographicReferences

public void setBibliographicReferences(BibliographicReference[] p_bibliographicReferences)
Sets the bibliographicReferences attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Description object.

Specified by:
setBibliographicReferences in interface Description
Parameters:
p_bibliographicReferences - The new value for bibliographicReferences.
See Also:
Description.getBibliographicReferences()

getBibliographicReferences

public BibliographicReference[] getBibliographicReferences()
Description copied from interface: Description
Returns the value of this Description object's bibliographicReferences attribute.

Specified by:
getBibliographicReferences in interface Description
Returns:
gov.nih.nci.mageom.bean.BQS.BibliographicReference[] The value of bibliographicReferences.
See Also:
Description.getBibliographicReferences()

setExternalReference

public void setExternalReference(ExternalReference p_externalReference)
Sets the externalReference attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Description object.

Specified by:
setExternalReference in interface Description
Parameters:
p_externalReference - The new value for externalReference.
See Also:
Description.getExternalReference()

getExternalReference

public ExternalReference getExternalReference()
Description copied from interface: Description
Returns the value of this Description object's externalReference attribute.

Specified by:
getExternalReference in interface Description
Returns:
gov.nih.nci.mageom.bean.Description.ExternalReference The value of externalReference.
See Also:
Description.getExternalReference()

setAnnotations

public void setAnnotations(OntologyEntry[] p_annotations)
Sets the annotations attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Description object.

Specified by:
setAnnotations in interface Description
Parameters:
p_annotations - The new value for annotations.
See Also:
Description.getAnnotations()

getAnnotations

public OntologyEntry[] getAnnotations()
Description copied from interface: Description
Returns the value of this Description object's annotations attribute.

Specified by:
getAnnotations in interface Description
Returns:
gov.nih.nci.mageom.bean.Description.OntologyEntry[] The value of annotations.
See Also:
Description.getAnnotations()

getDatabaseReferencesCount

public int getDatabaseReferencesCount()
Returns the count of all DatabaseEntry associated with this Description object.

Returns:
the count
See Also:
Description.getDatabaseReferences()

getBibliographicReferencesCount

public int getBibliographicReferencesCount()
Returns the count of all BibliographicReference associated with this Description object.

Returns:
the count
See Also:
Description.getBibliographicReferences()

getAnnotationsCount

public int getAnnotationsCount()
Returns the count of all OntologyEntry associated with this Description object.

Returns:
the count
See Also:
Description.getAnnotations()

toXML

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

toXMLDoc

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

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