fop 1.0

org.apache.fop.pdf
Class PDFMetadata

java.lang.Object
  extended by org.apache.fop.pdf.PDFObject
      extended by org.apache.fop.pdf.PDFDictionary
          extended by org.apache.fop.pdf.AbstractPDFStream
              extended by org.apache.fop.pdf.PDFStream
                  extended by org.apache.fop.pdf.PDFMetadata
All Implemented Interfaces:
PDFWritable

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.PDFDictionary
entries, order
 
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
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()
           
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.
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, getBufferOutputStream, getBufferWriter, getDataLength, getSizeHint, setData
 
Methods inherited from class org.apache.fop.pdf.AbstractPDFStream
encodeAndWriteStream, encodeStream, getFilterList, outputStreamData, prepareImplicitFilters, setupFilterList
 
Methods inherited from class org.apache.fop.pdf.PDFDictionary
get, put, put, writeDictionary
 
Methods inherited from class org.apache.fop.pdf.PDFObject
contentEquals, 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
 

Constructor Detail

PDFMetadata

public PDFMetadata(org.apache.xmlgraphics.xmp.Metadata xmp,
                   boolean readOnly)
See Also:
PDFObject.PDFObject()
Method Detail

getDefaultFilterName

protected java.lang.String getDefaultFilterName()
Returns the name of a suitable filter for this PDF object.

Overrides:
getDefaultFilterName in class AbstractPDFStream
Returns:
the default filter
See Also:
PDFFilterList

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 metadata
info - the Info object

fop 1.0

Copyright 1999-2010 The Apache Software Foundation. All Rights Reserved.