fop 0.92beta

org.apache.fop.pdf
Class PDFMetadata

java.lang.Object
  extended byorg.apache.fop.pdf.PDFObject
      extended byorg.apache.fop.pdf.AbstractPDFStream
          extended byorg.apache.fop.pdf.PDFStream
              extended byorg.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.w3c.dom.Document xmp, boolean readOnly)
           
 
Method Summary
protected  boolean allowEncryption()
           
protected  java.lang.String buildStreamDict(java.lang.String lengthEntry)
          Constructs the dictionary for the stream.
static org.w3c.dom.Document createXMPFromUserAgent(PDFDocument pdfDoc)
          Creates an XMP document based on the settings on the PDF Document.
static java.lang.String formatISO8601Date(java.util.Date dt)
          Formats a Date using ISO 8601 format in the default time zone.
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.
 
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.w3c.dom.Document 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()

allowEncryption

protected boolean allowEncryption()
See Also:
org.apache.fop.pdf.AbstractPDFStream#allowEncryption()

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)

formatISO8601Date

public static java.lang.String formatISO8601Date(java.util.Date dt)
Formats a Date using ISO 8601 format in the default time zone.

Parameters:
dt - the date
Returns:
the formatted date

createXMPFromUserAgent

public static org.w3c.dom.Document createXMPFromUserAgent(PDFDocument pdfDoc)
Creates an XMP document based on the settings on the PDF Document.

Parameters:
pdfDoc - the PDF Document
Returns:
a DOM document representing the requested XMP metadata

fop 0.92beta

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