org.apache.fop.pdf

Class PDFFilter

Known Direct Subclasses:
ASCII85Filter, ASCIIHexFilter, FlateFilter, NullFilter

public abstract class PDFFilter
extends java.lang.Object

PDF Filter class. This represents a PDF filter object. Filter implementations should extend this class.
Author:
Eric SCHAEFFER, Kelly A. Campbell

Method Summary

abstract OutputStream
applyFilter(OutputStream out)
Applies a filter to an OutputStream.
abstract PDFObject
getDecodeParms()
return a parameter dictionary for this filter, or null
abstract String
getName()
return a PDF string representation of the filter, e.g.
boolean
isASCIIFilter()
Returns true if the filter is an ASCII filter that isn't necessary when encryption is active.
boolean
isApplied()
Check if this filter has been applied.
void
setApplied(boolean b)
Set the applied attribute to the given value.

Method Details

applyFilter

public abstract OutputStream applyFilter(OutputStream out)
            throws IOException
Applies a filter to an OutputStream.
Parameters:
out - contents to be filtered
Returns:
OutputStream filtered contents

getDecodeParms

public abstract PDFObject getDecodeParms()
return a parameter dictionary for this filter, or null
Returns:
the decode params for the filter

getName

public abstract String getName()
return a PDF string representation of the filter, e.g. /FlateDecode
Returns:
the filter PDF name

isASCIIFilter

public boolean isASCIIFilter()
Returns true if the filter is an ASCII filter that isn't necessary when encryption is active.
Returns:
boolean True if this filter is an ASCII filter

isApplied

public boolean isApplied()
Check if this filter has been applied.
Returns:
true if this filter has been applied

setApplied

public void setApplied(boolean b)
Set the applied attribute to the given value. This attribute is used to determine if this filter is just a placeholder for the decodeparms and dictionary entries, or if the filter needs to actually encode the data. For example if the raw data is copied out of an image file in it's compressed format, then this should be set to true and the filter options should be set to those which the raw data was encoded with.
Parameters:
b - set the applied value to this

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