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

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
All Implemented Interfaces:
Describable, Extendable, Identifiable, java.io.Serializable
Direct Known Subclasses:
ArrayDesignImpl, ArrayGroupImpl, ArrayImpl, ArrayManufactureImpl, BioAssayDataClusterImpl, BioAssayDataImpl, BioAssayDimensionImpl, BioAssayImpl, BioEventImpl, BioMaterialImpl, BioSequenceImpl, ChannelImpl, CompoundImpl, ContactImpl, DatabaseImpl, DesignElementDimensionImpl, DesignElementGroupImpl, DesignElementImpl, ExperimentalFactorImpl, ExperimentImpl, FactorValueImpl, ImageImpl, ParameterImpl, ParameterizableImpl, QuantitationTypeDimensionImpl, QuantitationTypeImpl, SecurityGroupImpl, SecurityImpl, ZoneImpl

public class IdentifiableImpl
extends DescribableImpl
implements Identifiable

An Identifiable class is one that has an unambiguous reference within the scope. It also has a potentially ambiguous name.

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 identifier
          An identifier is an unambiguous string that is unique within the scope (i.e.
protected  java.lang.String name
          The potentially ambiguous common identifier.
 
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
IdentifiableImpl()
          Default constructor
 
Method Summary
 java.lang.String getIdentifier()
          Returns the value of this Identifiable object's identifier attribute.
 java.lang.String getName()
          Returns the value of this Identifiable object's name attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 Identifiable[] searchIdentifiables(IdentifiableSearchCriteria criteria)
          Returns an array of Identifiable objects that satisfy the given IdentifiableSearchCriteria.
 void setIdentifier(java.lang.String p_identifier)
          Sets the identifier attribute.
 void setName(java.lang.String p_name)
          Sets the name 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

identifier

protected java.lang.String identifier
An identifier is an unambiguous string that is unique within the scope (i.e. a document, a set of documents, or a repository) of its use.


name

protected java.lang.String name
The potentially ambiguous common identifier.

Constructor Detail

IdentifiableImpl

public IdentifiableImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class DescribableImpl

searchIdentifiables

public Identifiable[] searchIdentifiables(IdentifiableSearchCriteria criteria)
                                   throws gov.nih.nci.common.search.SearchException
Returns an array of Identifiable objects that satisfy the given IdentifiableSearchCriteria.

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

setIdentifier

public void setIdentifier(java.lang.String p_identifier)
Sets the identifier attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Identifiable object.

Specified by:
setIdentifier in interface Identifiable
Parameters:
p_identifier - The new value for identifier.
See Also:
Identifiable.getIdentifier()

getIdentifier

public java.lang.String getIdentifier()
Description copied from interface: Identifiable
Returns the value of this Identifiable object's identifier attribute. Description of identifier: An identifier is an unambiguous string that is unique within the scope (i.e. a document, a set of related documents, or a repository) of its use.

Specified by:
getIdentifier in interface Identifiable
Returns:
String The value of identifier.
See Also:
Identifiable.getIdentifier()

setName

public void setName(java.lang.String p_name)
Sets the name attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Identifiable object.

Specified by:
setName in interface Identifiable
Parameters:
p_name - The new value for name.
See Also:
Identifiable.getName()

getName

public java.lang.String getName()
Description copied from interface: Identifiable
Returns the value of this Identifiable object's name attribute. Description of name: The potentially ambiguous common identifier.

Specified by:
getName in interface Identifiable
Returns:
String The value of name.
See Also:
Identifiable.getName()

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.