/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2007-2008, Open Source Geospatial Foundation (OSGeo)
 *
 *    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.caching.grid.featurecache;

import org.geotools.caching.spatialindex.Data;
import org.geotools.caching.spatialindex.Node;
import org.geotools.caching.spatialindex.Region;
import org.geotools.caching.spatialindex.Visitor;

/**
 * This visitor makes nodes as valid.
 * 
 *
 *
 *
 * @source $URL$
 */
public class ValidatingVisitor implements Visitor {
    private Region region;

    /**
     * Creates a new visitor.
     * 
     * @param r  region to mark nodes valid within  
     */
    public ValidatingVisitor(Region r) {
        this.region = r;
    }

    public void visitData(Data<?> d) {
        // do nothing
    }

    /**
     * If node within the region then flags the node
     * as valid. 
     */
    public void visitNode(Node n) {
        
        if (this.region.contains(n.getShape())) {
            n.getIdentifier().setValid(true);
        }
    }

    /**
     * @returns false - does nothing with data
     */
    public boolean isDataVisitor() {
        return false;
    }
}