CitationValueObject (Gemma 1.29.8 API)

java.lang.Object
- ubic.gemma.model.common.description.CitationValueObject

All Implemented Interfaces:

Serializable, Comparable<CitationValueObject>
```
public class CitationValueObject
extends Object
implements Comparable<CitationValueObject>, Serializable
```
Represents a BibliographicReference as a citation string (which is really super light value object). This object has four fields and is meant to be very simple, before adding anything consider using BibliographicReferenceValueObject. This can't be an inner class of BibliographicReferenceValueObject because it needs dummy constructor for dwr to work with it.

See Also:

for a more comprehensive alternative representation of BibliographicReference, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CitationValueObject()

Constructors
Constructor and Description
`CitationValueObject()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(CitationValueObject o)`
`static CitationValueObject`	`convert2CitationValueObject(BibliographicReference ref)`
`static List<CitationValueObject>`	`convert2CitationValueObjects(Collection<BibliographicReference> refs)`
`boolean`	`equals(Object obj)`
`String`	`getCitation()`
`Long`	`getId()`
`String`	`getPubmedAccession()`
`String`	`getPubmedURL()`
`int`	`hashCode()`
`boolean`	`isRetracted()`
`void`	`setCitation(String citation)`
`void`	`setId(Long id)`
`void`	`setPubmedAccession(String pubmedID)`
`void`	`setPubmedURL(String pubmedURL)`
`void`	`setRetracted(boolean retracted)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CitationValueObject
```
public CitationValueObject()
```
- Method Detail
  - convert2CitationValueObject
```
public static CitationValueObject convert2CitationValueObject(BibliographicReference ref)
```
    Parameters:
    
    ref - ref
    
    Returns:
    
    a citation value object constructed from a BibliographicReference or null if the BibliographicReference param was null
  - convert2CitationValueObjects
```
public static List<CitationValueObject> convert2CitationValueObjects(Collection<BibliographicReference> refs)
```
    Parameters:
    
    refs - refs
    
    Returns:
    
    a collection of citation value objects constructed from a collection of BibliographicReference objects or an empty list if all the BibliographicReference list param was null or empty
  - compareTo
```
public int compareTo(CitationValueObject o)
```
    Specified by:
    
    compareTo in interface Comparable<CitationValueObject>
  - getCitation
```
public String getCitation()
```
  - setCitation
```
public void setCitation(String citation)
```
  - getId
```
public Long getId()
```
  - setId
```
public void setId(Long id)
```
  - getPubmedAccession
```
public String getPubmedAccession()
```
  - setPubmedAccession
```
public void setPubmedAccession(String pubmedID)
```
  - getPubmedURL
```
public String getPubmedURL()
```
  - setPubmedURL
```
public void setPubmedURL(String pubmedURL)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - isRetracted
```
public boolean isRetracted()
```
  - setRetracted
```
public void setRetracted(boolean retracted)
```

Class CitationValueObject

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CitationValueObject

Method Detail

convert2CitationValueObject

convert2CitationValueObjects

compareTo

getCitation

setCitation

getId

setId

getPubmedAccession

setPubmedAccession

getPubmedURL

setPubmedURL

hashCode

equals

isRetracted

setRetracted