001/*
002        $Id: SqlResultIterator.java 3207 2009-04-09 06:48:11Z gregory $
003
004        Copyright (C) 2006 Gregory Vincic, Olle Mansson
005        Copyright (C) 2007 Gregory Vincic
006
007        This file is part of Proteios.
008        Available at http://www.proteios.org/
009
010        Proteios is free software; you can redistribute it and/or modify it
011        under the terms of the GNU General Public License as published by
012        the Free Software Foundation; either version 2 of the License, or
013        (at your option) any later version.
014
015        Proteios is distributed in the hope that it will be useful, but
016        WITHOUT ANY WARRANTY; without even the implied warranty of
017        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
018        General Public License for more details.
019
020        You should have received a copy of the GNU General Public License
021        along with this program; if not, write to the Free Software
022        Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
023        02111-1307, USA.
024*/
025package org.proteios.core.query;
026
027import java.sql.SQLException;
028
029/**
030        Return the result of a {@link SqlQuery} as an iterator.
031
032        @author Nicklas
033        @version 2.0
034        @base.modified $Date: 2009-04-09 08:48:11 +0200 (Thu, 09 Apr 2009) $
035*/
036public interface SqlResultIterator
037        extends ResultIterator<SqlResult>
038{
039        /**
040                Get the index number of a selected column. Use this method to
041                find the index of a column and then use the <code>SqlResult.getXxx(index)</code> 
042                methods to get the value of that column. 
043                
044                @param name The name of a selected column
045                @return The index number
046                @throws SQLException If there is an error
047        */
048        public int getIndex(String name)
049                throws SQLException;
050
051}