JabRef 5.15 · org.jabref.logic.xmp.DublinCoreExtractor

Modifier and Type	Field and Description
private final BibEntry	bibEntry
public static final String	DC_COVERAGE
public static final String	DC_RIGHTS
public static final String	DC_SOURCE
private final org.apache.xmpbox.schema.DublinCoreSchema	dcSchema
private static final Logger	LOGGER
private final UnprotectTermsFormatter	unprotectTermsFormatter
private final XmpPreferences	xmpPreferences

Access	Constructor and Description
public	DublinCoreExtractor(org.apache.xmpbox.schema.DublinCoreSchema Metadata in DublinCore format. dcSchema, XmpPreferences xmpPreferences, BibEntry The BibEntry object, which is filled during metadata extraction. resolvedEntry)

Method Summary

Modifier and Type	Method and Description
private void	extractAbstract() Abstract in BibTeX - Description in DublinCore
private void	extractAuthor() Author in BibTeX - Creator in DublinCore
public Optional<BibEntry>	Returns: The bibEntry extracted from the document information. extractBibtexEntry() Helper function for retrieving a BibEntry from the DublinCore metadata in a PDF file.
private void	extractBibTexFields() This method sets all fields, which are custom in BibTeX and therefore supported by JabRef, but which are not included in the DublinCore format.
private void	extractCoverage() No Equivalent in BibTeX.
private void	extractDate() BibTeX-Fields : year, [month], [day] - 'dc:date' in DublinCore
private void	extractDOI() DOI in BibTeX - Identifier in DublinCore
private void	extractEditor() Editor in BibTeX - Contributor in DublinCore
private void	extractLanguages() Language is equivalent in both formats (BibTeX and DublinCore)
private void	extractPublisher() Publisher are equivalent in both formats (BibTeX and DublinCore)
private void	extractRights() Rights are equivalent in both formats (BibTeX and DublinCore)
private void	extractSource() Source is equivalent in both formats (BibTeX and DublinCore)
private void	extractSubject() Keywords in BibTeX - Subjects in DublinCore
private void	extractTitle() Title is equivalent in both formats (BibTeX and DublinCore)
private void	extractType() Type is equivalent in both formats (BibTeX and DublinCore) Opposite method: `DublinCoreExtractor#fillType()`
private void	fillContributor(String authors) BibTeX: editor; DC: 'dc:contributor'
private void	fillCoverage(String coverage) BibTeX: Coverage (Custom Field); DC Field : Coverage
private void	fillCreator(String creators) BibTeX: author; DC: 'dc:creator'
private void	fillCustomField(Field field) All others (+ citation key) get packaged in the dc:relation attribute with `bibtex/` prefix in the content.
private void	fillDate() BibTeX: year, month; DC: 'dc:date'
private void	fillDescription(String description) BibTeX: abstract; DC: 'dc:description'
public void	fillDublinCoreSchema() Converts the content of the bibEntry to dublin core.
private void	fillIdentifier(String identifier) BibTeX:doi; DC: 'dc:identifier'
private void	fillKeywords(String value) BibTeX: keywords; DC: 'dc:subject'
private void	fillLanguages(String languages) BibTeX: language; DC: dc:language
private void	fillPublisher(String publisher) BibTeX: publisher, DC: dc:publisher
private void	fillRights(String rights) BibTeX: Rights (Custom Field); DC: dc:rights
private void	fillSource(String source) BibTeX: Source (Custom Field); DC: Source
private void	fillTitle(String title) BibTeX: title; DC: 'dc:title'
private void	fillType() Opposite method: `DublinCoreExtractor#extractType()`

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

bibEntry	back to summary
private final BibEntry bibEntry

DC_COVERAGE	back to summary
public static final String DC_COVERAGE

DC_RIGHTS	back to summary
public static final String DC_RIGHTS

DC_SOURCE	back to summary
public static final String DC_SOURCE

dcSchema	back to summary
private final org.apache.xmpbox.schema.DublinCoreSchema dcSchema

LOGGER	back to summary
private static final Logger LOGGER

unprotectTermsFormatter	back to summary
private final UnprotectTermsFormatter unprotectTermsFormatter

xmpPreferences	back to summary
private final XmpPreferences xmpPreferences

DublinCoreExtractor	back to summary
public DublinCoreExtractor(org.apache.xmpbox.schema.DublinCoreSchema dcSchema, XmpPreferences xmpPreferences, BibEntry resolvedEntry) Parameters dcSchema:org.apache.xmpbox.schema.DublinCoreSchema Metadata in DublinCore format. resolvedEntry:BibEntry The BibEntry object, which is filled during metadata extraction.

Method Detail

extractAbstract	back to summary
private void extractAbstract() Abstract in BibTeX - Description in DublinCore

extractAuthor	back to summary
private void extractAuthor() Author in BibTeX - Creator in DublinCore

extractBibtexEntry back to summary

extractBibtexEntry	back to summary
public Optional<BibEntry> extractBibtexEntry() Helper function for retrieving a BibEntry from the DublinCore metadata in a PDF file. To understand how to get hold of a DublinCore have a look in the test cases for XMPUtil. The BibEntry is build by mapping individual fields in the dublin core (like creator, title, subject) to fields in a bibtex bibEntry. In case special "bibtex/" entries are contained, the normal dublin core fields take precedence. For instance, the dublin core date takes precedence over bibtex/month. The opposite method is `DublinCoreExtractor#fillDublinCoreSchema()` Returns:Optional<BibEntry> The bibEntry extracted from the document information.

public Optional<BibEntry> extractBibtexEntry()

Helper function for retrieving a BibEntry from the DublinCore metadata in a PDF file.

To understand how to get hold of a DublinCore have a look in the test cases for XMPUtil.

The BibEntry is build by mapping individual fields in the dublin core (like creator, title, subject) to fields in a bibtex bibEntry. In case special "bibtex/" entries are contained, the normal dublin core fields take precedence. For instance, the dublin core date takes precedence over bibtex/month.

The opposite method is DublinCoreExtractor#fillDublinCoreSchema()

Returns:Optional<BibEntry>: The bibEntry extracted from the document information.

extractBibTexFields back to summary

extractBibTexFields	back to summary
private void extractBibTexFields() This method sets all fields, which are custom in BibTeX and therefore supported by JabRef, but which are not included in the DublinCore format. The relation attribute of DublinCore is abused to store these custom fields. The prefix `bibtex` is used.

private void extractBibTexFields()

This method sets all fields, which are custom in BibTeX and therefore supported by JabRef, but which are not included in the DublinCore format.

The relation attribute of DublinCore is abused to store these custom fields. The prefix bibtex is used.

extractCoverage	back to summary
private void extractCoverage() No Equivalent in BibTeX. Will create an Unknown "Coverage" Field

extractDate	back to summary
private void extractDate() BibTeX-Fields : year, [month], [day] - 'dc:date' in DublinCore

extractDOI	back to summary
private void extractDOI() DOI in BibTeX - Identifier in DublinCore

extractEditor	back to summary
private void extractEditor() Editor in BibTeX - Contributor in DublinCore

extractLanguages	back to summary
private void extractLanguages() Language is equivalent in both formats (BibTeX and DublinCore)

extractPublisher	back to summary
private void extractPublisher() Publisher are equivalent in both formats (BibTeX and DublinCore)

extractRights	back to summary
private void extractRights() Rights are equivalent in both formats (BibTeX and DublinCore)

extractSource	back to summary
private void extractSource() Source is equivalent in both formats (BibTeX and DublinCore)

extractSubject	back to summary
private void extractSubject() Keywords in BibTeX - Subjects in DublinCore

extractTitle	back to summary
private void extractTitle() Title is equivalent in both formats (BibTeX and DublinCore)

extractType back to summary

extractType	back to summary
private void extractType() Type is equivalent in both formats (BibTeX and DublinCore) Opposite method: `DublinCoreExtractor#fillType()`

private void extractType()

Type is equivalent in both formats (BibTeX and DublinCore)

Opposite method: DublinCoreExtractor#fillType()

fillContributor	back to summary
private void fillContributor(String authors) BibTeX: editor; DC: 'dc:contributor'

fillCoverage	back to summary
private void fillCoverage(String coverage) BibTeX: Coverage (Custom Field); DC Field : Coverage

fillCreator	back to summary
private void fillCreator(String creators) BibTeX: author; DC: 'dc:creator'

fillCustomField	back to summary
private void fillCustomField(Field field) All others (+ citation key) get packaged in the dc:relation attribute with `bibtex/` prefix in the content. The value of the given field is fetched from the class variable `DublinCoreExtractor#bibEntry`.

fillDate	back to summary
private void fillDate() BibTeX: year, month; DC: 'dc:date'

fillDescription	back to summary
private void fillDescription(String description) BibTeX: abstract; DC: 'dc:description'

fillDublinCoreSchema back to summary

fillDublinCoreSchema	back to summary
public void fillDublinCoreSchema() Converts the content of the bibEntry to dublin core. The opposite method is `DublinCoreExtractor#extractBibtexEntry()`. A similar method for writing the DocumentInformationItem (DII) is `XmpUtilWriter#writeDocumentInformation(PDDocument, BibEntry, BibDatabase, XmpPreferences)`

public void fillDublinCoreSchema()

Converts the content of the bibEntry to dublin core.

The opposite method is DublinCoreExtractor#extractBibtexEntry().

A similar method for writing the DocumentInformationItem (DII) is XmpUtilWriter#writeDocumentInformation(PDDocument, BibEntry, BibDatabase, XmpPreferences)

fillIdentifier	back to summary
private void fillIdentifier(String identifier) BibTeX:doi; DC: 'dc:identifier'

fillKeywords	back to summary
private void fillKeywords(String value) BibTeX: keywords; DC: 'dc:subject'

fillLanguages	back to summary
private void fillLanguages(String languages) BibTeX: language; DC: dc:language

fillPublisher	back to summary
private void fillPublisher(String publisher) BibTeX: publisher, DC: dc:publisher

fillRights	back to summary
private void fillRights(String rights) BibTeX: Rights (Custom Field); DC: dc:rights

fillSource	back to summary
private void fillSource(String source) BibTeX: Source (Custom Field); DC: Source

fillTitle	back to summary
private void fillTitle(String title) BibTeX: title; DC: 'dc:title'

fillType	back to summary
private void fillType() Opposite method: `DublinCoreExtractor#extractType()`

public Class DublinCoreExtractor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail