/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

/*
 * QueryValueFetcher.java
 *
 * Created on March 15, 2002
 * @author  Daniel Tonn
 */

package com.sun.jdo.spi.persistence.support.sqlstore.query.jqlc;

import java.util.ResourceBundle;

import com.sun.jdo.api.persistence.support.JDOFatalInternalException;
import com.sun.jdo.spi.persistence.support.sqlstore.ValueFetcher;
import com.sun.jdo.spi.persistence.utility.I18NHelper;

/**
 * Class wrapping the actual query parameters to make them
 * accessible through the ValueFetcher interface.
 */
public class QueryValueFetcher implements ValueFetcher 
{
    /** I18N support */
    protected final static ResourceBundle messages =
        I18NHelper.loadBundle(QueryValueFetcher.class);

    /** The actual parameter values. */
    private Object[] parameters;
    
    /**
     * Constructor.
     * @param parameters the actual parameter values.
     */
    public QueryValueFetcher(Object[] parameters) 
    {
        this.parameters = parameters;
    }
    
    /**
     * Returns the parameter value for the specified parameter index
     * @param whichOne the parameter index
     * @return the parameter value
     */
    public Object getValue(int whichOne) 
    {
        if (parameters == null || whichOne >= parameters.length) 
        {
            throw new JDOFatalInternalException(I18NHelper.getMessage(messages,
                "jqlc.queryvaluefetcher.getvalue.invalidparam", //NOI18N
                String.valueOf(whichOne),
                String.valueOf((parameters == null) ? 0 : parameters.length)));
        }
        return parameters[whichOne];
    }
}