001/*
002 * $RCSfile: DataEntryURLBox.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:32 $
043 * $State: Exp $
044 */
045package com.sun.media.imageioimpl.plugins.jpeg2000;
046
047import javax.imageio.metadata.IIOInvalidTreeException;
048import javax.imageio.metadata.IIOMetadataNode;
049import org.w3c.dom.Node;
050import org.w3c.dom.NodeList;
051
052/** This class is defined to represent a Data Entry URL Box of JPEG JP2
053 *  file format.  A Data Entry URL Box has a length, and a fixed type
054 *  of "url ".  Its content are a one-byte version, a three-byte flags and
055 *  a URL pertains to the UUID List box within its UUID Info superbox.
056 */
057public class DataEntryURLBox extends Box {
058    /** Cache the element names for this box's xml definition */
059    private static String[] elementNames = {"Version", "Flags", "URL"};
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 element values. */
069    private byte version;
070    private byte[] flags;
071    private String url;
072
073    /** Constructs a <code>DataEntryURLBox</code> from its content data. */
074    public DataEntryURLBox(byte[] data) {
075        super(8 + data.length, 0x75726C20, data);
076    }
077
078    /** Constructs a <code>DataEntryURLBox</code> from its data elements. */
079    public DataEntryURLBox(byte version, byte[] flags, String url) {
080        super(12 + url.length(), 0x75726C20, null);
081        this.version = version;
082        this.flags = flags;
083        this.url = url;
084    }
085
086    /** Constructs a <code>DataEntryURLBox</code> from a Node. */
087    public DataEntryURLBox(Node node) throws IIOInvalidTreeException {
088        super(node);
089        NodeList children = node.getChildNodes();
090
091        for (int i = 0; i < children.getLength(); i++) {
092            Node child = children.item(i);
093            String name = child.getNodeName();
094
095            if ("Version".equals(name)) {
096                version = Box.getByteElementValue(child);
097            }
098
099            if ("Flags".equals(name)) {
100                flags = Box.getByteArrayElementValue(child);
101            }
102
103            if ("URL".equals(name)) {
104                url = Box.getStringElementValue(child);
105            }
106        }
107    }
108
109    /** Parses the content of this box from its content byte array. */
110    protected void parse(byte[] data) {
111        version = data[0];
112        flags = new byte[3];
113        flags[0] = data[1];
114        flags[1] = data[2];
115        flags[2] = data[3];
116
117        url = new String(data, 4, data.length - 4);
118    }
119
120    /** Creates an <code>IIOMetadataNode</code> from this data entry URL
121     *  box.  The format of this node is defined in the XML dtd and xsd
122     *  for the JP2 image file.
123     */
124    public IIOMetadataNode getNativeNode() {
125        return getNativeNodeForSimpleBox();
126    }
127
128    /** Returns the <code>Version</code> data element. */
129    public byte getVersion() {
130        return version;
131    }
132
133    /** Returns the <code>Flags</code> data element. */
134    public byte[] getFlags() {
135        return flags;
136    }
137
138    /** Returns the <code>URL</code> data element. */
139    public String getURL() {
140        return url;
141    }
142
143    protected void compose() {
144        if (data != null)
145            return;
146        data = new byte[4 + url.length()];
147
148        data[0] = version;
149        data[1] = flags[0];
150        data[2] = flags[1];
151        data[3] = flags[2];
152        System.arraycopy(url.getBytes(), 0, data, 4, url.length());
153    }
154}