org.apache.fop.pdf
Class PDFMetadata
java.lang.Object
org.apache.fop.pdf.PDFObject
org.apache.fop.pdf.PDFDictionary
org.apache.fop.pdf.AbstractPDFStream
org.apache.fop.pdf.PDFStream
org.apache.fop.pdf.PDFMetadata
- All Implemented Interfaces:
- PDFWritable
public class PDFMetadata
- extends PDFStream
Special PDFStream for Metadata.
- Since:
- PDF 1.4
Constructor Summary |
PDFMetadata(org.apache.xmlgraphics.xmp.Metadata xmp,
boolean readOnly)
|
Method Summary |
static org.apache.xmlgraphics.xmp.Metadata |
createXMPFromPDFDocument(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
Overload the base object method so we don't have to copy
byte arrays around so much
Write the PDF represention of this object |
protected void |
outputRawStreamData(java.io.OutputStream out)
Sends the raw stream data to the target OutputStream. |
protected void |
populateStreamDict(java.lang.Object lengthEntry)
Populates the dictionary with all necessary entries for the stream. |
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.PDFObject |
encode, encodeBinaryToHexString, encodeString, encodeText, formatDateTime, formatDateTime, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, getParent, hasObjectNumber, makeReference, outputInline, referencePDF, setDocument, setObjectNumber, setParent, toPDF, toPDFString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PDFMetadata
public PDFMetadata(org.apache.xmlgraphics.xmp.Metadata xmp,
boolean readOnly)
- See Also:
PDFObject.PDFObject()
setupFilterList
protected void setupFilterList()
- Sets up the default filters for this stream if they haven't been set
from outside.
- Overrides:
setupFilterList
in class AbstractPDFStream
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
Overload the base object method so we don't have to copy
byte arrays around so much
Write the PDF represention of this object
- Overrides:
output
in class PDFStream
- Parameters:
stream
- the stream to write the PDF to
- Returns:
- the number of bytes written
- Throws:
java.io.IOException
- if there is an error writing to the stream
outputRawStreamData
protected void outputRawStreamData(java.io.OutputStream out)
throws java.io.IOException
- Sends the raw stream data to the target OutputStream.
- Overrides:
outputRawStreamData
in class PDFStream
- Parameters:
out
- OutputStream to write to
- Throws:
java.io.IOException
- In case of an I/O problem
populateStreamDict
protected void populateStreamDict(java.lang.Object lengthEntry)
- Populates the dictionary with all necessary entries for the stream.
Override this method if you need additional entries.
- Overrides:
populateStreamDict
in class AbstractPDFStream
- Parameters:
lengthEntry
- value for the /Length entry
createXMPFromPDFDocument
public static org.apache.xmlgraphics.xmp.Metadata createXMPFromPDFDocument(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 metadatainfo
- the Info object
Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.