org.dspace.disseminate

Class CitationDocument

java.lang.Object

org.dspace.disseminate.CitationDocument

public class CitationDocument
extends Object

The Citation Document produces a dissemination package (DIP) that is different that the archival package (AIP). In this case we append the descriptive metadata to the end (configurable) of the document. i.e. last page of PDF. So instead of getting the original PDF, you get a cPDF (with citation information added).

Author:

Peter Dietz (peter@longsight.com)

Constructor Summary

Constructors

Constructor and Description
CitationDocument()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	canGenerateCitationVersion(Bitstream bitstream)
int	drawStringWordWrap(org.apache.pdfbox.pdmodel.PDPage page, org.apache.pdfbox.pdmodel.edit.PDPageContentStream contentStream, String text, int startX, int startY, org.apache.pdfbox.pdmodel.font.PDFont pdfFont, float fontSize)
static void	drawTable(org.apache.pdfbox.pdmodel.PDPage page, org.apache.pdfbox.pdmodel.edit.PDPageContentStream contentStream, float y, float margin, String[][] content, org.apache.pdfbox.pdmodel.font.PDFont font, int fontSize, boolean cellBorders)
String	getAllMetadataSeparated(Item item, String metadataKey)
String	getOwningCollection(Item item)
String	getOwningCommunity(Item item)
static Boolean	isCitationEnabledForBitstream(Bitstream bitstream, Context context) Repository policy can specify to have a custom citation cover/tail page to the document, which embeds metadata.
File	makeCitedDocument(Bitstream bitstream) Creates a cited document from the given bitstream of the given item.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CitationDocument

public CitationDocument()

Method Detail

isCitationEnabledForBitstream

public static Boolean isCitationEnabledForBitstream(Bitstream bitstream,
                                    Context context)
                                             throws SQLException

Repository policy can specify to have a custom citation cover/tail page to the document, which embeds metadata. We need to determine if we will intercept this bitstream download, and give out a citation dissemination rendition. What will trigger a redirect/intercept? Citation enabled globally (all citable bitstreams will get "watermarked") modules/disseminate-citation: enable_globally OR The container is this object is whitelist enabled. - community: modules/disseminate-citation: enabled_communities - collection: modules/disseminate-citation: enabled_collections AND This User is not an admin. (Admins need to be able to view the "raw" original instead.) AND This object is citation-able (presently, just PDF) The module must be enabled, before the permission level checks happen.

Parameters:

bitstream -

Returns:

Throws:

SQLException

canGenerateCitationVersion

public static boolean canGenerateCitationVersion(Bitstream bitstream)

makeCitedDocument

public File makeCitedDocument(Bitstream bitstream)
                       throws IOException,
                              SQLException,
                              AuthorizeException,
                              org.apache.pdfbox.exceptions.COSVisitorException

Creates a cited document from the given bitstream of the given item. This requires that bitstream is contained in item.

The Process for adding a cover page is as follows:

1. Load source file into PdfReader and create a Document to put our cover page into.
2. Create cover page and add content to it.
3. Concatenate the coverpage and the source document.

Parameters:

bitstream - The source bitstream being cited. This must be a PDF.

Returns:

The temporary File that is the finished, cited document.

Throws:

FileNotFoundException

SQLException

AuthorizeException

IOException

org.apache.pdfbox.exceptions.COSVisitorException

drawStringWordWrap

public int drawStringWordWrap(org.apache.pdfbox.pdmodel.PDPage page,
                     org.apache.pdfbox.pdmodel.edit.PDPageContentStream contentStream,
                     String text,
                     int startX,
                     int startY,
                     org.apache.pdfbox.pdmodel.font.PDFont pdfFont,
                     float fontSize)
                       throws IOException

Throws:

IOException

getOwningCommunity

public String getOwningCommunity(Item item)

getOwningCollection

public String getOwningCollection(Item item)

getAllMetadataSeparated

public String getAllMetadataSeparated(Item item,
                             String metadataKey)

drawTable

public static void drawTable(org.apache.pdfbox.pdmodel.PDPage page,
             org.apache.pdfbox.pdmodel.edit.PDPageContentStream contentStream,
             float y,
             float margin,
             String[][] content,
             org.apache.pdfbox.pdmodel.font.PDFont font,
             int fontSize,
             boolean cellBorders)
                      throws IOException

Parameters:

page -

contentStream -

y - the y-coordinate of the first row

margin - the padding on left and right of table

content - a 2d array containing the table data

Throws:

IOException