001/*
002 * $RCSfile: GIFStreamMetadataFormat.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: 2006/03/24 22:30:10 $
043 * $State: Exp $
044 */
045
046package com.github.jaiimageio.impl.plugins.gif;
047
048import java.util.Arrays;
049import javax.imageio.ImageTypeSpecifier;
050import javax.imageio.metadata.IIOMetadataFormat;
051import javax.imageio.metadata.IIOMetadataFormatImpl;
052
053public class GIFStreamMetadataFormat extends IIOMetadataFormatImpl {
054
055    private static IIOMetadataFormat instance = null;
056
057    private GIFStreamMetadataFormat() {
058        super(GIFStreamMetadata.nativeMetadataFormatName,
059              CHILD_POLICY_SOME);
060
061        // root -> Version
062        addElement("Version", GIFStreamMetadata.nativeMetadataFormatName,
063                   CHILD_POLICY_EMPTY);
064        addAttribute("Version", "value", 
065                     DATATYPE_STRING, true, null,
066                     Arrays.asList(GIFStreamMetadata.versionStrings));
067
068        // root -> LogicalScreenDescriptor
069        addElement("LogicalScreenDescriptor",
070                   GIFStreamMetadata.nativeMetadataFormatName,
071                   CHILD_POLICY_EMPTY);
072        addAttribute("LogicalScreenDescriptor", "logicalScreenWidth",
073                     DATATYPE_INTEGER, true, null,
074                     "1", "65535", true, true);
075        addAttribute("LogicalScreenDescriptor", "logicalScreenHeight",
076                     DATATYPE_INTEGER, true, null,
077                     "1", "65535", true, true);
078        addAttribute("LogicalScreenDescriptor", "colorResolution",
079                     DATATYPE_INTEGER, true, null,
080                     "1", "8", true, true);
081        addAttribute("LogicalScreenDescriptor", "pixelAspectRatio",
082                     DATATYPE_INTEGER, true, null,
083                     "0", "255", true, true);
084
085        // root -> GlobalColorTable
086        addElement("GlobalColorTable",
087                   GIFStreamMetadata.nativeMetadataFormatName,
088                   2, 256);
089        addAttribute("GlobalColorTable", "sizeOfGlobalColorTable", 
090                     DATATYPE_INTEGER, true, null,
091                     Arrays.asList(GIFStreamMetadata.colorTableSizes));
092        addAttribute("GlobalColorTable", "backgroundColorIndex",
093                     DATATYPE_INTEGER, true, null,
094                     "0", "255", true, true);
095        addBooleanAttribute("GlobalColorTable", "sortFlag",
096                            false, false);
097
098        // root -> GlobalColorTable -> ColorTableEntry
099        addElement("ColorTableEntry", "GlobalColorTable",
100                   CHILD_POLICY_EMPTY);
101        addAttribute("ColorTableEntry", "index",
102                     DATATYPE_INTEGER, true, null,
103                     "0", "255", true, true);
104        addAttribute("ColorTableEntry", "red",
105                     DATATYPE_INTEGER, true, null,
106                     "0", "255", true, true);
107        addAttribute("ColorTableEntry", "green",
108                     DATATYPE_INTEGER, true, null,
109                     "0", "255", true, true);
110        addAttribute("ColorTableEntry", "blue",
111                     DATATYPE_INTEGER, true, null,
112                     "0", "255", true, true);
113    }
114
115    public boolean canNodeAppear(String elementName,
116                                 ImageTypeSpecifier imageType) {
117        return true;
118    }
119
120    public static synchronized IIOMetadataFormat getInstance() {
121        if (instance == null) {
122            instance = new GIFStreamMetadataFormat();
123        }
124        return instance;
125    }
126}