src/java/org/mxchange/pizzaapplication/database/frontend/product/PizzaProductDatabaseFrontend.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.pizzaapplication.database.frontend.product;
  18
  19 import java.io.IOException;
  20 import java.sql.SQLException;
  21 import java.text.MessageFormat;
  22 import java.util.Iterator;
  23 import org.mxchange.jcore.criteria.searchable.SearchCriteria;
  24 import org.mxchange.jcore.criteria.searchable.SearchableCritera;
  25 import org.mxchange.jcore.database.frontend.BaseDatabaseFrontend;
  26 import org.mxchange.jcore.database.result.Result;
  27 import org.mxchange.jcore.database.storage.Storeable;
  28 import org.mxchange.jcore.exceptions.BadTokenException;
  29 import org.mxchange.jcore.exceptions.UnsupportedDatabaseBackendException;
  30 import org.mxchange.pizzaapplication.database.product.PizzaProductDatabaseConstants;
  31 import org.mxchange.pizzaapplication.product.Product;
  32
  33 /**
  34  * Stores and retrieves Contact instances
  35  *
  36  * @author Roland Haeder
  37  */
  38 public class PizzaProductDatabaseFrontend extends BaseDatabaseFrontend implements ProductFrontend {
  39
  40         /**
  41          * Default constrcutor
  42          * @throws org.mxchange.jcore.exceptions.UnsupportedDatabaseBackendException If the configured backend is not supported
  43          * @throws java.sql.SQLException If any SQL error occurs
  44          */
  45         public PizzaProductDatabaseFrontend () throws UnsupportedDatabaseBackendException, SQLException {
  46                 // Trace message
  47                 this.getLogger().trace("CALLED!"); //NOI18N
  48
  49                 // Set "table" name
  50                 this.setTableName("products"); //NOI18N
  51
  52                 // Initalize backend
  53                 this.initBackend();
  54         }
  55
  56         /**
  57          * Shuts down the database layer
  58          */
  59         @Override
  60         public void doShutdown () throws SQLException, IOException {
  61                 // Trace message
  62                 this.getLogger().trace("CALLED!"); //NOI18N
  63
  64                 // Shutdown backend
  65                 this.getBackend().doShutdown();
  66
  67                 // Trace message
  68                 this.getLogger().trace("EXIT!"); //NOI18N
  69         }
  70
  71         /**
  72          * An iterator on all products
  73          *
  74          * @return Iterator on all products
  75          */
  76         @Override
  77         @SuppressWarnings ("unchecked")
  78         public Iterator<Product> getProducts () throws IOException, BadTokenException {
  79                 // Trace message
  80                 this.getLogger().trace("CALLED!"); //NOI18N
  81
  82                 // Instance search criteria
  83                 SearchableCritera critera = new SearchCriteria();
  84
  85                 // Add criteria
  86                 critera.addCriteria(PizzaProductDatabaseConstants.COLUMN_AVAILABLE, true);
  87
  88                 // Run the query
  89                 Result<? extends Storeable> result = this.getBackend().doSelectByCriteria(critera);
  90
  91                 // Debug message
  92                 this.getLogger().debug(MessageFormat.format("result={0}", result)); //NOI18N
  93
  94                 // Get iterator
  95                 Iterator<?> iterator = result.iterator();
  96
  97                 // Trace message
  98                 this.getLogger().trace(MessageFormat.format("iterator={0} - EXIT!", iterator)); //NOI18N
  99
 100                 // Get iterator and return it
 101                 return (Iterator<Product>) iterator;
 102         }
 103
 104         /**
 105          * Parses given line from database backend into a Storeable instance. Please
 106          * note that not all backends need this.
 107          *
 108          * @param line Line from database backend
 109          * @return A Storeable instance
 110          */
 111         @Override
 112         public Storeable parseLineToStoreable (final String line) throws BadTokenException {
 113                 // Trace message
 114                 this.getLogger().trace(MessageFormat.format("line={0} - CALLED!", line)); //NOI18N
 115
 116                 // Call inner method
 117                 Product product = this.parseLineToProduct(line);
 118
 119                 // Debug message
 120                 this.getLogger().trace(MessageFormat.format("product={0} - EXIT!", product)); //NOI18N
 121
 122                 // Return it
 123                 return product;
 124         }
 125
 126         /**
 127          * Parses given line to a Product instance
 128          *
 129          * @param line
 130          * @return A Product instance from given line
 131          */
 132         private Product parseLineToProduct (final String line) {
 133                 throw new UnsupportedOperationException(MessageFormat.format("Not supported yet: line={0}", line)); //NOI18N
 134         }
 135 }