001/*
002 * $RCSfile: UUIDBox.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:37 $
043 * $State: Exp $
044 */
045package com.github.jaiimageio.jpeg2000.impl;
046
047import javax.imageio.metadata.IIOInvalidTreeException;
048import javax.imageio.metadata.IIOMetadataNode;
049
050import org.w3c.dom.Node;
051import org.w3c.dom.NodeList;
052
053/** This class is defined to represent a UUID Box of JPEG JP2
054 *  file format.  This type of box has a length, a type of "uuid".  Its
055 *  content is a 16-byte UUID followed with a various-length data.
056 */
057public class UUIDBox extends Box {
058    /** Cache the element names for this box's xml definition */
059    private static String[] elementNames = {"UUID", "Data"};
060
061    /** This method will be called by the getNativeNodeForSimpleBox of the
062     *  class Box to get the element names.
063     */
064    public static String[] getElementNames() {
065        return elementNames;
066    }
067
068    /** The data elements in this UUID box. */
069    private byte[] uuid;
070    private byte[] udata;
071
072    /** Constructs a <code>UUIDBox</code> from its content data array. */
073    public UUIDBox(byte[] data) {
074        super(8 + data.length, 0x75756964, data);
075    }
076
077    /** Constructs a <code>UUIDBox</code> based on the provided
078     *  <code>org.w3c.dom.Node</code>.
079     */
080    public UUIDBox(Node node) throws IIOInvalidTreeException {
081        super(node);
082        NodeList children = node.getChildNodes();
083
084        for (int i = 0; i < children.getLength(); i++) {
085            Node child = children.item(i);
086            String name = child.getNodeName();
087
088            if ("UUID".equals(name)) {
089                uuid = Box.getByteArrayElementValue(child);
090            }
091
092            if ("Data".equals(name)) {
093                udata = Box.getByteArrayElementValue(child);
094            }
095        }
096    }
097
098    /** Parses the data elements from the provided data array. */
099    protected void parse(byte[] data) {
100        uuid = new byte[16];
101        System.arraycopy(data, 0, uuid, 0, 16);
102        udata = new byte[data.length - 16];
103        System.arraycopy(data, 16, udata, 0, udata.length);
104    }
105
106    /** Returns the UUID of this box. */
107    public byte[] getUUID() {
108        return uuid;
109    }
110
111    /** Returns the UUID data of this box. */
112    public byte[] getData() {
113        return udata;
114    }
115
116    /** Creates an <code>IIOMetadataNode</code> from this UUID
117     *  box.  The format of this node is defined in the XML dtd and xsd
118     *  for the JP2 image file.
119     */
120    public IIOMetadataNode getNativeNode() {
121        return getNativeNodeForSimpleBox();
122    }
123
124    protected void compose() {
125        if (data != null)
126            return;
127        data = new byte[16 + udata.length];
128        System.arraycopy(uuid, 0, data, 0, 16);
129        System.arraycopy(udata, 0, data, 16, udata.length);
130    }
131}