core/src/org/apache/pivot/sql/ResultList.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to you under the Apache License,
 * Version 2.0 (the "License"); you may not use this file except in
 * compliance with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.pivot.sql;

import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.Comparator;
import java.util.Date;
import java.util.Iterator;
import java.util.NoSuchElementException;

import org.apache.pivot.annotations.UnsupportedOperation;
import org.apache.pivot.collections.ArrayAdapter;
import org.apache.pivot.collections.ArrayList;
import org.apache.pivot.collections.HashMap;
import org.apache.pivot.collections.List;
import org.apache.pivot.collections.ListListener;
import org.apache.pivot.collections.Map;
import org.apache.pivot.collections.Sequence;
import org.apache.pivot.util.ListenerList;
import org.apache.pivot.util.Utils;

/**
 * Implementation of the {@link List} interface that is backed by a instance of
 * {@link java.sql.ResultSet}. <p> Note that this list is not suitable for
 * random access and can only be navigated via an iterator.
 */
public class ResultList implements List<Map<String, Object>> {
    /**
     * Class that maps a result set column to a map key/value pair.
     */
    public static final class Field {
        /**
         * The source column name.
         */
        public final String columnName;

        /**
         * The name of the map key. If <tt>null</tt>, the column name will be
         * used.
         */
        public final String key;

        /**
         * The type of the map value. If <tt>null</tt>, the default SQL type
         * will be used.
         */
        public final Class<?> type;

        public Field(String columnName) {
            this(columnName, null, null);
        }

        public Field(String columnName, String key) {
            this(columnName, key, null);
        }

        public Field(String columnName, String key, Class<?> type) {
            Utils.checkNull(columnName, "columnName");

            if (!(type == null
               || type == Boolean.class || type == Boolean.TYPE
               || type == Byte.class || type == Byte.TYPE
               || type == Short.class || type == Short.TYPE
               || type == Integer.class || type == Integer.TYPE
               || type == Long.class || type == Long.TYPE
               || type == Float.class || type == Float.TYPE
               || type == Double.class || type == Double.TYPE
               || type == String.class
               || type == Date.class)) {
                throw new IllegalArgumentException(type.getName() + " is not a supported type.");
            }

            this.columnName = columnName;
            this.key = key;
            this.type = type;
        }
    }

    private class ResultListItemIterator implements Iterator<Map<String, Object>> {
        private boolean hasNext = true;
        private boolean moveNext = true;

        @Override
        public boolean hasNext() {
            if (hasNext && moveNext) {
                try {
                    hasNext = resultSet.next();
                    moveNext = false;
                } catch (SQLException exception) {
                    throw new RuntimeException(exception);
                }
            }

            return hasNext;
        }

        @Override
        public Map<String, Object> next() {
            if (!hasNext) {
                throw new NoSuchElementException();
            }

            HashMap<String, Object> item = new HashMap<>();

            try {
                for (Field field : fields) {
                    Object value;

                    if (field.type == Boolean.class || field.type == Boolean.TYPE) {
                        value = resultSet.getBoolean(field.columnName);
                    } else if (field.type == Byte.class || field.type == Byte.TYPE) {
                        value = resultSet.getByte(field.columnName);
                    } else if (field.type == Short.class || field.type == Short.TYPE) {
                        value = resultSet.getShort(field.columnName);
                    } else if (field.type == Integer.class || field.type == Integer.TYPE) {
                        value = resultSet.getInt(field.columnName);
                    } else if (field.type == Long.class || field.type == Long.TYPE) {
                        value = resultSet.getLong(field.columnName);
                    } else if (field.type == Float.class || field.type == Float.TYPE) {
                        value = resultSet.getFloat(field.columnName);
                    } else if (field.type == Double.class || field.type == Double.TYPE) {
                        value = resultSet.getDouble(field.columnName);
                    } else if (field.type == String.class) {
                        value = resultSet.getString(field.columnName);
                    } else if (field.type == Date.class) {
                        value = resultSet.getDate(field.columnName);
                    } else {
                        value = resultSet.getObject(field.columnName);
                    }

                    if (resultSet.wasNull()) {
                        value = null;
                    }

                    if (value != null || includeNullValues) {
                        item.put((field.key == null) ? field.columnName : field.key, value);
                    }
                }
            } catch (SQLException exception) {
                throw new RuntimeException(exception);
            }

            moveNext = true;

            return item;
        }

        @Override
        @UnsupportedOperation
        public void remove() {
            throw new UnsupportedOperationException();
        }
    }

    private ResultSet resultSet;
    private ArrayList<Field> fields = new ArrayList<>();
    private boolean includeNullValues = false;

    private ListListenerList<Map<String, Object>> listListeners = new ListListenerList<>();

    private static final String ERROR_MSG =
        "Result List is not suited for random access or modification, but must be used via an iterator.";

    public ResultList(ResultSet resultSet) {
        Utils.checkNull(resultSet, "resultSet");

        this.resultSet = resultSet;
    }

    public ResultSet getResultSet() {
        return resultSet;
    }

    public Sequence<Field> getFields() {
        return fields;
    }

    public void setFields(Sequence<Field> fields) {
        Utils.checkNull(fields, "fields");

        this.fields = new ArrayList<>(fields);
    }

    public void setFields(Field... fields) {
        Utils.checkNull(fields, "fields");

        setFields(new ArrayAdapter<>(fields));
    }

    public boolean getIncludeNullValues() {
        return includeNullValues;
    }

    public void setIncludeNullValues(boolean includeNullValues) {
        this.includeNullValues = includeNullValues;
    }

    @Override
    @UnsupportedOperation
    public int add(Map<String, Object> item) {
        throw new UnsupportedOperationException(ERROR_MSG);
    }

    @Override
    @UnsupportedOperation
    public void insert(Map<String, Object> item, int index) {
        throw new UnsupportedOperationException(ERROR_MSG);
    }

    @Override
    @UnsupportedOperation
    public Map<String, Object> update(int index, Map<String, Object> item) {
        throw new UnsupportedOperationException(ERROR_MSG);
    }

    @Override
    @UnsupportedOperation
    public int remove(Map<String, Object> item) {
        throw new UnsupportedOperationException(ERROR_MSG);
    }

    @Override
    @UnsupportedOperation
    public Sequence<Map<String, Object>> remove(int index, int count) {
        throw new UnsupportedOperationException(ERROR_MSG);
    }

    @Override
    @UnsupportedOperation
    public void clear() {
        throw new UnsupportedOperationException(ERROR_MSG);
    }

    @Override
    @UnsupportedOperation
    public Map<String, Object> get(int index) {
        throw new UnsupportedOperationException(ERROR_MSG);
    }

    @Override
    @UnsupportedOperation
    public int indexOf(Map<String, Object> item) {
        throw new UnsupportedOperationException(ERROR_MSG);
    }

    @Override
    @UnsupportedOperation
    public boolean isEmpty() {
        throw new UnsupportedOperationException(ERROR_MSG);
    }

    @Override
    public int getLength() {
        return -1;
    }

    @Override
    public Comparator<Map<String, Object>> getComparator() {
        return null;
    }

    @Override
    @UnsupportedOperation
    public void setComparator(Comparator<Map<String, Object>> comparator) {
        throw new UnsupportedOperationException(ERROR_MSG);
    }

    @Override
    public Iterator<Map<String, Object>> iterator() {
        return new ResultListItemIterator();
    }

    @Override
    public ListenerList<ListListener<Map<String, Object>>> getListListeners() {
        return listListeners;
    }
}