[Babeldoc-devel] babeldoc/modules/conversion/src/com/babeldoc/conversion/pipeline/stage FlatToXmlPipelineStage.java,1.4,1.5

[<tr...@us...>]

Update of /cvsroot/babeldoc/babeldoc/modules/conversion/src/com/babeldoc/conversion/pipeline/stage
In directory sc8-pr-cvs1:/tmp/cvs-serv29412/src/com/babeldoc/conversion/pipeline/stage

Modified Files:
	FlatToXmlPipelineStage.java 
Log Message:
Reformatted and changed the license header - also added javadoc comments.

Index: FlatToXmlPipelineStage.java
===================================================================
RCS file: /cvsroot/babeldoc/babeldoc/modules/conversion/src/com/babeldoc/conversion/pipeline/stage/FlatToXmlPipelineStage.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** FlatToXmlPipelineStage.java	10 Jun 2003 00:00:22 -0000	1.4
--- FlatToXmlPipelineStage.java	27 Jun 2003 01:44:07 -0000	1.5
***************
*** 1,22 ****
! /*
!  * $Header$
!  * $DateTime: 2002/07/24 18:15:55 $
   *
   *
!  * babeldoc:  universal document processor
   *
!  * This program is free software; you can redistribute it and/or
!  * modify it under the terms of the GNU General Public License
!  * as published by the Free Software Foundation; either version 2
!  * of the License, or (at your option) any later version.
   *
!  * This program is distributed in the hope that it will be useful,
!  * but WITHOUT ANY WARRANTY; without even the implied warranty of
!  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
!  * GNU General Public License for more details.
   *
-  * You should have received a copy of the GNU General Public License
-  * along with this program; if not, write to the Free Software
-  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
   */
  package com.babeldoc.conversion.pipeline.stage;
--- 1,66 ----
! /* ====================================================================
!  * The Apache Software License, Version 1.1
   *
+  * Copyright (c) 2000 The Apache Software Foundation.  All rights
+  * reserved.
   *
!  * Redistribution and use in source and binary forms, with or without
!  * modification, are permitted provided that the following conditions
!  * are met:
   *
!  * 1. Redistributions of source code must retain the above copyright
!  *    notice, this list of conditions and the following disclaimer.
   *
!  * 2. Redistributions in binary form must reproduce the above copyright
!  *    notice, this list of conditions and the following disclaimer in
!  *    the documentation and/or other materials provided with the
!  *    distribution.
!  *
!  * 3. The end-user documentation included with the redistribution,
!  *    if any, must include the following acknowledgment:
!  *       "This product includes software developed by the
!  *        Apache Software Foundation (http://www.apache.org/)."
!  *    Alternately, this acknowledgment may appear in the software itself,
!  *    if and wherever such third-party acknowledgments normally appear.
!  *
!  * 4. The names "Apache" and "Apache Software Foundation" must
!  *    not be used to endorse or promote products derived from this
!  *    software without prior written permission. For written
!  *    permission, please contact ap...@ap....
!  *
!  * 5. Products derived from this software may not be called "Apache",
!  *    nor may "Apache" appear in their name, without prior written
!  *    permission of the Apache Software Foundation.
!  *
!  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
!  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
!  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
!  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
!  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
!  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
!  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
!  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
!  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
!  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
!  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
!  * SUCH DAMAGE.
!  * ====================================================================
!  *
!  * This software consists of voluntary contributions made by many
!  * individuals on behalf of the Apache Software Foundation.  For more
!  * information on the Apache Software Foundation, please see
!  * <http://www.apache.org/>.
!  *
!  * Portions of this software are based upon public domain software
!  * originally written at the National Center for Supercomputing Applications,
!  * University of Illinois, Urbana-Champaign.
!  * ====================================================================
!  *
!  * Babeldoc:  The Universal Document Processor
!  *
!  * $Header$
!  * $DateTime$
!  * $Author$
   *
   */
  package com.babeldoc.conversion.pipeline.stage;
***************
*** 25,28 ****
--- 69,73 ----
  import com.babeldoc.conversion.ConversionUnmarshaller;
  import com.babeldoc.conversion.digester.DigesterConversionUnmarshaller;
+ 
  import com.babeldoc.core.I18n;
  import com.babeldoc.core.option.ConfigOption;
***************
*** 33,36 ****
--- 78,82 ----
  import java.io.PrintWriter;
  import java.io.StringWriter;
+ 
  import java.util.ArrayList;
  import java.util.Collection;
***************
*** 38,54 ****
  
  /**
!  * Pipelinestage to convert the document from a flatfile to an xml document.  The
!  * Rules governing the conversion is supplied as argument.  This is the merely defers
!  * most of the work to the conversion client client.
   *
   * @author bmcdonald
   * @version 1.0
   */
! public class FlatToXmlPipelineStage
!     extends PipelineStage {
!   /**
!    * Constants
!    */
!   public final static String FLAT2XML_FILE = "flatToXmlFile";
  
    /**
--- 84,97 ----
  
  /**
!  * Pipelinestage to convert the document from a flatfile to an xml document.
!  * The Rules governing the conversion is supplied as argument.  This is the
!  * merely defers most of the work to the conversion client client.
   *
   * @author bmcdonald
   * @version 1.0
   */
! public class FlatToXmlPipelineStage extends PipelineStage {
!   /** Constants */
!   public static final String FLAT2XML_FILE = "flatToXmlFile";
  
    /**
***************
*** 57,87 ****
    public FlatToXmlPipelineStage() {
      super(new PipelineStageInfo() {
!       public String getName() {
!         return "FlatToXml";
!       }
  
!       public String getDescription() {
!         return I18n.get("conversion.022");
!       }
  
!       public Collection getTypeSpecificOptions() {
!         ArrayList options = new ArrayList();
  
!         //add specific options
!         options.add(new ConfigOption(FLAT2XML_FILE,
!             IConfigOptionType.FILENAME, null, false,
!             I18n.get("conversion.023")));
  
!         return options;
!       }
!     });
    }
  
    /**
!    * Process the contest of the document as a input to the conversion
!    * client code.  The results of the conversion get placed in a new
!    * pipeline document and returned.
     *
     * @return the name of the next stage in the pipe line or nothing
     */
    public PipelineStageResult[] process() throws PipelineException {
--- 100,132 ----
    public FlatToXmlPipelineStage() {
      super(new PipelineStageInfo() {
!         public String getName() {
!           return "FlatToXml";
!         }
  
!         public String getDescription() {
!           return I18n.get("conversion.022");
!         }
  
!         public Collection getTypeSpecificOptions() {
!           ArrayList options = new ArrayList();
  
!           //add specific options
!           options.add(new ConfigOption(FLAT2XML_FILE,
!               IConfigOptionType.FILENAME, null, false,
!               I18n.get("conversion.023")));
  
!           return options;
!         }
!       });
    }
  
    /**
!    * Process the contest of the document as a input to the conversion client
!    * code.  The results of the conversion get placed in a new pipeline
!    * document and returned.
     *
     * @return the name of the next stage in the pipe line or nothing
+    *
+    * @throws PipelineException DOCUMENT ME!
     */
    public PipelineStageResult[] process() throws PipelineException {
***************
*** 92,97 ****
        StringWriter writer = new StringWriter();
  
!       ConversionUnmarshaller unmarshaller = new
!           DigesterConversionUnmarshaller(config);
        ConversionClient.doConversion(unmarshaller, input, new PrintWriter(writer));
        writer.flush();
--- 137,141 ----
        StringWriter writer = new StringWriter();
  
!       ConversionUnmarshaller unmarshaller = new DigesterConversionUnmarshaller(config);
        ConversionClient.doConversion(unmarshaller, input, new PrintWriter(writer));
        writer.flush();
***************
*** 100,103 ****
--- 144,148 ----
            writer.toString().getBytes());
        newDocument.setBinary(true);
+ 
        return processHelper(newDocument);
      } catch (Exception except) {