KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fop > pdf > PDFFilter


1 /*
2  * $Id: PDFFilter.java,v 1.3.2.1 2003/02/25 14:29:37 jeremias Exp $
3  * ============================================================================
4  * The Apache Software License, Version 1.1
5  * ============================================================================
6  *
7  * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without modifica-
10  * tion, are permitted provided that the following conditions are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright notice,
13  * this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright notice,
16  * this list of conditions and the following disclaimer in the documentation
17  * and/or other materials provided with the distribution.
18  *
19  * 3. The end-user documentation included with the redistribution, if any, must
20  * include the following acknowledgment: "This product includes software
21  * developed by the Apache Software Foundation (http://www.apache.org/)."
22  * Alternately, this acknowledgment may appear in the software itself, if
23  * and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. The names "FOP" and "Apache Software Foundation" must not be used to
26  * endorse or promote products derived from this software without prior
27  * written permission. For written permission, please contact
28  * apache@apache.org.
29  *
30  * 5. Products derived from this software may not be called "Apache", nor may
31  * "Apache" appear in their name, without prior written permission of the
32  * Apache Software Foundation.
33  *
34  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
35  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
37  * APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
39  * DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
40  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
41  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
43  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44  * ============================================================================
45  *
46  * This software consists of voluntary contributions made by many individuals
47  * on behalf of the Apache Software Foundation and was originally created by
48  * James Tauber <jtauber@jtauber.com>. For more information on the Apache
49  * Software Foundation, please see <http://www.apache.org/>.
50  */
51 package org.apache.fop.pdf;
52
53 /**
54  * represent a PDF filter object
55  * @author Eric SCHAEFFER, Kelly A. Campbell
56  */
57 public abstract class PDFFilter {
58     /*
59      * These are no longer needed, but are here as a reminder about what
60      * filters pdf supports.
61      * public static final int ASCII_HEX_DECODE = 1;
62      * public static final int ASCII_85_DECODE = 2;
63      * public static final int LZW_DECODE = 3;
64      * public static final int RUN_LENGTH_DECODE = 4;
65      * public static final int CCITT_FAX_DECODE = 5;
66      * public static final int DCT_DECODE = 6;
67      * public static final int FLATE_DECODE = 7;
68      */
69
70     /**
71      * Marker to know if this filter has already been applied to the data
72      */
73     private boolean _applied = false;
74
75     public boolean isApplied() {
76         return _applied;
77     }
78
79     /**
80      * Set the applied attribute to the given value. This attribute is
81      * used to determine if this filter is just a placeholder for the
82      * decodeparms and dictionary entries, or if the filter needs to
83      * actually encode the data. For example if the raw data is copied
84      * out of an image file in it's compressed format, then this
85      * should be set to true and the filter options should be set to
86      * those which the raw data was encoded with.
87      */
88     public void setApplied(boolean b) {
89         _applied = b;
90     }
91
92
93     /**
94      * return a PDF string representation of the filter, e.g. /FlateDecode
95      */
96     public abstract String JavaDoc getName();
97
98     /**
99      * return a parameter dictionary for this filter, or null
100      */
101     public abstract String JavaDoc getDecodeParms();
102
103     /**
104      * encode the given data with the filter
105      */
106     public abstract byte[] encode(byte[] data);
107
108
109
110 }
111
Popular Tags