123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193 |
- /* ====================================================================
- 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.poi.ss.excelant;
-
- import java.io.File;
- import java.io.FileInputStream;
- import java.io.FileNotFoundException;
- import java.io.IOException;
- import java.text.SimpleDateFormat;
- import java.util.Date;
- import java.util.Iterator;
- import java.util.LinkedList;
-
- import org.apache.poi.ss.excelant.util.ExcelAntWorkbookUtil;
- import org.apache.poi.ss.excelant.util.ExcelAntWorkbookUtilFactory;
- import org.apache.poi.ss.usermodel.Workbook;
- import org.apache.poi.ss.usermodel.WorkbookFactory;
- import org.apache.tools.ant.BuildException;
- import org.apache.tools.ant.Project;
- import org.apache.tools.ant.Task;
-
- /**
- * Ant task class for testing Excel workbook cells.
- *
- * @author Jon Svede ( jon [at] loquatic [dot] com )
- * @author Brian Bush ( brian [dot] bush [at] nrel [dot] gov )
- *
- */
- public class ExcelAntTask extends Task {
-
- public static final String VERSION = "0.5.0" ;
-
- private String excelFileName ;
-
- private boolean failOnError = false ;
-
- private ExcelAntWorkbookUtil workbookUtil ;
-
- private ExcelAntPrecision precision ;
-
- private LinkedList<ExcelAntTest> tests ;
- private LinkedList<ExcelAntUserDefinedFunction> functions ;
-
- public ExcelAntTask() {
- tests = new LinkedList<ExcelAntTest>() ;
- functions = new LinkedList<ExcelAntUserDefinedFunction>() ;
- }
-
- public void addPrecision( ExcelAntPrecision prec ) {
- precision = prec ;
- }
-
- public void setFailOnError( boolean value ) {
- failOnError = value ;
- }
- public void setFileName( String fileName ) {
- excelFileName = fileName ;
- }
-
- public void addTest( ExcelAntTest testElement ) {
- tests.add( testElement ) ;
- }
-
- public void addUdf( ExcelAntUserDefinedFunction def ) {
- functions.add( def ) ;
- }
-
- public void execute() throws BuildException {
- checkClassPath();
-
- int totalCount = 0 ;
- int successCount = 0 ;
-
- StringBuffer versionBffr = new StringBuffer() ;
- versionBffr.append( "ExcelAnt version " ) ;
- versionBffr.append( VERSION ) ;
- versionBffr.append( " Copyright 2011" ) ;
- SimpleDateFormat sdf = new SimpleDateFormat( "yyyy" ) ;
- double currYear = Double.parseDouble( sdf.format( new Date() ) );
- if( currYear > 2011 ) {
- versionBffr.append( "-" ) ;
- versionBffr.append( currYear ) ;
- }
- log( versionBffr.toString(), Project.MSG_INFO ) ;
-
- log( "Using input file: " + excelFileName, Project.MSG_INFO ) ;
-
- Workbook targetWorkbook = loadWorkbook() ;
- if( targetWorkbook == null ) {
- log( "Unable to load " + excelFileName +
- ". Verify the file exists and can be read.",
- Project.MSG_ERR ) ;
- return ;
- }
- if( tests != null && tests.size() > 0 ) {
-
- Iterator<ExcelAntTest> testsIt = tests.iterator() ;
- while( testsIt.hasNext() ) {
- ExcelAntTest test = testsIt.next();
-
- log( "executing test: " + test.getName(), Project.MSG_DEBUG ) ;
-
- workbookUtil = ExcelAntWorkbookUtilFactory.getInstance( excelFileName ) ;
-
- if( functions != null ) {
- Iterator<ExcelAntUserDefinedFunction> functionsIt = functions.iterator() ;
- while( functionsIt.hasNext() ) {
- ExcelAntUserDefinedFunction eaUdf = functionsIt.next() ;
- try {
- workbookUtil.addFunction(eaUdf.getFunctionAlias(), eaUdf.getClassName() ) ;
- } catch ( Exception e) {
- throw new BuildException( e.getMessage(), e );
- }
- }
- }
- test.setWorkbookUtil( workbookUtil ) ;
-
- if( precision != null && precision.getValue() > 0 ) {
- log( "setting precision for the test " + test.getName(), Project.MSG_VERBOSE ) ;
- test.setPrecision( precision.getValue() ) ;
- }
-
- test.execute() ;
-
- if( test.didTestPass() ) {
- successCount++ ;
- } else {
- if( failOnError == true ) {
- throw new BuildException( "Test " + test.getName() + " failed." ) ;
- }
- }
- totalCount++ ;
-
- workbookUtil = null ;
- }
- log( successCount + "/" + totalCount + " tests passed.", Project.MSG_INFO ) ;
- workbookUtil = null ;
- }
- }
-
-
- private Workbook loadWorkbook() {
- if (excelFileName == null) {
- throw new BuildException("fileName attribute must be set!",
- getLocation());
- }
-
- Workbook workbook;
- File workbookFile = new File( excelFileName ) ;
- try {
- FileInputStream fis = new FileInputStream( workbookFile ) ;
- workbook = WorkbookFactory.create( fis ) ;
- } catch (Exception e) {
- throw new BuildException("Cannot load file " + excelFileName
- + ". Make sure the path and file permissions are correct.", e, getLocation());
- }
- return workbook ;
- }
-
-
- /**
- * ExcelAnt depends on external libraries not included in the Ant distribution.
- * Give user a sensible message if any if the required jars are missing.
- */
- private void checkClassPath(){
- try {
- Class.forName("org.apache.poi.hssf.usermodel.HSSFWorkbook");
- Class.forName("org.apache.poi.ss.usermodel.WorkbookFactory");
- } catch (Throwable e) {
- throw new BuildException(
- "The <classpath> for <excelant> must include poi.jar and poi-ooxml.jar " +
- "if not in Ant's own classpath. Processing .xlsx spreadsheets requires " +
- "additional poi-ooxml-schemas.jar, xmlbeans.jar and dom4j.jar" ,
- e, getLocation());
- }
-
- }
- }
|