From 6025b6016517c6d898d8957d1d7e03ba71431912 Mon Sep 17 00:00:00 2001
From: tknall <tknall@7b5415b0-85f9-ee4d-85bd-d5d0c3b42d1c>
Date: Fri, 1 Dec 2006 12:20:24 +0000
Subject: Initial import of release 2.2.

git-svn-id: https://joinup.ec.europa.eu/svn/pdf-as/trunk@4 7b5415b0-85f9-ee4d-85bd-d5d0c3b42d1c
---
 .../org/pdfbox/pdmodel/common/PDNameTreeNode.java  | 337 +++++++++++++++++++++
 1 file changed, 337 insertions(+)
 create mode 100644 src/main/java/org/pdfbox/pdmodel/common/PDNameTreeNode.java

(limited to 'src/main/java/org/pdfbox/pdmodel/common/PDNameTreeNode.java')

diff --git a/src/main/java/org/pdfbox/pdmodel/common/PDNameTreeNode.java b/src/main/java/org/pdfbox/pdmodel/common/PDNameTreeNode.java
new file mode 100644
index 0000000..4a79d10
--- /dev/null
+++ b/src/main/java/org/pdfbox/pdmodel/common/PDNameTreeNode.java
@@ -0,0 +1,337 @@
+/**
+ * Copyright (c) 2004-2005, www.pdfbox.org
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 3. Neither the name of pdfbox; nor the names of its
+ *    contributors may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * http://www.pdfbox.org
+ *
+ */
+package org.pdfbox.pdmodel.common;
+
+import java.io.IOException;
+import java.lang.reflect.Constructor;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import org.pdfbox.cos.COSArray;
+import org.pdfbox.cos.COSBase;
+import org.pdfbox.cos.COSDictionary;
+import org.pdfbox.cos.COSString;
+
+/**
+ * This class represends a PDF Name tree.  See the PDF Reference 1.5 section 3.8.5
+ * for more details.
+ *
+ * @author Ben Litchfield (ben@benlitchfield.com)
+ * @version $Revision: 1.3 $
+ */
+public class PDNameTreeNode implements COSObjectable
+{
+    private COSDictionary node;
+    private Class valueType = null;
+
+    /**
+     * Constructor.
+     * 
+     * @param valueClass The PD Model type of object that is the value.
+     */
+    public PDNameTreeNode( Class valueClass )
+    {
+        node = new COSDictionary();
+        valueType = valueClass;
+    }
+
+    /**
+     * Constructor.
+     *
+     * @param dict The dictionary that holds the name information.
+     * @param valueClass The PD Model type of object that is the value.
+     */
+    public PDNameTreeNode( COSDictionary dict, Class valueClass )
+    {
+        node = dict;
+        valueType = valueClass;
+    }
+
+    /**
+     * Convert this standard java object to a COS object.
+     *
+     * @return The cos object that matches this Java object.
+     */
+    public COSBase getCOSObject()
+    {
+        return node;
+    }
+
+    /**
+     * Convert this standard java object to a COS object.
+     *
+     * @return The cos object that matches this Java object.
+     */
+    public COSDictionary getCOSDictionary()
+    {
+        return node;
+    }
+    
+    /**
+     * Return the children of this node.  This list will contain PDNameTreeNode objects.
+     * 
+     * @return The list of children or null if there are no children.
+     */
+    public List getKids()
+    {
+        
+        List retval = null;
+        COSArray kids = (COSArray)node.getDictionaryObject( "Kids" );
+        if( kids != null )
+        {
+            List pdObjects = new ArrayList();
+            for( int i=0; i<kids.size(); i++ )
+            {
+                pdObjects.add( createChildNode( (COSDictionary)kids.getObject(i) ) );
+            }
+            retval = new COSArrayList(pdObjects,kids);
+        }
+        
+        return retval;
+    }
+    
+    /**
+     * Set the children of this named tree.
+     * 
+     * @param kids The children of this named tree.
+     */
+    public void setKids( List kids )
+    {
+        node.setItem( "Kids", COSArrayList.converterToCOSArray( kids ) );
+    }
+    
+    /**
+     * The name to retrieve.
+     * 
+     * @param name The name in the tree.
+     * 
+     * @return The value of the name in the tree.
+     * 
+     * @throws IOException If an there is a problem creating the destinations.
+     */
+    public Object getValue( String name ) throws IOException
+    {
+        Object retval = null;
+        Map names = getNames();
+        if( names != null )
+        {
+            retval = names.get( name );
+        }
+        else
+        {
+            List kids = getKids();
+            for( int i=0; i<kids.size() && retval == null; i++ )
+            {
+                PDNameTreeNode childNode = (PDNameTreeNode)kids.get( i );
+                if( childNode.getLowerLimit().compareTo( name ) <= 0 &&
+                        childNode.getUpperLimit().compareTo( name ) >= 0 )
+                {
+                    retval = childNode.getValue( name );
+                }
+            }
+        }
+        return retval;
+    }
+    
+    
+    /**
+     * This will return a map of names.  The key will be a java.lang.String the value will
+     * depend on where this class is being used.
+     * 
+     * @return A map of cos objects.
+     * 
+     * @throws IOException If there is an error while creating the sub types.
+     */
+    public Map getNames() throws IOException
+    {
+        Map names = null;
+        COSArray namesArray = (COSArray)node.getDictionaryObject( "Names" );
+        if( namesArray != null )
+        {
+            names = new HashMap();
+            for( int i=0; i<namesArray.size(); i+=2 )
+            {
+                COSString key = (COSString)namesArray.getObject(i);
+                COSBase cosValue = namesArray.getObject( i+1 );
+                Object pdValue = convertCOSToPD( cosValue );
+                
+                names.put( key.getString(), pdValue );
+            }
+            names = Collections.unmodifiableMap(names);
+        }
+        
+        return names;
+    }
+    
+    /**
+     * Method to convert the COS value in the name tree to the PD Model object.  The
+     * default implementation will simply use reflection to create the correct object
+     * type.  Subclasses can do whatever they want.
+     * 
+     * @param base The COS object to convert.
+     * @return The converted PD Model object.
+     * @throws IOException If there is an error during creation.
+     */
+    protected Object convertCOSToPD( COSBase base ) throws IOException
+    {
+        Object retval = null;
+        try
+        {
+            Constructor ctor = valueType.getConstructor( new Class[] { base.getClass() } );
+            retval = ctor.newInstance( new Object[] { base } );
+        }
+        catch( Throwable t )
+        {
+            throw new IOException( "Error while trying to create value in named tree:" + t.getMessage());
+            
+        }
+        return retval;
+    }
+    
+    /**
+     * Create a child node object.
+     * 
+     * @param dic The dictionary for the child node object to refer to.
+     * @return The new child node object.
+     */
+    protected PDNameTreeNode createChildNode( COSDictionary dic )
+    {
+        return new PDNameTreeNode(dic,valueType);
+    }
+    
+    /**
+     * Set the names of for this node.  The keys should be java.lang.String and the 
+     * values must be a COSObjectable.  This method will set the appropriate upper and lower
+     * limits based on the keys in the map.
+     * 
+     * @param names The map of names to objects.
+     */
+    public void setNames( Map names )
+    {
+        if( names == null )
+        {
+            node.setItem( "Names", (COSObjectable)null );
+            node.setItem( "Limits", (COSObjectable)null);
+        }
+        else
+        {
+            List keys = new ArrayList( names.keySet() );
+            Collections.sort( keys );
+            COSArray array = new COSArray();
+            for( int i=0; i<keys.size(); i++ )
+            {
+                String key = (String)keys.get(i);
+                array.add( new COSString( key ) );
+                COSObjectable obj = (COSObjectable)names.get( key );
+                array.add( obj );
+            }
+            String lower = null;
+            String upper = null;
+            if( keys.size() > 0 )
+            {
+                lower = (String)keys.get( 0 );
+                upper = (String)keys.get( keys.size()-1 );
+            }
+            setUpperLimit( upper );
+            setLowerLimit( lower );
+            node.setItem( "Names", array );
+        }
+    }
+    
+    /**
+     * Get the highest value for a key in the name map.
+     * 
+     * @return The highest value for a key in the map.
+     */
+    public String getUpperLimit()
+    {
+        String retval = null;
+        COSArray arr = (COSArray)node.getDictionaryObject( "Limits" );
+        if( arr != null )
+        {
+            retval = arr.getString( 1 );
+        }
+        return retval;
+    }
+    
+    /**
+     * Set the highest value for the key in the map.
+     * 
+     * @param upper The new highest value for a key in the map.
+     */
+    private void setUpperLimit( String upper )
+    {
+        COSArray arr = (COSArray)node.getDictionaryObject( "Limits" );
+        if( arr == null )
+        {
+            arr = new COSArray();
+            arr.add( null );
+            arr.add( null );
+        }
+        arr.setString( 1, upper );
+    }
+    
+    /**
+     * Get the lowest value for a key in the name map.
+     * 
+     * @return The lowest value for a key in the map.
+     */
+    public String getLowerLimit()
+    {
+        String retval = null;
+        COSArray arr = (COSArray)node.getDictionaryObject( "Limits" );
+        if( arr != null )
+        {
+            retval = arr.getString( 0 );
+        }
+        return retval;
+    }
+    
+    /**
+     * Set the lowest value for the key in the map.
+     * 
+     * @param lower The new lowest value for a key in the map.
+     */
+    private void setLowerLimit( String lower )
+    {
+        COSArray arr = (COSArray)node.getDictionaryObject( "Limits" );
+        if( arr == null )
+        {
+            arr = new COSArray();
+            arr.add( null );
+            arr.add( null );
+        }
+        arr.setString( 0, lower );
+    }
+}
\ No newline at end of file
-- 
cgit v1.2.3