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;
048
049import javax.imageio.metadata.IIOInvalidTreeException;
050import javax.imageio.metadata.IIOMetadata;
051import javax.imageio.metadata.IIOMetadataNode;
052
053import org.w3c.dom.NamedNodeMap;
054import org.w3c.dom.Node;
055
056public class TIFFStreamMetadata extends IIOMetadata {
057
058    // package scope
059    static final String nativeMetadataFormatName =
060        "com_sun_media_imageio_plugins_tiff_stream_1.0";
061
062    static final String nativeMetadataFormatClassName =
063        "com.github.jaiimageio.impl.plugins.tiff.TIFFStreamMetadataFormat";
064
065    private static final String bigEndianString =
066        ByteOrder.BIG_ENDIAN.toString();
067    private static final String littleEndianString =
068        ByteOrder.LITTLE_ENDIAN.toString();
069
070    public ByteOrder byteOrder = ByteOrder.BIG_ENDIAN;
071
072    public TIFFStreamMetadata() {
073        super(false,
074              nativeMetadataFormatName,
075              nativeMetadataFormatClassName,
076              null, null);
077    }
078
079    public boolean isReadOnly() {
080        return false;
081    }
082
083    // Shorthand for throwing an IIOInvalidTreeException
084    private static void fatal(Node node, String reason)
085        throws IIOInvalidTreeException {
086        throw new IIOInvalidTreeException(reason, node);
087    }
088
089    public Node getAsTree(String formatName) {
090        IIOMetadataNode root = new IIOMetadataNode(nativeMetadataFormatName);
091
092        IIOMetadataNode byteOrderNode = new IIOMetadataNode("ByteOrder");
093        byteOrderNode.setAttribute("value", byteOrder.toString());
094
095        root.appendChild(byteOrderNode);
096        return root;
097    }
098
099//     public void setFromTree(String formatName, Node root) {
100//     }
101
102    private void mergeNativeTree(Node root) throws IIOInvalidTreeException {
103        Node node = root;
104        if (!node.getNodeName().equals(nativeMetadataFormatName)) {
105            fatal(node, "Root must be " + nativeMetadataFormatName);
106        }
107        
108        node = node.getFirstChild();
109        if (node == null || !node.getNodeName().equals("ByteOrder")) {
110            fatal(node, "Root must have \"ByteOrder\" child");
111        } 
112
113        NamedNodeMap attrs = node.getAttributes();
114        String order = (String)attrs.getNamedItem("value").getNodeValue();
115
116        if (order == null) {
117            fatal(node, "ByteOrder node must have a \"value\" attribute");
118        }
119        if (order.equals(bigEndianString)) {
120            this.byteOrder = ByteOrder.BIG_ENDIAN;
121        } else if (order.equals(littleEndianString)) {
122            this.byteOrder = ByteOrder.LITTLE_ENDIAN;
123        } else {
124            fatal(node, "Incorrect value for ByteOrder \"value\" attribute");
125        }
126    }
127
128    public void mergeTree(String formatName, Node root)
129        throws IIOInvalidTreeException {
130        if (formatName.equals(nativeMetadataFormatName)) {
131            if (root == null) {
132                throw new IllegalArgumentException("root == null!");
133            }
134            mergeNativeTree(root);
135        } else {
136            throw new IllegalArgumentException("Not a recognized format!");
137        }
138    }
139
140    public void reset() {
141        this.byteOrder = ByteOrder.BIG_ENDIAN;
142    }
143}