001/*
002 * $RCSfile: TIFFStreamMetadata.java,v $
003 *
004 * 
005 * Copyright (c) 2005 Sun Microsystems, Inc. All  Rights Reserved.
006 * 
007 * Redistribution and use in source and binary forms, with or without
008 * modification, are permitted provided that the following conditions
009 * are met: 
010 * 
011 * - Redistribution of source code must retain the above copyright 
012 *   notice, this  list of conditions and the following disclaimer.
013 * 
014 * - Redistribution in binary form must reproduce the above copyright
015 *   notice, this list of conditions and the following disclaimer in 
016 *   the documentation and/or other materials provided with the
017 *   distribution.
018 * 
019 * Neither the name of Sun Microsystems, Inc. or the names of 
020 * contributors may be used to endorse or promote products derived 
021 * from this software without specific prior written permission.
022 * 
023 * This software is provided "AS IS," without a warranty of any 
024 * kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND 
025 * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, 
026 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY
027 * EXCLUDED. SUN MIDROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL 
028 * NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF 
029 * USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
030 * DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR 
031 * ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL,
032 * CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND
033 * REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR
034 * INABILITY TO USE THIS SOFTWARE, EVEN IF SUN HAS BEEN ADVISED OF THE
035 * POSSIBILITY OF SUCH DAMAGES. 
036 * 
037 * You acknowledge that this software is not designed or intended for 
038 * use in the design, construction, operation or maintenance of any 
039 * nuclear facility. 
040 *
041 * $Revision: 1.1 $
042 * $Date: 2005/02/11 05:01:50 $
043 * $State: Exp $
044 */
045package com.github.jaiimageio.impl.plugins.tiff;
046
047import java.nio.ByteOrder;
048import javax.imageio.metadata.IIOMetadata;
049import javax.imageio.metadata.IIOMetadataNode;
050import javax.imageio.metadata.IIOInvalidTreeException;
051import org.w3c.dom.NamedNodeMap;
052import org.w3c.dom.Node;
053
054public class TIFFStreamMetadata extends IIOMetadata {
055
056    // package scope
057    static final String nativeMetadataFormatName =
058        "com_sun_media_imageio_plugins_tiff_stream_1.0";
059
060    static final String nativeMetadataFormatClassName =
061        "com.github.jaiimageio.impl.plugins.tiff.TIFFStreamMetadataFormat";
062
063    private static final String bigEndianString =
064        ByteOrder.BIG_ENDIAN.toString();
065    private static final String littleEndianString =
066        ByteOrder.LITTLE_ENDIAN.toString();
067
068    public ByteOrder byteOrder = ByteOrder.BIG_ENDIAN;
069
070    public TIFFStreamMetadata() {
071        super(false,
072              nativeMetadataFormatName,
073              nativeMetadataFormatClassName,
074              null, null);
075    }
076
077    public boolean isReadOnly() {
078        return false;
079    }
080
081    // Shorthand for throwing an IIOInvalidTreeException
082    private static void fatal(Node node, String reason)
083        throws IIOInvalidTreeException {
084        throw new IIOInvalidTreeException(reason, node);
085    }
086
087    public Node getAsTree(String formatName) {
088        IIOMetadataNode root = new IIOMetadataNode(nativeMetadataFormatName);
089
090        IIOMetadataNode byteOrderNode = new IIOMetadataNode("ByteOrder");
091        byteOrderNode.setAttribute("value", byteOrder.toString());
092
093        root.appendChild(byteOrderNode);
094        return root;
095    }
096
097//     public void setFromTree(String formatName, Node root) {
098//     }
099
100    private void mergeNativeTree(Node root) throws IIOInvalidTreeException {
101        Node node = root;
102        if (!node.getNodeName().equals(nativeMetadataFormatName)) {
103            fatal(node, "Root must be " + nativeMetadataFormatName);
104        }
105        
106        node = node.getFirstChild();
107        if (node == null || !node.getNodeName().equals("ByteOrder")) {
108            fatal(node, "Root must have \"ByteOrder\" child");
109        } 
110
111        NamedNodeMap attrs = node.getAttributes();
112        String order = (String)attrs.getNamedItem("value").getNodeValue();
113
114        if (order == null) {
115            fatal(node, "ByteOrder node must have a \"value\" attribute");
116        }
117        if (order.equals(bigEndianString)) {
118            this.byteOrder = ByteOrder.BIG_ENDIAN;
119        } else if (order.equals(littleEndianString)) {
120            this.byteOrder = ByteOrder.LITTLE_ENDIAN;
121        } else {
122            fatal(node, "Incorrect value for ByteOrder \"value\" attribute");
123        }
124    }
125
126    public void mergeTree(String formatName, Node root)
127        throws IIOInvalidTreeException {
128        if (formatName.equals(nativeMetadataFormatName)) {
129            if (root == null) {
130                throw new IllegalArgumentException("root == null!");
131            }
132            mergeNativeTree(root);
133        } else {
134            throw new IllegalArgumentException("Not a recognized format!");
135        }
136    }
137
138    public void reset() {
139        this.byteOrder = ByteOrder.BIG_ENDIAN;
140    }
141}