/*
 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You under the Apache License, Version 2.0
 *  (the "License"); you may not use this file except in compliance with
 *  the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package com.google.code.appengine.imageio.metadata;


import java.util.Locale;

import com.google.code.appengine.imageio.ImageTypeSpecifier;

public interface IIOMetadataFormat {

    int CHILD_POLICY_EMPTY = 0;
    int CHILD_POLICY_ALL = 1;
    int CHILD_POLICY_SOME = 2;
    int CHILD_POLICY_CHOICE = 3;
    int CHILD_POLICY_SEQUENCE = 4;
    int CHILD_POLICY_REPEAT = 5;
    int CHILD_POLICY_MAX = CHILD_POLICY_REPEAT;

    int DATATYPE_STRING = 0;
    int DATATYPE_BOOLEAN = 1;
    int DATATYPE_INTEGER = 2;
    int DATATYPE_FLOAT = 3;
    int DATATYPE_DOUBLE = 4;

    int VALUE_NONE = 0;
    int VALUE_ARBITRARY = 1;
    int VALUE_RANGE = 2;
    int VALUE_RANGE_MIN_INCLUSIVE_MASK = 4;
    int VALUE_RANGE_MAX_INCLUSIVE_MASK = 8;
    int VALUE_ENUMERATION = 16;
    int VALUE_LIST = 32;
    int VALUE_RANGE_MIN_INCLUSIVE = VALUE_RANGE | VALUE_RANGE_MIN_INCLUSIVE_MASK;
    int VALUE_RANGE_MAX_INCLUSIVE = VALUE_RANGE | VALUE_RANGE_MAX_INCLUSIVE_MASK;
    int VALUE_RANGE_MIN_MAX_INCLUSIVE =
            VALUE_RANGE | VALUE_RANGE_MIN_INCLUSIVE_MASK | VALUE_RANGE_MAX_INCLUSIVE_MASK;

    boolean canNodeAppear(String elementName, ImageTypeSpecifier imageType);

    int getAttributeDataType(String elementName, String attrName);
    String getAttributeDefaultValue(String elementName, String attrName);
    String getAttributeDescription(String elementName, String attrName, Locale locale);
    String[] getAttributeEnumerations(String elementName, String attrName);
    int getAttributeListMaxLength(String elementName, String attrName);
    int getAttributeListMinLength(String elementName, String attrName);
    String getAttributeMaxValue(String elementName, String attrName);
    String getAttributeMinValue(String elementName, String attrName);
    String[] getAttributeNames(String elementName);
    int getAttributeValueType(String elementName, String attrName);
    boolean isAttributeRequired(String elementName, String attrName);

    String[] getChildNames(String elementName);
    int getChildPolicy(String elementName);

    String getElementDescription(String elementName, Locale locale);
    int getElementMaxChildren(String elementName);
    int getElementMinChildren(String elementName);

    int getObjectArrayMaxLength(String elementName);
    int getObjectArrayMinLength(String elementName);
    Class<?> getObjectClass(String elementName);
    Object getObjectDefaultValue(String elementName);
    Object[] getObjectEnumerations(String elementName);
    Comparable<?> getObjectMaxValue(String elementName);
    Comparable<?> getObjectMinValue(String elementName);
    int getObjectValueType(String elementName);

    String getRootName();
}