KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > pdfbox > pdmodel > common > function > PDDictionaryFunction


1 /**
2  * Copyright (c) 2006, www.pdfbox.org
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  * 3. Neither the name of pdfbox; nor the names of its
14  * contributors may be used to endorse or promote products derived from this
15  * software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
24  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  *
28  * http://www.pdfbox.org
29  *
30  */
31 package org.pdfbox.pdmodel.common.function;
32
33 import org.pdfbox.cos.COSArray;
34 import org.pdfbox.cos.COSBase;
35 import org.pdfbox.cos.COSDictionary;
36 import org.pdfbox.cos.COSFloat;
37 import org.pdfbox.cos.COSName;
38 import org.pdfbox.pdmodel.common.PDRange;
39
40 /**
41  * This class represents a function in a PDF document.
42  *
43  * @author <a HREF="mailto:ben@benlitchfield.com">Ben Litchfield</a>
44  * @version $Revision: 1.3 $
45  */
46 public abstract class PDDictionaryFunction extends PDFunction
47 {
48     private COSDictionary function = null;
49
50     /**
51      * Constructor to create a new blank function, should only be called by
52      * subclasses.
53      *
54      * @param functionType An integer describing the function type, only 0,2,3,4
55      * are defined by the PDF sepc.
56      */
57     protected PDDictionaryFunction( int functionType )
58     {
59         function = new COSDictionary();
60         function.setInt( "FunctionType", functionType );
61     }
62
63     /**
64      * Constructor.
65      *
66      * @param functionDictionary The prepopulated function dictionary.
67      */
68     public PDDictionaryFunction( COSDictionary functionDictionary )
69     {
70         function = functionDictionary;
71     }
72
73     /**
74      * {@inheritDoc}
75      */
76     public COSBase getCOSObject()
77     {
78         return function;
79     }
80
81     /**
82      * Get the underlying cos dictionary.
83      *
84      * @return The underlying cos dictionary.
85      */
86     public COSDictionary getCOSDictionary()
87     {
88         return function;
89     }
90     
91     private COSArray getRangeArray( String JavaDoc fieldName, int n )
92     {
93         COSArray rangeArray = (COSArray)function.getDictionaryObject( COSName.getPDFName( "Range" ) );
94         if( rangeArray == null )
95         {
96             rangeArray = new COSArray();
97             function.setItem( fieldName, rangeArray );
98             while( rangeArray.size() < n*2 )
99             {
100                 rangeArray.add( new COSFloat( 0 ) );
101                 rangeArray.add( new COSFloat( 0 ) );
102             }
103         }
104         return rangeArray;
105     }
106     
107     /**
108      * {@inheritDoc}
109      */
110     public int getNumberOfOutputParameters()
111     {
112         COSArray array = getRangeArray( "Range", 0 );
113         return array.size() / 2;
114     }
115
116     /**
117      * {@inheritDoc}
118      */
119     public PDRange getRangeForOutput( int n )
120     {
121         COSArray rangeArray = getRangeArray( "Range", n );
122         return new PDRange( rangeArray, n );
123     }
124
125     /**
126      * {@inheritDoc}
127      */
128     public void setRangeForOutput( PDRange range, int n )
129     {
130         COSArray rangeArray = getRangeArray("Range", n );
131         rangeArray.set( n*2, new COSFloat( range.getMin() ) );
132         rangeArray.set( n*2+1, new COSFloat( range.getMax() ) );
133     }
134     
135     /**
136      * {@inheritDoc}
137      */
138     public int getNumberOfInputParameters()
139     {
140         COSArray array = getRangeArray( "Domain", 0 );
141         return array.size() / 2;
142     }
143     
144     /**
145      * {@inheritDoc}
146      */
147     public PDRange getDomainForInput( int n )
148     {
149         COSArray rangeArray = getRangeArray( "Domain", n );
150         return new PDRange( rangeArray, n );
151     }
152
153     /**
154      * {@inheritDoc}
155      */
156     public void setDomainForInput( PDRange range, int n )
157     {
158         COSArray rangeArray = getRangeArray("Domain", n );
159         rangeArray.set( n*2, new COSFloat( range.getMin() ) );
160         rangeArray.set( n*2+1, new COSFloat( range.getMax() ) );
161     }
162 }
Popular Tags