Package 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
-
- All Implemented Interfaces:
PDFWritable
public class PDFMetadata extends PDFStream
Special PDFStream for Metadata.- Since:
- PDF 1.4
-
-
Constructor Summary
Constructors Constructor Description PDFMetadata(org.apache.xmlgraphics.xmp.Metadata xmp, boolean readOnly)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static org.apache.xmlgraphics.xmp.Metadata
createXMPFromPDFDocument(PDFDocument pdfDoc)
Creates an XMP document based on the settings on the PDF Document.protected java.lang.String
getDefaultFilterName()
Returns the name of a suitable filter for this PDF object.org.apache.xmlgraphics.xmp.Metadata
getMetadata()
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 objectprotected 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.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, add, getBufferOutputStream, getBufferWriter, getDataLength, getSizeHint, setData, streamHashCode
-
Methods inherited from class org.apache.fop.pdf.AbstractPDFStream
encodeAndWriteStream, encodeStream, get, getChildren, getDictionary, getFilterList, multipleFiltersAllowed, outputStreamData, prepareImplicitFilters, put, registerChildren, setDocument, setupFilterList
-
Methods inherited from class org.apache.fop.pdf.PDFObject
contentEquals, encode, encodeBinaryToHexString, encodeString, encodeText, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, getParent, hasObjectNumber, makeReference, outputInline, referencePDF, setObjectNumber, setObjectNumber, setObjectNumber, setParent, toPDF, toPDFString
-
-
-
-
Constructor Detail
-
PDFMetadata
public PDFMetadata(org.apache.xmlgraphics.xmp.Metadata xmp, boolean readOnly)
- Parameters:
xmp
- xmp metadatareadOnly
- true if read only- See Also:
PDFObject()
-
-
Method Detail
-
getDefaultFilterName
protected java.lang.String getDefaultFilterName()
Returns the name of a suitable filter for this PDF object.- Overrides:
getDefaultFilterName
in classAbstractPDFStream
- Returns:
- the default filter
- See Also:
PDFFilterList
-
getMetadata
public org.apache.xmlgraphics.xmp.Metadata getMetadata()
- Returns:
- the XMP metadata
-
output
public 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
-
outputRawStreamData
protected void outputRawStreamData(java.io.OutputStream out) throws java.io.IOException
Sends the raw stream data to the target OutputStream.- Overrides:
outputRawStreamData
in classPDFStream
- 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 classAbstractPDFStream
- 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
-
-