javax.faces.model.ResultDataModel Maven / Gradle / Ivy
Show all versions of jboss-jsf-api_2.0_spec
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2011 Oracle and/or its affiliates. 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_1_1.html
* or packager/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 packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [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.
*/
package javax.faces.model;
import java.util.SortedMap;
import javax.faces.FacesException;
import javax.servlet.jsp.jstl.sql.Result;
/**
* ResultDataModel is a convenience implementation of
* {@link DataModel} that wraps a JSTL Result object, typically
* representing the results of executing an SQL query via JSTL tags.
*/
public class ResultDataModel extends DataModel> {
// ------------------------------------------------------------ Constructors
/**
* Construct a new {@link ResultDataModel} with no specified
* wrapped data.
*/
public ResultDataModel() {
this(null);
}
/**
* Construct a new {@link ResultDataModel} wrapping the specified
* Result.
*
* @param result Result to be wrapped (if any)
*/
public ResultDataModel(Result result) {
super();
setWrappedData(result);
}
// ------------------------------------------------------ Instance Variables
// The current row index (zero relative)
private int index = -1;
// The Result we are wrapping
private Result result = null;
// The individual rows of this Result, each represented as a Map
// with column names as keys and associated data values as values
private SortedMap rows[] = null;
// -------------------------------------------------------------- Properties
/**
* Return true if there is wrappedData
* available, and the current value of rowIndex is greater
* than or equal to zero, and less than the length of the array returned
* by calling getRows() on the underlying Result.
* Otherwise, return false.
*
* @throws FacesException if an error occurs getting the row availability
*/
public boolean isRowAvailable() {
if (result == null) {
return (false);
} else if ((index >= 0) && (index < rows.length)) {
return (true);
} else {
return (false);
}
}
/**
* If there is wrappedData available, return the
* length of the array returned by calling getRows()
* on the underlying Result. If no wrappedData
* is available, return -1.
*
* @throws FacesException if an error occurs getting the row count
*/
public int getRowCount() {
if (result == null) {
return (-1);
}
return (rows.length);
}
/**
* If row data is available, return the SortedMap array
* element at the index specified by rowIndex of the
* array returned by calling getRows() on the underlying
* Result. If no wrapped data is available,
* return null.
*
* Note that, if a non-null Map is returned
* by this method, it will contain the values of the columns for the
* current row, keyed by column name. Column name comparisons must be
* performed in a case-insensitive manner.
*
* @throws FacesException if an error occurs getting the row data
* @throws IllegalArgumentException if now row data is available
* at the currently specified row index
*/
public SortedMap getRowData() {
if (result == null) {
return (null);
} else if (!isRowAvailable()) {
throw new NoRowAvailableException();
} else {
//noinspection unchecked
return ((SortedMap)rows[index]);
}
}
/**
* @throws FacesException {@inheritDoc}
*/
public int getRowIndex() {
return (index);
}
/**
* @throws FacesException {@inheritDoc}
* @throws IllegalArgumentException {@inheritDoc}
*/
public void setRowIndex(int rowIndex) {
if (rowIndex < -1) {
throw new IllegalArgumentException();
}
int old = index;
index = rowIndex;
if (result == null) {
return;
}
DataModelListener [] listeners = getDataModelListeners();
if ((old != index) && (listeners != null)) {
SortedMap rowData = null;
if (isRowAvailable()) {
rowData = getRowData();
}
DataModelEvent event =
new DataModelEvent(this, index, rowData);
int n = listeners.length;
for (int i = 0; i < n; i++) {
if (null != listeners[i]) {
listeners[i].rowSelected(event);
}
}
}
}
public Object getWrappedData() {
return (this.result);
}
/**
* @throws ClassCastException if data is
* non-null and is not a Result
*/
public void setWrappedData(Object data) {
if (data == null) {
result = null;
rows = null;
setRowIndex(-1);
} else {
result = (Result) data;
rows = result.getRows();
index = -1;
setRowIndex(0);
}
}
}