You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xalan.apache.org by cu...@apache.org on 2001/04/27 22:11:23 UTC

cvs commit: xml-xalan/test/java/src/org/apache/qetest/xslwrapper XsltcMainWrapper.java TransformWrapperFactory.properties

curcuru     01/04/27 13:11:23

  Modified:    test/java/src/org/apache/qetest/xslwrapper
                        TransformWrapperFactory.properties
  Added:       test/java/src/org/apache/qetest/xslwrapper
                        XsltcMainWrapper.java
  Log:
  Simple command-line-like wrapper for XSLTC; needs more work
  
  Revision  Changes    Path
  1.2       +4 -0      xml-xalan/test/java/src/org/apache/qetest/xslwrapper/TransformWrapperFactory.properties
  
  Index: TransformWrapperFactory.properties
  ===================================================================
  RCS file: /home/cvs/xml-xalan/test/java/src/org/apache/qetest/xslwrapper/TransformWrapperFactory.properties,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- TransformWrapperFactory.properties	2001/03/16 16:59:44	1.1
  +++ TransformWrapperFactory.properties	2001/04/27 20:11:20	1.2
  @@ -14,3 +14,7 @@
   trax.stream=org.apache.qetest.xslwrapper.TraxStreamWrapper
   trax.dom=org.apache.qetest.xslwrapper.TraxDOMWrapper
   trax.sax=org.apache.qetest.xslwrapper.TraxSAXWrapper
  +
  +# XSLTC is now available as a separate 'mode'
  +#   XsltcMainWrapper effectively just calls old XSLTC command line
  +xsltc=org.apache.qetest.xslwrapper.XsltcMainWrapper
  
  
  
  1.1                  xml-xalan/test/java/src/org/apache/qetest/xslwrapper/XsltcMainWrapper.java
  
  Index: XsltcMainWrapper.java
  ===================================================================
  /*
   * The Apache Software License, Version 1.1
   *
   *
   * Copyright (c) 2001 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 "Xalan" 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 apache@apache.org.
   *
   * 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 and was
   * originally based on software copyright (c) 1999, Lotus
   * Development Corporation., http://www.lotus.com.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  package org.apache.qetest.xslwrapper;
  import org.apache.qetest.QetestUtils;
  
  import org.apache.xalan.xsltc.compiler.XSLTC;
  import org.apache.xalan.xsltc.runtime.DefaultRun;
  
  import java.io.ByteArrayOutputStream;
  import java.io.File;
  import java.io.FileOutputStream;
  import java.io.PrintStream;
  import java.util.Hashtable;
  import java.util.Properties;
  
  /**
   * Implementation of TransformWrapper that uses the command line 
   * wrappers of XSLTC - interim use only.
   *
   * <b>Important!</b> This wrapper is for temporary use only: we 
   * should really focus on getting XSLTC to use JAXP 1.1 as it's 
   * interface, and then (as needed) write another custom wrapper 
   * that calls XSLTC API's directly.
   * 
   * @author Shane Curcuru
   * @version $Id: XsltcMainWrapper.java,v 1.1 2001/04/27 20:11:21 curcuru Exp $
   */
  public class XsltcMainWrapper extends TransformWrapperHelper
  {
  
      protected static final String XSLTC_COMPILER_CLASS = "org.apache.xalan.xsltc.compiler.XSLTC";
      protected static final String XSLTC_RUNTIME_CLASS = "org.apache.xalan.xsltc.runtime.DefaultRun";
  
      /**
       * Cached copy of newProcessor() Hashtable.
       */
      protected Hashtable newProcessorOpts = null;
  
  
      /**
       * Get a general description of this wrapper itself.
       *
       * @return Uses XSLTC command line to perform transforms
       */
      public String getDescription()
      {
          return "Uses XSLTC command line to perform transforms";
      }
  
  
      /**
       * Get a specific description of the wrappered processor.  
       *
       * @return specific description of the underlying processor or 
       * transformer implementation: this should include both the 
       * general product name, as well as specific version info.  If 
       * possible, should be implemented without actively creating 
       * an underlying processor.
       */
      public Properties getProcessorInfo()
      {
          Properties p = TraxWrapperUtils.getTraxInfo();
          p.put("traxwrapper.method", "streams");
          p.put("traxwrapper.desc", getDescription());
          return p;
      }
  
  
      /**
       * Actually create/initialize an underlying processor or factory.
       * 
       * Effectively a no-op; returns null.  Just forces a reset().
       *
       * @param options Hashtable of options, unused.
       *
       * @return (Object)getProcessor() as a side-effect, this will 
       * be null if there was any problem creating the processor OR 
       * if the underlying implementation doesn't use this
       *
       * @throws Exception covers any underlying exceptions thrown 
       * by the actual implementation
       */
      public Object newProcessor(Hashtable options) throws Exception
      {
          newProcessorOpts = options;
          //@todo do we need to do any other cleanup?
          reset(false);
          return null;
      }
  
  
      /**
       * Transform supplied xmlName file with the stylesheet in the 
       * xslName file into a resultName file.
       *
       * Names are assumed to be local path\filename references, and 
       * will be converted to URLs as needed for any underlying 
       * processor implementation.
       *
       * @param xmlName local path\filename of XML file to transform
       * @param xslName local path\filename of XSL stylesheet to use
       * @param resultName local path\filename to put result in
       *
       * @return array of longs denoting timing of only these parts of 
       * our operation: IDX_OVERALL, IDX_XSLBUILD, IDX_TRANSFORM
       *
       * @throws Exception any underlying exceptions from the 
       * wrappered processor are simply allowed to propagate; throws 
       * a RuntimeException if any other problems prevent us from 
       * actually completing the operation
       */
      public long[] transform(String xmlName, String xslName, String resultName)
          throws Exception
      {
          long startTime = 0;
          long xslBuild = 0;
          long transform = 0;
  
          // java com.sun.xslt.compiler.XSLTC play1.xsl
          // java com.sun.xslt.runtime.DefaultRun play.xml play1 >stdout
  
          // Timed: compile stylesheet class from XSL file
          String[] args1 = new String[3];
          args1[0] = "-s"; // Don't allow System.exit
          args1[1] = "-u"; // Using URIs
          args1[2] = xslName;
          startTime = System.currentTimeMillis();
          /// Transformer transformer = factory.newTransformer(new StreamSource(xslName));
          XSLTC.main(args1);
          xslBuild = System.currentTimeMillis() - startTime;
  
          // Verify output file was created
          // WARNING: assumption of / here, which means we assume URI not local path - needs revisiting
          int nameStart = xslName.lastIndexOf('/') + 1;
          String baseName = xslName.substring(nameStart);
          int extStart = baseName.lastIndexOf('.');
          if (extStart > 0)
              baseName = baseName.substring(0, extStart);
  
          // Untimed: Apply any parameters needed
          // applyParameters(transformer);
  
          // Timed: read/build xml, transform, and write results
          String[] args2 = new String[4];
          args2[0] = "-s"; // Don't allow System.exit
          args2[1] = "-u"; // Using URIs
          args2[2] = xmlName;
          args2[3] = baseName;    // Just basename of the .class file, without the .class
                                  // Note that . must be on CLASSPATH to work!
          ByteArrayOutputStream baos = new ByteArrayOutputStream();
          PrintStream newSystemOut = new PrintStream(baos);
          PrintStream saveSystemOut = System.out;
          startTime = System.currentTimeMillis();
          // transformer.transform(new StreamSource(xmlName), new StreamResult(resultName));
          try
          {
              // Capture System.out into our byte array
              System.setOut(new PrintStream(baos));
              DefaultRun.main(args2);
          }
          finally
          {
              // Be sure to restore System stuff!
              System.setOut(saveSystemOut);
          }
          // Writing data should really go in separate timing loop
          FileOutputStream fos = new FileOutputStream(resultName);
          fos.write(baos.toByteArray());
          fos.close();
          transform = System.currentTimeMillis() - startTime;
  
          File compiledXslClass = new File(baseName + ".class");
          //@todo WARNING! We REALLY need to clean up the name*.class files when we're done!!! -sc
          if (compiledXslClass.exists())
              compiledXslClass.delete();
  
          long[] times = getTimeArray();
          times[IDX_OVERALL] = xslBuild + transform;
          times[IDX_XSLBUILD] = xslBuild;
          times[IDX_TRANSFORM] = transform;
          return times;
      }
  
  
      /**
       * Pre-build/pre-compile a stylesheet.
       *
       * Although the actual mechanics are implementation-dependent, 
       * most processors have some method of pre-setting up the data 
       * needed by the stylesheet itself for later use in transforms.
       * In TrAX/javax.xml.transform, this equates to creating a 
       * Templates object.
       * 
       * Sets isStylesheetReady() to true if it succeeds.  Users can 
       * then call transformWithStylesheet(xmlName, resultName) to 
       * actually perform a transformation with this pre-built 
       * stylesheet.
       *
       * @param xslName local path\filename of XSL stylesheet to use
       *
       * @return array of longs denoting timing of only these parts of 
       * our operation: IDX_OVERALL, IDX_XSLBUILD
       *
       * @throws Exception any underlying exceptions from the 
       * wrappered processor are simply allowed to propagate; throws 
       * a RuntimeException if any other problems prevent us from 
       * actually completing the operation
       *
       * @see #transformWithStylesheet(String xmlName, String resultName)
       */
      public long[] buildStylesheet(String xslName) throws Exception
      {
          throw new RuntimeException("buildStylesheet not implemented yet!");
      }
  
  
      /**
       * Transform supplied xmlName file with a pre-built/pre-compiled 
       * stylesheet into a resultName file.  
       *
       * User must have called buildStylesheet(xslName) beforehand,
       * obviously.
       * Names are assumed to be local path\filename references, and 
       * will be converted to URLs as needed.
       *
       * @param xmlName local path\filename of XML file to transform
       * @param resultName local path\filename to put result in
       *
       * @return array of longs denoting timing of only these parts of 
       * our operation: IDX_OVERALL, IDX_XSLBUILD, IDX_TRANSFORM
       *
       * @throws Exception any underlying exceptions from the 
       * wrappered processor are simply allowed to propagate; throws 
       * a RuntimeException if any other problems prevent us from 
       * actually completing the operation; throws an 
       * IllegalStateException if isStylesheetReady() == false.
       *
       * @see #buildStylesheet(String xslName)
       */
      public long[] transformWithStylesheet(String xmlName, String resultName)
          throws Exception
      {
          if (!isStylesheetReady())
              throw new IllegalStateException("transformWithStylesheet() when isStylesheetReady() == false");
  
          throw new RuntimeException("transformWithStylesheet not implemented yet!");
      }
  
  
      /**
       * Transform supplied xmlName file with a stylesheet found in an 
       * xml-stylesheet PI into a resultName file.
       *
       * Names are assumed to be local path\filename references, and 
       * will be converted to URLs as needed.  Implementations will 
       * use whatever facilities exist in their wrappered processor 
       * to fetch and build the stylesheet to use for the transform.
       *
       * @param xmlName local path\filename of XML file to transform
       * @param resultName local path\filename to put result in
       *
       * @return array of longs denoting timing of only these parts of 
       * our operation: IDX_OVERALL, IDX_XSLREAD (time to find XSL
       * reference from the xml-stylesheet PI), IDX_XSLBUILD, (time 
       * to then build the Transformer therefrom), IDX_TRANSFORM
       *
       * @throws Exception any underlying exceptions from the 
       * wrappered processor are simply allowed to propagate; throws 
       * a RuntimeException if any other problems prevent us from 
       * actually completing the operation
       */
      public long[] transformEmbedded(String xmlName, String resultName)
          throws Exception
      {
          throw new RuntimeException("transformEmbedded not implemented yet!");
      }
  
  
      /**
       * Reset our parameters and wrapper state, and optionally 
       * force creation of a new underlying processor implementation.
       *
       * This always clears our built stylesheet and any parameters 
       * that have been set.  If newProcessor is true, also forces a 
       * re-creation of our underlying processor as if by calling 
       * newProcessor().
       *
       * @param newProcessor if we should reset our underlying 
       * processor implementation as well
       */
      public void reset(boolean newProcessor)
      {
          super.reset(newProcessor); // clears indent and parameters
          m_stylesheetReady = false;
          // builtTemplates = null;
          if (newProcessor)
          {
              try
              {
                  newProcessor(newProcessorOpts);
              }
              catch (Exception e)
              {
                  //@todo Hmm: what should we do here?
              }
          }
      }
  
  
      /**
       * Apply a single parameter to a Transformer.
       *
       * WARNING: Not implemented! 27-Apr-01
       *
       * @param passThru to be passed to each applyParameter() method 
       * call - for TrAX, you might pass a Transformer object.
       * @param namespace for the parameter, may be null
       * @param name for the parameter, should not be null
       * @param value for the parameter, may be null
       */
      protected void applyParameter(Object passThru, String namespace, 
                                    String name, Object value)
      {
          /* WARNING: Not implemented! 27-Apr-01 */
      }
  }
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: xalan-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: xalan-cvs-help@xml.apache.org