gov.nih.nci.mageom.domain.BQS.impl
Class BibliographicReferenceImpl

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

public class BibliographicReferenceImpl
extends DescribableImpl
implements BibliographicReference

Attributes for the most common criteria and association with OntologyEntry allows criteria to be specified for searching for a Bibliographic reference.

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

Field Summary
protected  DatabaseEntry[] accessions
          DOCUMENT ME
protected  int accessionsCount
          The count of DatabaseEntry objects.
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  java.lang.String authors
          DOCUMENT ME
protected  java.lang.String editor
          DOCUMENT ME
protected  java.lang.String issue
          DOCUMENT ME
protected  java.lang.String pages
          DOCUMENT ME
protected  OntologyEntry[] parameters
          DOCUMENT ME
protected  int parametersCount
          The count of OntologyEntry objects.
protected  java.lang.String publication
          DOCUMENT ME
protected  java.lang.String publisher
          DOCUMENT ME
protected  java.lang.String title
          DOCUMENT ME
protected  java.lang.String URI
          DOCUMENT ME
protected  java.lang.String volume
          DOCUMENT ME
protected  java.util.Date year
          DOCUMENT ME
 
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
BibliographicReferenceImpl()
          Default constructor
 
Method Summary
 DatabaseEntry[] getAccessions()
          Returns the value of this BibliographicReference object's accessions attribute.
 int getAccessionsCount()
          Returns the count of all DatabaseEntry associated with this BibliographicReference object.
 java.lang.String getAuthors()
          Returns the value of this BibliographicReference object's authors attribute.
 java.lang.String getEditor()
          Returns the value of this BibliographicReference object's editor attribute.
 java.lang.String getIssue()
          Returns the value of this BibliographicReference object's issue attribute.
 java.lang.String getPages()
          Returns the value of this BibliographicReference object's pages attribute.
 OntologyEntry[] getParameters()
          Returns the value of this BibliographicReference object's parameters attribute.
 int getParametersCount()
          Returns the count of all OntologyEntry associated with this BibliographicReference object.
 java.lang.String getPublication()
          Returns the value of this BibliographicReference object's publication attribute.
 java.lang.String getPublisher()
          Returns the value of this BibliographicReference object's publisher attribute.
 java.lang.String getTitle()
          Returns the value of this BibliographicReference object's title attribute.
 java.lang.String getURI()
          Returns the value of this BibliographicReference object's URI attribute.
 java.lang.String getVolume()
          Returns the value of this BibliographicReference object's volume attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
 java.util.Date getYear()
          Returns the value of this BibliographicReference object's year attribute.
protected  void init()
           
 BibliographicReference[] searchBibliographicReferences(BibliographicReferenceSearchCriteria criteria)
          Returns an array of BibliographicReference objects that satisfy the given BibliographicReferenceSearchCriteria.
 void setAccessions(DatabaseEntry[] p_accessions)
          Sets the accessions attribute.
 void setAuthors(java.lang.String p_authors)
          Sets the authors attribute.
 void setEditor(java.lang.String p_editor)
          Sets the editor attribute.
 void setIssue(java.lang.String p_issue)
          Sets the issue attribute.
 void setPages(java.lang.String p_pages)
          Sets the pages attribute.
 void setParameters(OntologyEntry[] p_parameters)
          Sets the parameters attribute.
 void setPublication(java.lang.String p_publication)
          Sets the publication attribute.
 void setPublisher(java.lang.String p_publisher)
          Sets the publisher attribute.
 void setTitle(java.lang.String p_title)
          Sets the title attribute.
 void setURI(java.lang.String p_URI)
          Sets the URI attribute.
 void setVolume(java.lang.String p_volume)
          Sets the volume attribute.
 void setYear(java.util.Date p_year)
          Sets the year 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

title

protected java.lang.String title
DOCUMENT ME


authors

protected java.lang.String authors
DOCUMENT ME


publication

protected java.lang.String publication
DOCUMENT ME


publisher

protected java.lang.String publisher
DOCUMENT ME


editor

protected java.lang.String editor
DOCUMENT ME


year

protected java.util.Date year
DOCUMENT ME


volume

protected java.lang.String volume
DOCUMENT ME


issue

protected java.lang.String issue
DOCUMENT ME


pages

protected java.lang.String pages
DOCUMENT ME


URI

protected java.lang.String URI
DOCUMENT ME


parametersCount

protected int parametersCount
The count of OntologyEntry objects.


parameters

protected OntologyEntry[] parameters
DOCUMENT ME


accessionsCount

protected int accessionsCount
The count of DatabaseEntry objects.


accessions

protected DatabaseEntry[] accessions
DOCUMENT ME

Constructor Detail

BibliographicReferenceImpl

public BibliographicReferenceImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class DescribableImpl

searchBibliographicReferences

public BibliographicReference[] searchBibliographicReferences(BibliographicReferenceSearchCriteria criteria)
                                                       throws gov.nih.nci.common.search.SearchException
Returns an array of BibliographicReference objects that satisfy the given BibliographicReferenceSearchCriteria.

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

setTitle

public void setTitle(java.lang.String p_title)
Sets the title attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a BibliographicReference object.

Specified by:
setTitle in interface BibliographicReference
Parameters:
p_title - The new value for title.
See Also:
BibliographicReference.getTitle()

getTitle

public java.lang.String getTitle()
Description copied from interface: BibliographicReference
Returns the value of this BibliographicReference object's title attribute. Description of title: DOCUMENT ME!

Specified by:
getTitle in interface BibliographicReference
Returns:
String The value of title.
See Also:
BibliographicReference.getTitle()

setAuthors

public void setAuthors(java.lang.String p_authors)
Sets the authors attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a BibliographicReference object.

Specified by:
setAuthors in interface BibliographicReference
Parameters:
p_authors - The new value for authors.
See Also:
BibliographicReference.getAuthors()

getAuthors

public java.lang.String getAuthors()
Description copied from interface: BibliographicReference
Returns the value of this BibliographicReference object's authors attribute. Description of authors: DOCUMENT ME!

Specified by:
getAuthors in interface BibliographicReference
Returns:
String The value of authors.
See Also:
BibliographicReference.getAuthors()

setPublication

public void setPublication(java.lang.String p_publication)
Sets the publication attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a BibliographicReference object.

Specified by:
setPublication in interface BibliographicReference
Parameters:
p_publication - The new value for publication.
See Also:
BibliographicReference.getPublication()

getPublication

public java.lang.String getPublication()
Description copied from interface: BibliographicReference
Returns the value of this BibliographicReference object's publication attribute. Description of publication: DOCUMENT ME!

Specified by:
getPublication in interface BibliographicReference
Returns:
String The value of publication.
See Also:
BibliographicReference.getPublication()

setPublisher

public void setPublisher(java.lang.String p_publisher)
Sets the publisher attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a BibliographicReference object.

Specified by:
setPublisher in interface BibliographicReference
Parameters:
p_publisher - The new value for publisher.
See Also:
BibliographicReference.getPublisher()

getPublisher

public java.lang.String getPublisher()
Description copied from interface: BibliographicReference
Returns the value of this BibliographicReference object's publisher attribute. Description of publisher: DOCUMENT ME!

Specified by:
getPublisher in interface BibliographicReference
Returns:
String The value of publisher.
See Also:
BibliographicReference.getPublisher()

setEditor

public void setEditor(java.lang.String p_editor)
Sets the editor attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a BibliographicReference object.

Specified by:
setEditor in interface BibliographicReference
Parameters:
p_editor - The new value for editor.
See Also:
BibliographicReference.getEditor()

getEditor

public java.lang.String getEditor()
Description copied from interface: BibliographicReference
Returns the value of this BibliographicReference object's editor attribute. Description of editor: DOCUMENT ME!

Specified by:
getEditor in interface BibliographicReference
Returns:
String The value of editor.
See Also:
BibliographicReference.getEditor()

setYear

public void setYear(java.util.Date p_year)
Sets the year attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a BibliographicReference object.

Specified by:
setYear in interface BibliographicReference
Parameters:
p_year - The new value for year.
See Also:
BibliographicReference.getYear()

getYear

public java.util.Date getYear()
Description copied from interface: BibliographicReference
Returns the value of this BibliographicReference object's year attribute. Description of year: DOCUMENT ME!

Specified by:
getYear in interface BibliographicReference
Returns:
Date The value of year.
See Also:
BibliographicReference.getYear()

setVolume

public void setVolume(java.lang.String p_volume)
Sets the volume attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a BibliographicReference object.

Specified by:
setVolume in interface BibliographicReference
Parameters:
p_volume - The new value for volume.
See Also:
BibliographicReference.getVolume()

getVolume

public java.lang.String getVolume()
Description copied from interface: BibliographicReference
Returns the value of this BibliographicReference object's volume attribute. Description of volume: DOCUMENT ME!

Specified by:
getVolume in interface BibliographicReference
Returns:
String The value of volume.
See Also:
BibliographicReference.getVolume()

setIssue

public void setIssue(java.lang.String p_issue)
Sets the issue attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a BibliographicReference object.

Specified by:
setIssue in interface BibliographicReference
Parameters:
p_issue - The new value for issue.
See Also:
BibliographicReference.getIssue()

getIssue

public java.lang.String getIssue()
Description copied from interface: BibliographicReference
Returns the value of this BibliographicReference object's issue attribute. Description of issue: DOCUMENT ME!

Specified by:
getIssue in interface BibliographicReference
Returns:
String The value of issue.
See Also:
BibliographicReference.getIssue()

setPages

public void setPages(java.lang.String p_pages)
Sets the pages attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a BibliographicReference object.

Specified by:
setPages in interface BibliographicReference
Parameters:
p_pages - The new value for pages.
See Also:
BibliographicReference.getPages()

getPages

public java.lang.String getPages()
Description copied from interface: BibliographicReference
Returns the value of this BibliographicReference object's pages attribute. Description of pages: DOCUMENT ME!

Specified by:
getPages in interface BibliographicReference
Returns:
String The value of pages.
See Also:
BibliographicReference.getPages()

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

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

getURI

public java.lang.String getURI()
Description copied from interface: BibliographicReference
Returns the value of this BibliographicReference object's URI attribute. Description of URI: DOCUMENT ME!

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

setParameters

public void setParameters(OntologyEntry[] p_parameters)
Sets the parameters attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a BibliographicReference object.

Specified by:
setParameters in interface BibliographicReference
Parameters:
p_parameters - The new value for parameters.
See Also:
BibliographicReference.getParameters()

getParameters

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

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

setAccessions

public void setAccessions(DatabaseEntry[] p_accessions)
Sets the accessions attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a BibliographicReference object.

Specified by:
setAccessions in interface BibliographicReference
Parameters:
p_accessions - The new value for accessions.
See Also:
BibliographicReference.getAccessions()

getAccessions

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

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

getParametersCount

public int getParametersCount()
Returns the count of all OntologyEntry associated with this BibliographicReference object.

Returns:
the count
See Also:
BibliographicReference.getParameters()

getAccessionsCount

public int getAccessionsCount()
Returns the count of all DatabaseEntry associated with this BibliographicReference object.

Returns:
the count
See Also:
BibliographicReference.getAccessions()

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.