CSLItemData (citeproc-java 1.0.1 API)

java.lang.Object
- de.undercouch.citeproc.csl.CSLItemData

All Implemented Interfaces:

JsonObject
```
public class CSLItemData
extends Object
implements JsonObject
```
A citation item contains all attributes that make up a citation.

Author:

Michel Kraemer

Constructor Summary

Constructors
Constructor and Description
`CSLItemData()`
CSLItemData(String id, CSLType type, String[] categories, String language, String journalAbbreviation, String shortTitle, CSLName[] author, CSLName[] collectionEditor, CSLName[] composer, CSLName[] containerAuthor, CSLName[] director, CSLName[] editor, CSLName[] editorialDirector, CSLName[] interviewer, CSLName[] illustrator, CSLName[] originalAuthor, CSLName[] recipient, CSLName[] reviewedAuthor, CSLName[] translator, CSLDate accessed, CSLDate container, CSLDate eventDate, CSLDate issued, CSLDate originalDate, CSLDate submitted, String abstrct, String annote, String archive, String archiveLocation, String archivePlace, String authority, String callNumber, String chapterNumber, String citationNumber, String citationLabel, String collectionNumber, String collectionTitle, String containerTitle, String containerTitleShort, String dimensions, String DOI, String edition, String event, String eventPlace, String firstReferenceNoteNumber, String genre, String ISBN, String ISSN, String issue, String jurisdiction, String keyword, String locator, String medium, String note, String number, String numberOfPages, String numberOfVolumes, String originalPublisher, String originalPublisherPlace, String originalTitle, String page, String pageFirst, String PMCID, String PMID, String publisher, String publisherPlace, String references, String reviewedTitle, String scale, String section, String source, String status, String title, String titleShort, String URL, String version, String volume, String yearSuffix)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`static CSLItemData`	`fromJson(Map<String,Object> obj)` Converts a JSON object to a CSLItemData object.
`String`	`getAbstrct()`
`CSLDate`	`getAccessed()`
`String`	`getAnnote()`
`String`	`getArchive()`
`String`	`getArchiveLocation()`
`String`	`getArchivePlace()`
`CSLName[]`	`getAuthor()`
`String`	`getAuthority()`
`String`	`getCallNumber()`
`String[]`	`getCategories()`
`String`	`getChapterNumber()`
`String`	`getCitationLabel()`
`String`	`getCitationNumber()`
`CSLName[]`	`getCollectionEditor()`
`String`	`getCollectionNumber()`
`String`	`getCollectionTitle()`
`CSLName[]`	`getComposer()`
`CSLDate`	`getContainer()`
`CSLName[]`	`getContainerAuthor()`
`String`	`getContainerTitle()`
`String`	`getContainerTitleShort()`
`String`	`getDimensions()`
`CSLName[]`	`getDirector()`
`String`	`getDOI()`
`String`	`getEdition()`
`CSLName[]`	`getEditor()`
`CSLName[]`	`getEditorialDirector()`
`String`	`getEvent()`
`CSLDate`	`getEventDate()`
`String`	`getEventPlace()`
`String`	`getFirstReferenceNoteNumber()`
`String`	`getGenre()`
`String`	`getId()`
`CSLName[]`	`getIllustrator()`
`CSLName[]`	`getInterviewer()`
`String`	`getISBN()`
`String`	`getISSN()`
`String`	`getIssue()`
`CSLDate`	`getIssued()`
`String`	`getJournalAbbreviation()`
`String`	`getJurisdiction()`
`String`	`getKeyword()`
`String`	`getLanguage()`
`String`	`getLocator()`
`String`	`getMedium()`
`String`	`getNote()`
`String`	`getNumber()`
`String`	`getNumberOfPages()`
`String`	`getNumberOfVolumes()`
`CSLName[]`	`getOriginalAuthor()`
`CSLDate`	`getOriginalDate()`
`String`	`getOriginalPublisher()`
`String`	`getOriginalPublisherPlace()`
`String`	`getOriginalTitle()`
`String`	`getPage()`
`String`	`getPageFirst()`
`String`	`getPMCID()`
`String`	`getPMID()`
`String`	`getPublisher()`
`String`	`getPublisherPlace()`
`CSLName[]`	`getRecipient()`
`String`	`getReferences()`
`CSLName[]`	`getReviewedAuthor()`
`String`	`getReviewedTitle()`
`String`	`getScale()`
`String`	`getSection()`
`String`	`getShortTitle()`
`String`	`getSource()`
`String`	`getStatus()`
`CSLDate`	`getSubmitted()`
`String`	`getTitle()`
`String`	`getTitleShort()`
`CSLName[]`	`getTranslator()`
`CSLType`	`getType()`
`String`	`getURL()`
`String`	`getVersion()`
`String`	`getVolume()`
`String`	`getYearSuffix()`
`int`	`hashCode()`
`Object`	`toJson(JsonBuilder builder)` Converts this object to a JSON object

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

Constructor Detail

CSLItemData
```
public CSLItemData()
```

CSLItemData

public CSLItemData(String id,
                   CSLType type,
                   String[] categories,
                   String language,
                   String journalAbbreviation,
                   String shortTitle,
                   CSLName[] author,
                   CSLName[] collectionEditor,
                   CSLName[] composer,
                   CSLName[] containerAuthor,
                   CSLName[] director,
                   CSLName[] editor,
                   CSLName[] editorialDirector,
                   CSLName[] interviewer,
                   CSLName[] illustrator,
                   CSLName[] originalAuthor,
                   CSLName[] recipient,
                   CSLName[] reviewedAuthor,
                   CSLName[] translator,
                   CSLDate accessed,
                   CSLDate container,
                   CSLDate eventDate,
                   CSLDate issued,
                   CSLDate originalDate,
                   CSLDate submitted,
                   String abstrct,
                   String annote,
                   String archive,
                   String archiveLocation,
                   String archivePlace,
                   String authority,
                   String callNumber,
                   String chapterNumber,
                   String citationNumber,
                   String citationLabel,
                   String collectionNumber,
                   String collectionTitle,
                   String containerTitle,
                   String containerTitleShort,
                   String dimensions,
                   String DOI,
                   String edition,
                   String event,
                   String eventPlace,
                   String firstReferenceNoteNumber,
                   String genre,
                   String ISBN,
                   String ISSN,
                   String issue,
                   String jurisdiction,
                   String keyword,
                   String locator,
                   String medium,
                   String note,
                   String number,
                   String numberOfPages,
                   String numberOfVolumes,
                   String originalPublisher,
                   String originalPublisherPlace,
                   String originalTitle,
                   String page,
                   String pageFirst,
                   String PMCID,
                   String PMID,
                   String publisher,
                   String publisherPlace,
                   String references,
                   String reviewedTitle,
                   String scale,
                   String section,
                   String source,
                   String status,
                   String title,
                   String titleShort,
                   String URL,
                   String version,
                   String volume,
                   String yearSuffix)

Method Detail
- getId
```
public String getId()
```
  Returns:
  
  the citation item's id
- getType
```
public CSLType getType()
```
  Returns:
  
  the citation item's type
- getCategories
```
public String[] getCategories()
```
  Returns:
  
  the citation item's categories
- getLanguage
```
public String getLanguage()
```
  Returns:
  
  the citation item's language
- getJournalAbbreviation
```
public String getJournalAbbreviation()
```
  Returns:
  
  the citation item's journalAbbreviation
- getShortTitle
```
public String getShortTitle()
```
  Returns:
  
  the citation item's shortTitle
- getAuthor
```
public CSLName[] getAuthor()
```
  Returns:
  
  the citation item's author
- getCollectionEditor
```
public CSLName[] getCollectionEditor()
```
  Returns:
  
  the citation item's collection-editor
- getComposer
```
public CSLName[] getComposer()
```
  Returns:
  
  the citation item's composer
- getContainerAuthor
```
public CSLName[] getContainerAuthor()
```
  Returns:
  
  the citation item's container-author
- getDirector
```
public CSLName[] getDirector()
```
  Returns:
  
  the citation item's director
- getEditor
```
public CSLName[] getEditor()
```
  Returns:
  
  the citation item's editor
- getEditorialDirector
```
public CSLName[] getEditorialDirector()
```
  Returns:
  
  the citation item's editorial-director
- getInterviewer
```
public CSLName[] getInterviewer()
```
  Returns:
  
  the citation item's interviewer
- getIllustrator
```
public CSLName[] getIllustrator()
```
  Returns:
  
  the citation item's illustrator
- getOriginalAuthor
```
public CSLName[] getOriginalAuthor()
```
  Returns:
  
  the citation item's original-author
- getRecipient
```
public CSLName[] getRecipient()
```
  Returns:
  
  the citation item's recipient
- getReviewedAuthor
```
public CSLName[] getReviewedAuthor()
```
  Returns:
  
  the citation item's reviewed-author
- getTranslator
```
public CSLName[] getTranslator()
```
  Returns:
  
  the citation item's translator
- getAccessed
```
public CSLDate getAccessed()
```
  Returns:
  
  the citation item's accessed
- getContainer
```
public CSLDate getContainer()
```
  Returns:
  
  the citation item's container
- getEventDate
```
public CSLDate getEventDate()
```
  Returns:
  
  the citation item's event-date
- getIssued
```
public CSLDate getIssued()
```
  Returns:
  
  the citation item's issued
- getOriginalDate
```
public CSLDate getOriginalDate()
```
  Returns:
  
  the citation item's original-date
- getSubmitted
```
public CSLDate getSubmitted()
```
  Returns:
  
  the citation item's submitted
- getAbstrct
```
public String getAbstrct()
```
  Returns:
  
  the citation item's abstract
- getAnnote
```
public String getAnnote()
```
  Returns:
  
  the citation item's annote
- getArchive
```
public String getArchive()
```
  Returns:
  
  the citation item's archive
- getArchiveLocation
```
public String getArchiveLocation()
```
  Returns:
  
  the citation item's archive_location
- getArchivePlace
```
public String getArchivePlace()
```
  Returns:
  
  the citation item's archive-place
- getAuthority
```
public String getAuthority()
```
  Returns:
  
  the citation item's authority
- getCallNumber
```
public String getCallNumber()
```
  Returns:
  
  the citation item's call-number
- getChapterNumber
```
public String getChapterNumber()
```
  Returns:
  
  the citation item's chapter-number
- getCitationNumber
```
public String getCitationNumber()
```
  Returns:
  
  the citation item's citation-number
- getCitationLabel
```
public String getCitationLabel()
```
  Returns:
  
  the citation item's citation-label
- getCollectionNumber
```
public String getCollectionNumber()
```
  Returns:
  
  the citation item's collection-number
- getCollectionTitle
```
public String getCollectionTitle()
```
  Returns:
  
  the citation item's collection-title
- getContainerTitle
```
public String getContainerTitle()
```
  Returns:
  
  the citation item's container-title
- getContainerTitleShort
```
public String getContainerTitleShort()
```
  Returns:
  
  the citation item's container-title-short
- getDimensions
```
public String getDimensions()
```
  Returns:
  
  the citation item's dimensions
- getDOI
```
public String getDOI()
```
  Returns:
  
  the citation item's DOI
- getEdition
```
public String getEdition()
```
  Returns:
  
  the citation item's edition
- getEvent
```
public String getEvent()
```
  Returns:
  
  the citation item's event
- getEventPlace
```
public String getEventPlace()
```
  Returns:
  
  the citation item's event-place
- getFirstReferenceNoteNumber
```
public String getFirstReferenceNoteNumber()
```
  Returns:
  
  the citation item's first-reference-note-number
- getGenre
```
public String getGenre()
```
  Returns:
  
  the citation item's genre
- getISBN
```
public String getISBN()
```
  Returns:
  
  the citation item's ISBN
- getISSN
```
public String getISSN()
```
  Returns:
  
  the citation item's ISSN
- getIssue
```
public String getIssue()
```
  Returns:
  
  the citation item's issue
- getJurisdiction
```
public String getJurisdiction()
```
  Returns:
  
  the citation item's jurisdiction
- getKeyword
```
public String getKeyword()
```
  Returns:
  
  the citation item's keyword
- getLocator
```
public String getLocator()
```
  Returns:
  
  the citation item's locator
- getMedium
```
public String getMedium()
```
  Returns:
  
  the citation item's medium
- getNote
```
public String getNote()
```
  Returns:
  
  the citation item's note
- getNumber
```
public String getNumber()
```
  Returns:
  
  the citation item's number
- getNumberOfPages
```
public String getNumberOfPages()
```
  Returns:
  
  the citation item's number-of-pages
- getNumberOfVolumes
```
public String getNumberOfVolumes()
```
  Returns:
  
  the citation item's number-of-volumes
- getOriginalPublisher
```
public String getOriginalPublisher()
```
  Returns:
  
  the citation item's original-publisher
- getOriginalPublisherPlace
```
public String getOriginalPublisherPlace()
```
  Returns:
  
  the citation item's original-publisher-place
- getOriginalTitle
```
public String getOriginalTitle()
```
  Returns:
  
  the citation item's original-title
- getPage
```
public String getPage()
```
  Returns:
  
  the citation item's page
- getPageFirst
```
public String getPageFirst()
```
  Returns:
  
  the citation item's page-first
- getPMCID
```
public String getPMCID()
```
  Returns:
  
  the citation item's PMCID
- getPMID
```
public String getPMID()
```
  Returns:
  
  the citation item's PMID
- getPublisher
```
public String getPublisher()
```
  Returns:
  
  the citation item's publisher
- getPublisherPlace
```
public String getPublisherPlace()
```
  Returns:
  
  the citation item's publisher-place
- getReferences
```
public String getReferences()
```
  Returns:
  
  the citation item's references
- getReviewedTitle
```
public String getReviewedTitle()
```
  Returns:
  
  the citation item's reviewed-title
- getScale
```
public String getScale()
```
  Returns:
  
  the citation item's scale
- getSection
```
public String getSection()
```
  Returns:
  
  the citation item's section
- getSource
```
public String getSource()
```
  Returns:
  
  the citation item's source
- getStatus
```
public String getStatus()
```
  Returns:
  
  the citation item's status
- getTitle
```
public String getTitle()
```
  Returns:
  
  the citation item's title
- getTitleShort
```
public String getTitleShort()
```
  Returns:
  
  the citation item's title-short
- getURL
```
public String getURL()
```
  Returns:
  
  the citation item's URL
- getVersion
```
public String getVersion()
```
  Returns:
  
  the citation item's version
- getVolume
```
public String getVolume()
```
  Returns:
  
  the citation item's volume
- getYearSuffix
```
public String getYearSuffix()
```
  Returns:
  
  the citation item's year-suffix
- toJson
```
public Object toJson(JsonBuilder builder)
```
  Description copied from interface: JsonObject
  
  Converts this object to a JSON object
  
  Specified by:
  
  toJson in interface JsonObject
  
  Parameters:
  
  builder - a builder that can be used to perform the conversion
  
  Returns:
  
  the JSON object
- fromJson
```
public static CSLItemData fromJson(Map<String,Object> obj)
```
  Converts a JSON object to a CSLItemData object.
  
  Parameters:
  
  obj - the JSON object to convert
  
  Returns:
  
  the converted CSLItemData object
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- equals
```
public boolean equals(Object obj)
```
  Overrides:
  
  equals in class Object

Class CSLItemData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CSLItemData

CSLItemData

Method Detail

getId

getType

getCategories

getLanguage

getJournalAbbreviation

getShortTitle

getAuthor

getCollectionEditor

getComposer

getContainerAuthor

getDirector

getEditor

getEditorialDirector

getInterviewer

getIllustrator

getOriginalAuthor

getRecipient

getReviewedAuthor

getTranslator

getAccessed

getContainer

getEventDate

getIssued

getOriginalDate

getSubmitted

getAbstrct

getAnnote

getArchive

getArchiveLocation

getArchivePlace

getAuthority

getCallNumber

getChapterNumber

getCitationNumber

getCitationLabel

getCollectionNumber

getCollectionTitle

getContainerTitle

getContainerTitleShort

getDimensions

getDOI

getEdition

getEvent

getEventPlace

getFirstReferenceNoteNumber

getGenre

getISBN

getISSN

getIssue

getJurisdiction

getKeyword

getLocator

getMedium

getNote

getNumber

getNumberOfPages

getNumberOfVolumes

getOriginalPublisher

getOriginalPublisherPlace

getOriginalTitle

getPage

getPageFirst

getPMCID

getPMID

getPublisher

getPublisherPlace

getReferences

getReviewedTitle

getScale

getSection

getSource

getStatus