/*
 *    GeoTools - OpenSource mapping toolkit
 *    http://geotools.org
 *    (C) 2004-2006, GeoTools Project Managment Committee (PMC)
 *    
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation;
 *    version 2.1 of the License.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 */
package org.geotools.feature.type;

import java.util.LinkedList;
import java.util.List;

import org.geotools.feature.AttributeType;
import org.geotools.feature.IllegalAttributeException;
import org.opengis.filter.Filter;

/**
 * Represents an ordered list of AttributeTypes. For SFS this will be a 
 * FeatureType. For GML this is the same as an element whose complexType 
 * contains a Sequence of Attributes.
 * 
 * @author dzwiers
 * @source $URL: http://svn.geotools.org/geotools/tags/2.4.1/modules/library/main/src/main/java/org/geotools/feature/type/ListAttributeType.java $
 */
public class ListAttributeType implements AttributeType {

	private final boolean nill;
	private final int min,max;
	private final String name;
	private final AttributeType[] children;
	private Filter restriction;
	
	
	/**
	 * @param copy
	 */
	public ListAttributeType(ListAttributeType copy) {
		nill = copy.isNillable();
		min = copy.getMinOccurs();
		max = copy.getMaxOccurs();
		name = copy.getName();
		children = copy.getAttributeTypes();
		restriction = copy.getRestriction();
	}

	// The field for 'Class type' should be added when GT has moved to java 1.5
    public ListAttributeType(String name, boolean nillable, int min, int max,
    		AttributeType[] children, Filter restriction) {
    	nill = nillable;
    	this.min = min;
    	this.max = max;
    	this.name = name;
    	this.children = children;
    	this.restriction = restriction;
    }

    public ListAttributeType(String name, boolean nillable,
    		AttributeType[] children) {
    	this(name, nillable, 1, 1, children,Filter.EXCLUDE);
    }
    public Filter getRestriction(){return restriction;}
	/* (non-Javadoc)
	 * @see org.geotools.feature.AttributeType#getName()
	 */
	public final String getName() {
		return getLocalName();
	}
	/**
	 * {@inheritDoc}
	 */
	public String getLocalName() {
		return name;
	}

	/* (non-Javadoc)
	 * @see org.geotools.feature.AttributeType#getType()
	 */
	public final Class getType() {
		return getBinding();
	}
	/**
	 * {@inheritDoc}
	 */
	public Class getBinding() {
//		The field for 'Class type' should be added when GT has moved to java 1.5
		return List.class;
	}

	/* (non-Javadoc)
	 * @see org.geotools.feature.AttributeType#isNillable()
	 */
	public boolean isNillable() {
		return nill;
	}

	/* (non-Javadoc)
	 * @see org.geotools.feature.AttributeType#getMinOccurs()
	 */
	public int getMinOccurs() {
		return min;
	}

	/* (non-Javadoc)
	 * @see org.geotools.feature.AttributeType#getMaxOccurs()
	 */
	public int getMaxOccurs() {
		return max;
	}

	/* (non-Javadoc)
	 * @see org.geotools.feature.AttributeType#isGeometry()
	 */
	public boolean isGeometry() {
		return false;
	}

	/* (non-Javadoc)
	 * @see org.geotools.feature.AttributeType#parse(java.lang.Object)
	 */
	public Object parse(Object value) throws IllegalArgumentException {
		if(value instanceof Object[]){
			Object[] in, out;
			in = (Object[])value;
			out = new Object[in.length];
			if(in.length == children.length){
				for(int i=0;i<children.length;i++){
					out[i] = children[i].parse(in[i]);
				}
				return out;
			}
			throw new IllegalArgumentException("Expected "+children.length+" Objects, got "+in.length+" Objects");
		}
		throw new IllegalArgumentException("Not an Object []");
	}

	/* (non-Javadoc)
	 * @see org.geotools.feature.AttributeType#validate(java.lang.Object)
	 */
	public void validate(Object obj) throws IllegalArgumentException {
		if(obj instanceof List){
			List in;
			in = (List)obj;
			if(in.size() == children.length){
				for(int i=0;i<children.length;i++){
					children[i].validate(in.get(i));
				}
				return;
			}
			throw new IllegalArgumentException("Expected "+children.length+" Objects, got "+in.size()+" Objects");
		}
		throw new IllegalArgumentException("Not an Object []");
		
	}

	/* (non-Javadoc)
	 * @see org.geotools.feature.AttributeType#duplicate(java.lang.Object)
	 */
	public Object duplicate(Object src) throws IllegalAttributeException {
		if(src instanceof List){
			List in,out;
			in = (List)src;
			out = new LinkedList();
			if(in.size() == children.length){
				for(int i=0;i<children.length;i++){
					out.add(i, children[i].duplicate(in.get(i)));
				}
				return out;
			}
			throw new IllegalArgumentException("Expected "+children.length+" Objects, got "+in.size()+" Objects");
		}
		throw new IllegalArgumentException("Not an Object []");
	}

	/* (non-Javadoc)
	 * @see org.geotools.feature.AttributeType#createDefaultValue()
	 */
	public Object createDefaultValue() {
		List out;
		out = new LinkedList();
		for(int i=0;i<children.length;i++){
			out.add(i, children[i].createDefaultValue());
		}
		return out;
	}

    /**
     * This is only used twice in the whole geotools code base, and  one of
     * those is for a test, so we're removing it from the interface. If
     * getAttributeType does not have the AttributeType it will just return
     * null.  Gets the number of occurrences of this attribute.
     *
     * @param xPath XPath pointer to attribute type.
     *
     * @return Number of occurrences.
     */
    public boolean hasAttributeType(String xPath) {
        return getAttributeType(xPath) != null;
    }

    /**
     * Returns the number of attributes at the first 'level' of the schema.
     *
     * @return equivalent value to getAttributeTypes().length
     */
    public int getAttributeCount(){
    	return children.length;
    }
    

    /**
     * Gets the attributeType at this xPath, if the specified attributeType
     * does not exist then null is returned.
     *
     * @param xPath XPath pointer to attribute type.
     *
     * @return True if attribute exists.
     */
    public AttributeType getAttributeType(String xPath) {        
        AttributeType attType = null;
        int idx = find(xPath);
        if (idx >= 0)
            attType = children[idx];
        return attType;
    }

    /**
     * Find the position of a given AttributeType.
     *
     * @param type The type to search for.
     *
     * @return -1 if not found, a zero-based index if found.
     */
    public int find(AttributeType type) {
        if (type == null) return -1;
        int idx = find(type.getName());
        if (idx < 0 || !children[idx].equals(type))
            idx = -1;
        return idx;
    }
    
    /**
     * Find the position of an AttributeType which matches the given String.
     * @param attName the name to look for
     * @return -1 if not found, zero-based index otherwise
     */
    public int find(String attName) {
    	int i=0;
    	while(i<children.length && !attName.equals(children[i].getName()))i++;
        return i == children.length?-1:i;
    }

    /**
     * Gets the attributeType at the specified index.
     *
     * @param position the position of the attribute to check.
     *
     * @return The attribute type at the specified position.
     */
    public AttributeType getAttributeType(int position) {
        return children[position];
    }

    public AttributeType[] getAttributeTypes() {
        return (AttributeType[]) children.clone();
    }
}
