Citation (com.hfg API Documentation)

java.lang.Object
- com.hfg.citation.Citation

Direct Known Subclasses:

SeqCitation
```
public class Citation
extends Object
```
Citation data object.

Constructor Summary

Constructors
Constructor and Description

Citation()

Citation(String inValue)

Constructors
Constructor and Description
`Citation()`
`Citation(String inValue)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Citation`	`addAuthor(Author inValue)`
`Citation`	`appendRawContent(String inValue)`
`String`	`getAbstract()`
`Date`	`getAccessDate()`
`String`	`getArticleNumber()`
`List<Author>`	`getAuthors()`
`String`	`getCallNumber()`
`String`	`getDOI()`
`String`	`getInstitution()`
`String`	`getISBN()`
`String`	`getISSN()`
`String`	`getIssue()`
`Journal`	`getJournal()`
`String`	`getLanguage()`
`MediaType`	`getMediaType()`
`String`	`getNote()`
`String`	`getPages()`
`PatentData`	`getPatentData()`
`String`	`getPlaceOfPublication()`
`String`	`getPublisher()`
`String`	`getRepository()`
`String`	`getSource()`
`String`	`getTitle()`
`CitationType`	`getType()`
`String`	`getURI()`
`String`	`getURL()`
`String`	`getVersion()`
`String`	`getVolume()`
`String`	`getWebsiteTitle()`
`Integer`	`getYear()`
`Citation`	`setAbstract(String inValue)`
`Citation`	`setAccessDate(Date inValue)`
`Citation`	`setArticleNumber(String inValue)` Specify the article number for the citation source.
`Citation`	`setCallNumber(String inValue)` Specify the library call number for the citation source.
`Citation`	`setDOI(String inValue)` Specifies the digital object identifier (DOI) for the citation.
`Citation`	`setInstitution(String inValue)`
`Citation`	`setISBN(String inValue)` Specifies the international standard book number (ISBN) for the citation.
`Citation`	`setISSN(String inValue)` Specifies the international standard serial number (ISSN) for the citation.
`Citation`	`setIssue(String inValue)`
`Citation`	`setJournal(Journal inValue)`
`Citation`	`setLanguage(String inValue)`
`Citation`	`setMediaType(MediaType inValue)` Specify the media type for the citation source material.
`Citation`	`setNote(String inValue)` Specify additional citation details, commentary, or summary.
`Citation`	`setPages(String inValue)`
`Citation`	`setPatentData(PatentData inValue)`
`Citation`	`setPlaceOfPublication(String inValue)`
`Citation`	`setPublisher(String inValue)`
`Citation`	`setRawContent(String inValue)`
`Citation`	`setRepository(String inValue)` Specifies the repository in which the citation source was accessed.
`Citation`	`setSource(String inValue)` Specifies the origin of the citation material.
`Citation`	`setTitle(String inValue)`
`Citation`	`setType(CitationType inValue)`
`Citation`	`setURI(String inValue)`
`Citation`	`setURL(String inValue)`
`Citation`	`setVersion(String inValue)`
`Citation`	`setVolume(String inValue)`
`Citation`	`setWebsiteTitle(String inValue)`
`Citation`	`setYear(Integer inValue)`
`String`	`toString()`

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

- Constructor Detail
  - Citation
```
public Citation()
```
  - Citation
```
public Citation(String inValue)
```
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - setRawContent
```
public Citation setRawContent(String inValue)
```
  - appendRawContent
```
public Citation appendRawContent(String inValue)
```
  - setType
```
public Citation setType(CitationType inValue)
```
  - getType
```
public CitationType getType()
```
  - setAbstract
```
public Citation setAbstract(String inValue)
```
  - getAbstract
```
public String getAbstract()
```
  - setAccessDate
```
public Citation setAccessDate(Date inValue)
```
  - getAccessDate
```
public Date getAccessDate()
```
  - addAuthor
```
public Citation addAuthor(Author inValue)
```
  - getAuthors
```
public List<Author> getAuthors()
```
  - setCallNumber
```
public Citation setCallNumber(String inValue)
```
    Specify the library call number for the citation source.
    
    Parameters:
    
    inValue - the library call number
    
    Returns:
    
    this Citation object to facilitate method chaining.
  - getCallNumber
```
public String getCallNumber()
```
  - setArticleNumber
```
public Citation setArticleNumber(String inValue)
```
    Specify the article number for the citation source. Often used by online-only publishers.
    
    Parameters:
    
    inValue - the article number
    
    Returns:
    
    this Citation object to facilitate method chaining.
  - getArticleNumber
```
public String getArticleNumber()
```
  - setYear
```
public Citation setYear(Integer inValue)
```
  - getYear
```
public Integer getYear()
```
  - setJournal
```
public Citation setJournal(Journal inValue)
```
  - getJournal
```
public Journal getJournal()
```
  - setIssue
```
public Citation setIssue(String inValue)
```
  - getIssue
```
public String getIssue()
```
  - setMediaType
```
public Citation setMediaType(MediaType inValue)
```
    Specify the media type for the citation source material.
    
    Parameters:
    
    inValue - the media type for the citation source material
    
    Returns:
    
    this Citation object to facilitate method chaining.
  - getMediaType
```
public MediaType getMediaType()
```
  - setNote
```
public Citation setNote(String inValue)
```
    Specify additional citation details, commentary, or summary.
    
    Parameters:
    
    inValue - the note contents
    
    Returns:
    
    this Citation object to facilitate method chaining.
  - getNote
```
public String getNote()
```
  - setPages
```
public Citation setPages(String inValue)
```
  - getPages
```
public String getPages()
```
  - setPublisher
```
public Citation setPublisher(String inValue)
```
  - getPublisher
```
public String getPublisher()
```
  - setPlaceOfPublication
```
public Citation setPlaceOfPublication(String inValue)
```
  - getPlaceOfPublication
```
public String getPlaceOfPublication()
```
  - setDOI
```
public Citation setDOI(String inValue)
```
    Specifies the digital object identifier (DOI) for the citation. The DOI is a unique alphanumeric string assigned by a registration agency (the International DOI Foundation) to identify content and provide a persistent link to its location on the Internet.
    
    Parameters:
    
    inValue - the DOI string
    
    Returns:
    
    this Citation object to facilitate method chaining.
  - getDOI
```
public String getDOI()
```
  - setISBN
```
public Citation setISBN(String inValue)
```
    Specifies the international standard book number (ISBN) for the citation.
    
    Parameters:
    
    inValue - the ISBN string
    
    Returns:
    
    this Citation object to facilitate method chaining.
  - getISBN
```
public String getISBN()
```
  - setISSN
```
public Citation setISSN(String inValue)
```
    Specifies the international standard serial number (ISSN) for the citation. From the issn.org website: "An ISSN is an 8-digit code used to identify newspapers, journals, magazines and periodicals of all kinds and on all media–print and electronic."
    
    Parameters:
    
    inValue - the ISSN string
    
    Returns:
    
    this Citation object to facilitate method chaining.
  - getISSN
```
public String getISSN()
```
  - setRepository
```
public Citation setRepository(String inValue)
```
    Specifies the repository in which the citation source was accessed.
    
    Parameters:
    
    inValue - the name of the repository
    
    Returns:
    
    this Citation object to facilitate method chaining.
  - getRepository
```
public String getRepository()
```
  - setSource
```
public Citation setSource(String inValue)
```
    Specifies the origin of the citation material.
    
    Parameters:
    
    inValue - the citation source
    
    Returns:
    
    this Citation object to facilitate method chaining.
  - getSource
```
public String getSource()
```
  - setTitle
```
public Citation setTitle(String inValue)
```
  - getTitle
```
public String getTitle()
```
  - setURI
```
public Citation setURI(String inValue)
```
  - getURI
```
public String getURI()
```
  - setURL
```
public Citation setURL(String inValue)
```
  - getURL
```
public String getURL()
```
  - setVersion
```
public Citation setVersion(String inValue)
```
  - getVersion
```
public String getVersion()
```
  - setVolume
```
public Citation setVolume(String inValue)
```
  - getVolume
```
public String getVolume()
```
  - setWebsiteTitle
```
public Citation setWebsiteTitle(String inValue)
```
  - getWebsiteTitle
```
public String getWebsiteTitle()
```
  - setLanguage
```
public Citation setLanguage(String inValue)
```
  - getLanguage
```
public String getLanguage()
```
  - setInstitution
```
public Citation setInstitution(String inValue)
```
  - getInstitution
```
public String getInstitution()
```
  - setPatentData
```
public Citation setPatentData(PatentData inValue)
```
  - getPatentData
```
public PatentData getPatentData()
```

Class Citation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Citation

Citation

Method Detail

toString

setRawContent

appendRawContent

setType

getType

setAbstract

getAbstract

setAccessDate

getAccessDate

addAuthor

getAuthors

setCallNumber

getCallNumber

setArticleNumber

getArticleNumber

setYear

getYear

setJournal

getJournal

setIssue

getIssue

setMediaType

getMediaType

setNote

getNote

setPages

getPages

setPublisher

getPublisher

setPlaceOfPublication

getPlaceOfPublication

setDOI

getDOI

setISBN

getISBN

setISSN

getISSN

setRepository

getRepository

setSource

getSource

setTitle

getTitle

setURI

getURI

setURL

getURL

setVersion

getVersion

setVolume

getVolume

setWebsiteTitle

getWebsiteTitle

setLanguage

getLanguage

setInstitution

getInstitution

setPatentData

getPatentData