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