/*
============================================================================
The Apache Software License, Version 1.1
============================================================================
Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
Redistribution and use in source and binary forms, with or without modifica-
tion, 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 Cocoon" 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 (INCLU-
DING, 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 created by
Stefano Mazzocchi <stefano@apache.org>. For more information on the Apache
Software Foundation, please see <http://www.apache.org/>.
*/
package org.apache.cocoon.components.xscript;
import org.apache.avalon.framework.component.ComponentException;
import org.apache.avalon.framework.component.ComponentManager;
import org.apache.avalon.framework.component.Composable;
import org.apache.avalon.framework.parameters.Parameters;
import org.apache.avalon.excalibur.xml.Parser;
import org.apache.cocoon.ProcessingException;
import org.apache.cocoon.components.xslt.XSLTProcessor;
import org.apache.cocoon.environment.Source;
import org.apache.cocoon.xml.EmbeddedXMLPipe;
import org.xml.sax.ContentHandler;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import javax.xml.transform.stream.StreamResult;
import java.io.CharArrayWriter;
import java.io.IOException;
import java.util.Date;
/**
* <code>XScriptObject</code> is the root class implemented by all the
* object types in XScript. Every XScriptObject is essentially a
* Source object.
*
* @author <a href="mailto:ovidiu@cup.hp.com">Ovidiu Predescu</a>
* @version CVS $Id: XScriptObject.java,v 1.7.2.3 2002/07/26 04:40:49 vgritsenko Exp $
* @since August 4, 2001
*/
public abstract class XScriptObject implements Source, Composable {
/**
* The creation date of this <code>XScriptObject</code>.
*/
Date lastModifiedDate = new Date();
/**
* The <code>XScriptManager</code> object that's managing this
* <code>XScriptObject</code> value.
*/
XScriptManager xscriptManager;
protected ComponentManager componentManager;
/**
* Creates a new <code>XScriptObject</code> instance.
*
* @param manager a <code>XScriptManager</code> value
*/
public XScriptObject(XScriptManager manager) {
this.xscriptManager = manager;
((XScriptManagerImpl) this.xscriptManager).register(this);
}
public void compose(ComponentManager manager)
throws ComponentException {
this.componentManager = manager;
}
/**
* Apply the XSLT stylesheet defined by the <code>stylesheet</code>
* variable to this instance. Return the result of the
* transformation as an <code>XScriptObject</code>.
*
* @param stylesheet a <code>XScriptObject</code> value
* @param params a <code>Parameters</code> value containing optional
* arguments to be passed to the XSLT processor.
* @return <code>XScriptObject</code> object containing the result
* of the XSLT processing.
* @exception IllegalArgumentException if an error occurs
* @exception ProcessingException if an error occurs
*/
public XScriptObject transform(XScriptObject stylesheet, Parameters params)
throws IllegalArgumentException, ProcessingException {
try {
CharArrayWriter writer = new CharArrayWriter();
StreamResult result = new StreamResult(writer);
XSLTProcessor transformer
= (XSLTProcessor) componentManager.lookup(XSLTProcessor.ROLE);
try {
transformer.transform(this, stylesheet, params, result);
} finally {
componentManager.release(transformer);
}
return new XScriptObjectResult(xscriptManager, writer.toString());
} catch (ComponentException ex) {
throw new ProcessingException(ex);
}
}
public void toEmbeddedSAX(ContentHandler handler) throws SAXException {
EmbeddedXMLPipe newHandler = new EmbeddedXMLPipe(handler);
toSAX(newHandler);
}
/* The Source interface methods. */
public void toSAX(ContentHandler handler) throws SAXException {
Parser parser = null;
try {
parser = (Parser) componentManager.lookup(Parser.ROLE);
InputSource source = getInputSource();
parser.parse(source, handler);
} catch (SAXException e) {
throw e;
} catch (Exception e) {
throw new SAXException(e);
} finally {
if (parser != null) {
componentManager.release(parser);
}
}
}
public long getLastModified() {
return lastModifiedDate.getTime();
}
public abstract long getContentLength();
public InputSource getInputSource()
throws ProcessingException, IOException {
InputSource is = new InputSource(getInputStream());
is.setSystemId(getSystemId());
return is;
}
public void recycle() {
}
}