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

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

public class DatabaseImpl
extends IdentifiableImpl
implements Database

An address to a repository.

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

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  Contact[] contacts
          DOCUMENT ME
protected  int contactsCount
          The count of Contact objects.
protected  java.lang.String URI
          The location of the Database.
protected  java.lang.String version
          The version for which a DatabaseReference applies.
 
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
DatabaseImpl()
          Default constructor
 
Method Summary
 Contact[] getContacts()
          Returns the value of this Database object's contacts attribute.
 int getContactsCount()
          Returns the count of all Contact associated with this Database object.
 java.lang.String getURI()
          Returns the value of this Database object's URI attribute.
 java.lang.String getVersion()
          Returns the value of this Database object's version attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 Database[] searchDatabases(DatabaseSearchCriteria criteria)
          Returns an array of Database objects that satisfy the given DatabaseSearchCriteria.
 void setContacts(Contact[] p_contacts)
          Sets the contacts attribute.
 void setURI(java.lang.String p_URI)
          Sets the URI attribute.
 void setVersion(java.lang.String p_version)
          Sets the version 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.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.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

version

protected java.lang.String version
The version for which a DatabaseReference applies.


URI

protected java.lang.String URI
The location of the Database.


contactsCount

protected int contactsCount
The count of Contact objects.


contacts

protected Contact[] contacts
DOCUMENT ME

Constructor Detail

DatabaseImpl

public DatabaseImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class IdentifiableImpl

searchDatabases

public Database[] searchDatabases(DatabaseSearchCriteria criteria)
                           throws gov.nih.nci.common.search.SearchException
Returns an array of Database objects that satisfy the given DatabaseSearchCriteria.

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

setVersion

public void setVersion(java.lang.String p_version)
Sets the version attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Database object.

Specified by:
setVersion in interface Database
Parameters:
p_version - The new value for version.
See Also:
Database.getVersion()

getVersion

public java.lang.String getVersion()
Description copied from interface: Database
Returns the value of this Database object's version attribute. Description of version: The version for which a DatabaseReference applies.

Specified by:
getVersion in interface Database
Returns:
String The value of version.
See Also:
Database.getVersion()

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 Database object.

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

getURI

public java.lang.String getURI()
Description copied from interface: Database
Returns the value of this Database object's URI attribute. Description of URI: The location of the Database.

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

setContacts

public void setContacts(Contact[] p_contacts)
Sets the contacts attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Database object.

Specified by:
setContacts in interface Database
Parameters:
p_contacts - The new value for contacts.
See Also:
Database.getContacts()

getContacts

public Contact[] getContacts()
Description copied from interface: Database
Returns the value of this Database object's contacts attribute.

Specified by:
getContacts in interface Database
Returns:
gov.nih.nci.mageom.bean.AuditAndSecurity.Contact[] The value of contacts.
See Also:
Database.getContacts()

getContactsCount

public int getContactsCount()
Returns the count of all Contact associated with this Database object.

Returns:
the count
See Also:
Database.getContacts()

toXML

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

toXMLDoc

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

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