org.primefaces.component.export.Exporter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of primefaces Show documentation
Show all versions of primefaces Show documentation
PrimeFaces is one of the most popular UI libraries in Java EE Ecosystem and widely used by software companies, world renowned brands, banks, financial institutions, insurance companies, universities and more.
/**
* Copyright 2009-2018 PrimeTek.
*
* Licensed 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.primefaces.component.export;
import java.io.IOException;
import java.lang.reflect.Array;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import javax.el.MethodExpression;
import javax.faces.FacesException;
import javax.faces.component.EditableValueHolder;
import javax.faces.component.UIColumn;
import javax.faces.component.UIComponent;
import javax.faces.component.UIData;
import javax.faces.component.UIPanel;
import javax.faces.component.UISelectMany;
import javax.faces.component.ValueHolder;
import javax.faces.component.html.HtmlCommandLink;
import javax.faces.component.html.HtmlGraphicImage;
import javax.faces.context.FacesContext;
import javax.faces.convert.Converter;
import org.primefaces.component.celleditor.CellEditor;
import org.primefaces.component.datatable.DataTable;
import org.primefaces.component.overlaypanel.OverlayPanel;
import org.primefaces.util.ComponentUtils;
public abstract class Exporter {
protected enum ColumnType {
HEADER("header"),
FOOTER("footer");
private final String facet;
ColumnType(String facet) {
this.facet = facet;
}
public String facet() {
return facet;
}
@Override
public String toString() {
return facet;
}
};
public abstract void export(FacesContext facesContext, DataTable table,
String outputFileName, boolean pageOnly, boolean selectionOnly,
String encodingType, MethodExpression preProcessor,
MethodExpression postProcessor, ExporterOptions options) throws IOException;
public abstract void export(FacesContext facesContext, List clientIds,
String outputFileName, boolean pageOnly, boolean selectionOnly,
String encodingType, MethodExpression preProcessor,
MethodExpression postProcessor, ExporterOptions options) throws IOException;
public abstract void export(FacesContext facesContext,
String outputFileName, List tables, boolean pageOnly, boolean selectionOnly,
String encodingType, MethodExpression preProcessor,
MethodExpression postProcessor, ExporterOptions options) throws IOException;
protected List getColumnsToExport(UIData table) {
List columns = new ArrayList();
for (UIComponent child : table.getChildren()) {
if (child instanceof UIColumn) {
UIColumn column = (UIColumn) child;
columns.add(column);
}
}
return columns;
}
protected boolean hasColumnFooter(List columns) {
for (UIColumn column : columns) {
if (column.getFooter() != null) {
return true;
}
}
return false;
}
protected String exportColumnByFunction(FacesContext context, org.primefaces.component.api.UIColumn column) {
MethodExpression exportFunction = column.getExportFunction();
if (exportFunction != null) {
return (String) exportFunction.invoke(context.getELContext(), new Object[]{column});
}
return "";
}
protected String exportValue(FacesContext context, UIComponent component) {
if (component instanceof HtmlCommandLink) { //support for PrimeFaces and standard HtmlCommandLink
HtmlCommandLink link = (HtmlCommandLink) component;
Object value = link.getValue();
if (value != null) {
return String.valueOf(value);
}
else {
//export first value holder
for (UIComponent child : link.getChildren()) {
if (child instanceof ValueHolder) {
return exportValue(context, child);
}
}
return "";
}
}
else if (component instanceof ValueHolder) {
if (component instanceof EditableValueHolder) {
Object submittedValue = ((EditableValueHolder) component).getSubmittedValue();
if (submittedValue != null) {
return submittedValue.toString();
}
}
ValueHolder valueHolder = (ValueHolder) component;
Object value = valueHolder.getValue();
if (value == null) {
return "";
}
Converter converter = valueHolder.getConverter();
if (converter == null) {
Class valueType = value.getClass();
converter = context.getApplication().createConverter(valueType);
}
if (converter != null) {
if (component instanceof UISelectMany) {
StringBuilder builder = new StringBuilder();
List collection = null;
if (value instanceof List) {
collection = (List) value;
}
else if (value.getClass().isArray()) {
collection = Arrays.asList(value);
}
else {
throw new FacesException("Value of " + component.getClientId(context) + " must be a List or an Array.");
}
int collectionSize = collection.size();
for (int i = 0; i < collectionSize; i++) {
Object object = collection.get(i);
builder.append(converter.getAsString(context, component, object));
if (i < (collectionSize - 1)) {
builder.append(",");
}
}
String valuesAsString = builder.toString();
builder.setLength(0);
return valuesAsString;
}
else {
return converter.getAsString(context, component, value);
}
}
else {
return value.toString();
}
}
else if (component instanceof CellEditor) {
return exportValue(context, ((CellEditor) component).getFacet("output"));
}
else if (component instanceof HtmlGraphicImage) {
return (String) component.getAttributes().get("alt");
}
else if (component instanceof OverlayPanel) {
return "";
}
else {
//This would get the plain texts on UIInstructions when using Facelets
String value = component.toString();
if (value != null) {
return value.trim();
}
else {
return "";
}
}
}
protected void exportPageOnly(FacesContext context, DataTable table, Object document) {
int first = table.getFirst();
int rows = table.getRows();
if (rows == 0) {
rows = table.getRowCount();
}
int rowsToExport = first + rows;
for (int rowIndex = first; rowIndex < rowsToExport; rowIndex++) {
exportRow(table, document, rowIndex);
}
}
protected void exportAll(FacesContext context, DataTable table, Object document) {
int first = table.getFirst();
int rowCount = table.getRowCount();
int rows = table.getRows();
boolean lazy = table.isLazy();
if (lazy) {
if (rowCount > 0) {
table.setFirst(0);
table.setRows(rowCount);
table.clearLazyCache();
table.loadLazyData();
}
for (int rowIndex = 0; rowIndex < rowCount; rowIndex++) {
exportRow(table, document, rowIndex);
}
//restore
table.setFirst(first);
table.setRows(rows);
table.setRowIndex(-1);
table.clearLazyCache();
table.loadLazyData();
}
else {
for (int rowIndex = 0; rowIndex < rowCount; rowIndex++) {
exportRow(table, document, rowIndex);
}
//restore
table.setFirst(first);
}
}
protected void exportRow(DataTable table, Object document, int rowIndex) {
table.setRowIndex(rowIndex);
if (!table.isRowAvailable()) {
return;
}
preRowExport(table, document);
exportCells(table, document);
postRowExport(table, document);
}
protected void exportRow(DataTable table, Object document) {
preRowExport(table, document);
exportCells(table, document);
postRowExport(table, document);
}
protected void exportSelectionOnly(FacesContext context, DataTable table, Object document) {
Object selection = table.getSelection();
String var = table.getVar();
if (selection != null) {
Map requestMap = context.getExternalContext().getRequestMap();
if (selection.getClass().isArray()) {
int size = Array.getLength(selection);
for (int i = 0; i < size; i++) {
requestMap.put(var, Array.get(selection, i));
exportRow(table, document);
}
}
else if (List.class.isAssignableFrom(selection.getClass())) {
List list = (List) selection;
for (int i = 0; i < list.size(); i++) {
requestMap.put(var, list.get(i));
exportRow(table, document);
}
}
else {
requestMap.put(var, selection);
exportCells(table, document);
}
}
}
public String getSheetName(FacesContext context, DataTable table) {
UIComponent header = table.getFacet("header");
if (header != null) {
if (header instanceof UIPanel) {
for (UIComponent child : header.getChildren()) {
if (child.isRendered()) {
String value = ComponentUtils.getValueToRender(context, child);
if (value != null) {
return value;
}
}
}
}
else {
return ComponentUtils.getValueToRender(context, header);
}
}
return null;
}
protected void preRowExport(DataTable table, Object document) {
}
protected void postRowExport(DataTable table, Object document) {
}
protected abstract void exportCells(DataTable table, Object document);
}