001/**
002 * Copyright 2005-2014 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.kns.lookup;
017
018import java.io.IOException;
019import java.io.OutputStream;
020import java.io.Writer;
021import java.util.ArrayList;
022import java.util.List;
023
024import org.apache.commons.lang.StringUtils;
025import org.directwebremoting.util.WriterOutputStream;
026import org.displaytag.model.Row;
027import org.displaytag.model.TableModel;
028import org.kuali.rice.kns.util.KNSGlobalVariables;
029import org.kuali.rice.kns.web.struts.form.KualiForm;
030import org.kuali.rice.kns.web.struts.form.LookupForm;
031import org.kuali.rice.kns.web.ui.ResultRow;
032import org.kuali.rice.krad.bo.BusinessObject;
033import org.kuali.rice.krad.bo.Exporter;
034import org.kuali.rice.krad.datadictionary.BusinessObjectEntry;
035import org.kuali.rice.krad.service.KRADServiceLocatorWeb;
036import org.kuali.rice.krad.exception.ExportNotSupportedException;
037import org.kuali.rice.krad.util.GlobalVariables;
038
039/**
040 * A helper class to be used with the custom ExportView implementations for
041 * Display Tag.  Most of the logic for interfacing with the KNS export
042 * system is encapsulated in this helper class so it can be shared between
043 * the various Display Tag export implementations. 
044 * 
045 * @author Kuali Rice Team (rice.collab@kuali.org)
046 *
047 * @deprecated KNS Struts deprecated, use KRAD and the Spring MVC framework.
048 */
049@Deprecated
050public class ExportViewHelper {
051
052        private BusinessObjectEntry businessObjectEntry;
053        private List<BusinessObject> businessObjects;
054        
055        public ExportViewHelper(TableModel tableModel) {
056                this.businessObjectEntry = loadBusinessObjectEntry();
057                this.businessObjects = loadBusinessObjects(tableModel);
058        }
059        
060        protected BusinessObjectEntry loadBusinessObjectEntry() {
061                KualiForm kualiForm = KNSGlobalVariables.getKualiForm();
062                if (kualiForm instanceof LookupForm) {
063                        LookupForm lookupForm = (LookupForm) kualiForm;
064                        if (!StringUtils.isBlank(lookupForm.getBusinessObjectClassName())) {
065                                return KRADServiceLocatorWeb.getDataDictionaryService().getDataDictionary().getBusinessObjectEntry(lookupForm.getBusinessObjectClassName());
066                        }
067                }
068                return null;
069        }
070        
071        protected List<BusinessObject> loadBusinessObjects(TableModel tableModel) {
072                List<BusinessObject> businessObjects = new ArrayList<BusinessObject>();
073                List<Row> rowList = tableModel.getRowListFull();
074                for (Row row : rowList) {
075                        ResultRow resultRow = (ResultRow)row.getObject();
076                        if (resultRow.getBusinessObject() != null) {
077                                businessObjects.add(resultRow.getBusinessObject());
078                        }
079                }
080                return businessObjects;
081        }
082        
083        public BusinessObjectEntry getBusinessObjectEntry() {
084                return businessObjectEntry;
085        }
086        
087        public List<BusinessObject> getBusinessObjects() {
088                return businessObjects;
089        }
090        
091        public boolean attemptCustomExport(OutputStream outputStream, String exportFormat) throws IOException {
092                if (getBusinessObjectEntry() != null && getBusinessObjectEntry().getExporterClass() != null) {
093                        final Exporter exporter;
094                        try {
095                                exporter = getBusinessObjectEntry().getExporterClass().newInstance();
096                        } catch (Exception e) {
097                                throw new ExportNotSupportedException("Failed to load export class: " + businessObjectEntry.getExporterClass(),e);
098                        }
099                        List<String> supportedFormats = exporter.getSupportedFormats(businessObjectEntry.getBusinessObjectClass());
100                        if (supportedFormats.contains(exportFormat)) {
101                                exporter.export(businessObjectEntry.getBusinessObjectClass(), getBusinessObjects(), exportFormat, outputStream);
102                                return true;
103                        }
104                }
105                return false;
106        }
107        
108        public boolean attemptCustomExport(Writer writer, String exportFormat) throws IOException {
109                return attemptCustomExport(new WriterOutputStream(writer), exportFormat);
110        }
111        
112}