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

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

public class ExternalReferenceImpl
extends ExtendableImpl
implements ExternalReference

A reference to the originating source for the object.

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

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  java.lang.String exportedFromDB
          Name of the database, if applicable, that the object was exported from.
protected  java.lang.String exportedFromServer
          The originating server for the object, a network address or common name.
protected  java.lang.String exportID
          The identifier of the object at the originating source.
protected  java.lang.String exportName
          The name of the object at the originating source.
 
Fields inherited from class gov.nih.nci.mageom.domain.impl.ExtendableImpl
propertySets, propertySetsCount, securedElementId
 
Constructor Summary
ExternalReferenceImpl()
          Default constructor
 
Method Summary
 java.lang.String getExportedFromDB()
          Returns the value of this ExternalReference object's exportedFromDB attribute.
 java.lang.String getExportedFromServer()
          Returns the value of this ExternalReference object's exportedFromServer attribute.
 java.lang.String getExportID()
          Returns the value of this ExternalReference object's exportID attribute.
 java.lang.String getExportName()
          Returns the value of this ExternalReference object's exportName attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 ExternalReference[] searchExternalReferences(ExternalReferenceSearchCriteria criteria)
          Returns an array of ExternalReference objects that satisfy the given ExternalReferenceSearchCriteria.
 void setExportedFromDB(java.lang.String p_exportedFromDB)
          Sets the exportedFromDB attribute.
 void setExportedFromServer(java.lang.String p_exportedFromServer)
          Sets the exportedFromServer attribute.
 void setExportID(java.lang.String p_exportID)
          Sets the exportID attribute.
 void setExportName(java.lang.String p_exportName)
          Sets the exportName 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

exportedFromServer

protected java.lang.String exportedFromServer
The originating server for the object, a network address or common name.


exportedFromDB

protected java.lang.String exportedFromDB
Name of the database, if applicable, that the object was exported from.


exportID

protected java.lang.String exportID
The identifier of the object at the originating source.


exportName

protected java.lang.String exportName
The name of the object at the originating source.

Constructor Detail

ExternalReferenceImpl

public ExternalReferenceImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class ExtendableImpl

searchExternalReferences

public ExternalReference[] searchExternalReferences(ExternalReferenceSearchCriteria criteria)
                                             throws gov.nih.nci.common.search.SearchException
Returns an array of ExternalReference objects that satisfy the given ExternalReferenceSearchCriteria.

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

setExportedFromServer

public void setExportedFromServer(java.lang.String p_exportedFromServer)
Sets the exportedFromServer attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ExternalReference object.

Specified by:
setExportedFromServer in interface ExternalReference
Parameters:
p_exportedFromServer - The new value for exportedFromServer.
See Also:
ExternalReference.getExportedFromServer()

getExportedFromServer

public java.lang.String getExportedFromServer()
Description copied from interface: ExternalReference
Returns the value of this ExternalReference object's exportedFromServer attribute. Description of exportedFromServer: The originating server for the object, a network address or common name.

Specified by:
getExportedFromServer in interface ExternalReference
Returns:
String The value of exportedFromServer.
See Also:
ExternalReference.getExportedFromServer()

setExportedFromDB

public void setExportedFromDB(java.lang.String p_exportedFromDB)
Sets the exportedFromDB attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ExternalReference object.

Specified by:
setExportedFromDB in interface ExternalReference
Parameters:
p_exportedFromDB - The new value for exportedFromDB.
See Also:
ExternalReference.getExportedFromDB()

getExportedFromDB

public java.lang.String getExportedFromDB()
Description copied from interface: ExternalReference
Returns the value of this ExternalReference object's exportedFromDB attribute. Description of exportedFromDB: Name of the database, if applicable, that the object was exported from.

Specified by:
getExportedFromDB in interface ExternalReference
Returns:
String The value of exportedFromDB.
See Also:
ExternalReference.getExportedFromDB()

setExportID

public void setExportID(java.lang.String p_exportID)
Sets the exportID attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ExternalReference object.

Specified by:
setExportID in interface ExternalReference
Parameters:
p_exportID - The new value for exportID.
See Also:
ExternalReference.getExportID()

getExportID

public java.lang.String getExportID()
Description copied from interface: ExternalReference
Returns the value of this ExternalReference object's exportID attribute. Description of exportID: The identifier of the object at the originating source.

Specified by:
getExportID in interface ExternalReference
Returns:
String The value of exportID.
See Also:
ExternalReference.getExportID()

setExportName

public void setExportName(java.lang.String p_exportName)
Sets the exportName attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ExternalReference object.

Specified by:
setExportName in interface ExternalReference
Parameters:
p_exportName - The new value for exportName.
See Also:
ExternalReference.getExportName()

getExportName

public java.lang.String getExportName()
Description copied from interface: ExternalReference
Returns the value of this ExternalReference object's exportName attribute. Description of exportName: The name of the object at the originating source.

Specified by:
getExportName in interface ExternalReference
Returns:
String The value of exportName.
See Also:
ExternalReference.getExportName()

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.