org.apache.pdfbox.pdmodel.fdf

Class FDFDocument

java.lang.Object

org.apache.pdfbox.pdmodel.fdf.FDFDocument

public class FDFDocument
extends java.lang.Object

This is the in-memory representation of the FDF document. You need to call close() on this object when you are done using it!!

Version:

$Revision: 1.6 $

Author:

Ben Litchfield

Constructor Summary

Constructors

Constructor and Description
FDFDocument() Constructor, creates a new FDF document.
FDFDocument(COSDocument doc) Constructor that uses an existing document.
FDFDocument(org.w3c.dom.Document doc) This will create an FDF document from an XFDF XML document.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() This will close the underlying COSDocument object.
FDFCatalog	getCatalog() This will get the FDF Catalog.
COSDocument	getDocument() This will get the low level document.
static FDFDocument	load(java.io.File file) This will load a document from a file.
static FDFDocument	load(java.io.InputStream input) This will load a document from an input stream.
static FDFDocument	load(java.lang.String filename) This will load a document from a file.
static FDFDocument	loadXFDF(java.io.File file) This will load a document from a file.
static FDFDocument	loadXFDF(java.io.InputStream input) This will load a document from an input stream.
static FDFDocument	loadXFDF(java.lang.String filename) This will load a document from a file.
void	save(java.io.File fileName) This will save this document to the filesystem.
void	save(java.io.OutputStream output) This will save the document to an output stream.
void	save(java.lang.String fileName) This will save this document to the filesystem.
void	saveXFDF(java.io.File fileName) This will save this document to the filesystem.
void	saveXFDF(java.lang.String fileName) This will save this document to the filesystem.
void	saveXFDF(java.io.Writer output) This will save the document to an output stream and close the stream.
void	setCatalog(FDFCatalog cat) This will set the FDF catalog for this FDF document.
void	writeXML(java.io.Writer output) This will write this element as an XML document.

Methods inherited from class java.lang.Object

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

Constructor Detail

FDFDocument

public FDFDocument()
            throws java.io.IOException

Constructor, creates a new FDF document.

Throws:

java.io.IOException - If there is an error creating this document.

FDFDocument

public FDFDocument(COSDocument doc)

Constructor that uses an existing document. The COSDocument that is passed in must be valid.

Parameters:

doc - The COSDocument that this document wraps.

FDFDocument

public FDFDocument(org.w3c.dom.Document doc)
            throws java.io.IOException

This will create an FDF document from an XFDF XML document.

Parameters:

doc - The XML document that contains the XFDF data.

Throws:

java.io.IOException - If there is an error reading from the dom.

Method Detail

writeXML

public void writeXML(java.io.Writer output)
              throws java.io.IOException

This will write this element as an XML document.

Parameters:

output - The stream to write the xml to.

Throws:

java.io.IOException - If there is an error writing the XML.

getDocument

public COSDocument getDocument()

This will get the low level document.

Returns:

The document that this layer sits on top of.

getCatalog

public FDFCatalog getCatalog()

This will get the FDF Catalog. This is guaranteed to not return null.

Returns:

The documents /Root dictionary

setCatalog

public void setCatalog(FDFCatalog cat)

This will set the FDF catalog for this FDF document.

Parameters:

cat - The FDF catalog.

load

public static FDFDocument load(java.lang.String filename)
                        throws java.io.IOException

This will load a document from a file.

Parameters:

filename - The name of the file to load.

Returns:

The document that was loaded.

Throws:

java.io.IOException - If there is an error reading from the stream.

load

public static FDFDocument load(java.io.File file)
                        throws java.io.IOException

This will load a document from a file.

Parameters:

file - The name of the file to load.

Returns:

The document that was loaded.

Throws:

java.io.IOException - If there is an error reading from the stream.

load

public static FDFDocument load(java.io.InputStream input)
                        throws java.io.IOException

This will load a document from an input stream.

Parameters:

input - The stream that contains the document.

Returns:

The document that was loaded.

Throws:

java.io.IOException - If there is an error reading from the stream.

loadXFDF

public static FDFDocument loadXFDF(java.lang.String filename)
                            throws java.io.IOException

This will load a document from a file.

Parameters:

filename - The name of the file to load.

Returns:

The document that was loaded.

Throws:

java.io.IOException - If there is an error reading from the stream.

loadXFDF

public static FDFDocument loadXFDF(java.io.File file)
                            throws java.io.IOException

This will load a document from a file.

Parameters:

file - The name of the file to load.

Returns:

The document that was loaded.

Throws:

java.io.IOException - If there is an error reading from the stream.

loadXFDF

public static FDFDocument loadXFDF(java.io.InputStream input)
                            throws java.io.IOException

This will load a document from an input stream.

Parameters:

input - The stream that contains the document.

Returns:

The document that was loaded.

Throws:

java.io.IOException - If there is an error reading from the stream.

save

public void save(java.io.File fileName)
          throws java.io.IOException,
                 COSVisitorException

This will save this document to the filesystem.

Parameters:

fileName - The file to save as.

Throws:

java.io.IOException - If there is an error saving the document.

COSVisitorException - If an error occurs while generating the data.

save

public void save(java.lang.String fileName)
          throws java.io.IOException,
                 COSVisitorException

This will save this document to the filesystem.

Parameters:

fileName - The file to save as.

Throws:

java.io.IOException - If there is an error saving the document.

COSVisitorException - If an error occurs while generating the data.

save

public void save(java.io.OutputStream output)
          throws java.io.IOException,
                 COSVisitorException

This will save the document to an output stream.

Parameters:

output - The stream to write to.

Throws:

java.io.IOException - If there is an error writing the document.

COSVisitorException - If an error occurs while generating the data.

saveXFDF

public void saveXFDF(java.io.File fileName)
              throws java.io.IOException,
                     COSVisitorException

This will save this document to the filesystem.

Parameters:

fileName - The file to save as.

Throws:

java.io.IOException - If there is an error saving the document.

COSVisitorException - If an error occurs while generating the data.

saveXFDF

public void saveXFDF(java.lang.String fileName)
              throws java.io.IOException,
                     COSVisitorException

This will save this document to the filesystem.

Parameters:

fileName - The file to save as.

Throws:

java.io.IOException - If there is an error saving the document.

COSVisitorException - If an error occurs while generating the data.

saveXFDF

public void saveXFDF(java.io.Writer output)
              throws java.io.IOException,
                     COSVisitorException

This will save the document to an output stream and close the stream.

Parameters:

output - The stream to write to.

Throws:

java.io.IOException - If there is an error writing the document.

COSVisitorException - If an error occurs while generating the data.

close

public void close()
           throws java.io.IOException

This will close the underlying COSDocument object.

Throws:

java.io.IOException - If there is an error releasing resources.