src/org/mxchange/jcore/database/result/Result.java

   1 /*
   2  * Copyright (C) 2015 Roland Haeder
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package org.mxchange.jcore.database.result;
  18
  19 import java.sql.SQLWarning;
  20 import java.util.Iterator;
  21 import java.util.Set;
  22 import org.mxchange.jcore.FrameworkInterface;
  23 import org.mxchange.jcore.database.storage.Storeable;
  24
  25 /**
  26  * An interface for database results
  27  *
  28  * @author Roland Haeder
  29  * @param <T> Anything that is storeable
  30  */
  31 public interface Result<T extends Storeable> extends FrameworkInterface, Iterator<T>, Iterable<T> {
  32
  33         /**
  34          * Given Storeable instance as a query result.
  35          *
  36          * @param storeable An instance of a Storeable class
  37          */
  38         public void add (final Storeable storeable);
  39
  40         /**
  41          * Setter for warnings
  42          *
  43          * @param warnings SQLQarning from ResultSet instance
  44          */
  45         public void setWarnings (final SQLWarning warnings);
  46
  47         /**
  48          * Getter for warnings
  49          *
  50          * @return SQLQarning from ResultSet instance
  51          */
  52         public SQLWarning getWarnings ();
  53
  54         /**
  55          * Returns size of result
  56          *
  57          * @return Size of result
  58          */
  59         public int size ();
  60
  61         /**
  62          * Getter for a whole unmodifiable result set from this result. The id number is used as key
  63          *
  64          * @return A map from this result
  65          */
  66         public Set<? extends Storeable> resultSet ();
  67 }