org.apache.fop.pdf
Class PDFMetadata

java.lang.Object
  org.apache.fop.pdf.PDFObject
      org.apache.fop.pdf.AbstractPDFStream
          org.apache.fop.pdf.PDFStream
              org.apache.fop.pdf.PDFMetadata

public class PDFMetadata

extends PDFStream

Special PDFStream for Metadata.

Since:

PDF 1.4

Field Summary

Fields inherited from class org.apache.fop.pdf.PDFStream

data

Fields inherited from class org.apache.fop.pdf.PDFObject

DATE_FORMAT, log

Constructor Summary

PDFMetadata(org.apache.xmlgraphics.xmp.Metadata xmp, boolean readOnly)

Method Summary

protected java.lang.String	buildStreamDict(java.lang.String lengthEntry) Constructs the dictionary for the stream.
static org.apache.xmlgraphics.xmp.Metadata	createXMPFromUserAgent(PDFDocument pdfDoc) Creates an XMP document based on the settings on the PDF Document.
org.apache.xmlgraphics.xmp.Metadata	getMetadata()
protected int	output(java.io.OutputStream stream) overload the base object method so we don't have to copy byte arrays around so much
protected void	outputRawStreamData(java.io.OutputStream out) Sends the raw stream data to the target OutputStream.
protected void	setupFilterList() Sets up the default filters for this stream if they haven't been set from outside.
static void	updateInfoFromMetadata(org.apache.xmlgraphics.xmp.Metadata meta, PDFInfo info) Updates the values in the Info object from the XMP metadata according to the rules defined in PDF/A-1 (ISO 19005-1:2005)

Methods inherited from class org.apache.fop.pdf.PDFStream

add, getDataLength, getSizeHint, setData

Methods inherited from class org.apache.fop.pdf.AbstractPDFStream

encodeAndWriteStream, encodeStream, getFilterList, outputStreamData, prepareImplicitFilters

Methods inherited from class org.apache.fop.pdf.PDFObject

encode, encodeString, encodeText, formatDateTime, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, hasObjectNumber, referencePDF, setDocument, setObjectNumber, toPDF, toPDFString

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFMetadata

public PDFMetadata(org.apache.xmlgraphics.xmp.Metadata xmp,
                   boolean readOnly)

See Also:

PDFObject.PDFObject()

Method Detail

setupFilterList

protected void setupFilterList()

Description copied from class: AbstractPDFStream

Sets up the default filters for this stream if they haven't been set from outside.

Overrides:

setupFilterList in class AbstractPDFStream

See Also:

AbstractPDFStream.setupFilterList()

getMetadata

public org.apache.xmlgraphics.xmp.Metadata getMetadata()

Returns:

the XMP metadata

output

protected int output(java.io.OutputStream stream)
              throws java.io.IOException

overload the base object method so we don't have to copy byte arrays around so much

Overrides:

output in class PDFStream

Throws:

java.io.IOException

See Also:

PDFObject.output(OutputStream)

outputRawStreamData

protected void outputRawStreamData(java.io.OutputStream out)
                            throws java.io.IOException

Description copied from class: AbstractPDFStream

Sends the raw stream data to the target OutputStream.

Overrides:

outputRawStreamData in class PDFStream

Throws:

java.io.IOException

See Also:

AbstractPDFStream.outputRawStreamData(java.io.OutputStream)

buildStreamDict

protected java.lang.String buildStreamDict(java.lang.String lengthEntry)

Description copied from class: AbstractPDFStream

Constructs the dictionary for the stream. Override this method if you need additional entries.

Overrides:

buildStreamDict in class AbstractPDFStream

Parameters:

lengthEntry - value for the /Length entry

Returns:

the newly constructed dictionary

See Also:

AbstractPDFStream.buildStreamDict(String)

createXMPFromUserAgent

public static org.apache.xmlgraphics.xmp.Metadata createXMPFromUserAgent(PDFDocument pdfDoc)

Creates an XMP document based on the settings on the PDF Document.

Parameters:

pdfDoc - the PDF Document

Returns:

the requested XMP metadata

updateInfoFromMetadata

public static void updateInfoFromMetadata(org.apache.xmlgraphics.xmp.Metadata meta,
                                          PDFInfo info)

Updates the values in the Info object from the XMP metadata according to the rules defined in PDF/A-1 (ISO 19005-1:2005)

Parameters:

meta - the metadata

info - the Info object