001: /*
002: * Copyright (c) 1998-2008 Caucho Technology -- all rights reserved
003: *
004: * This file is part of Resin(R) Open Source
005: *
006: * Each copy or derived work must preserve the copyright notice and this
007: * notice unmodified.
008: *
009: * Resin Open Source is free software; you can redistribute it and/or modify
010: * it under the terms of the GNU General Public License as published by
011: * the Free Software Foundation; either version 2 of the License, or
012: * (at your option) any later version.
013: *
014: * Resin Open Source is distributed in the hope that it will be useful,
015: * but WITHOUT ANY WARRANTY; without even the implied warranty of
016: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
017: * of NON-INFRINGEMENT. See the GNU General Public License for more
018: * details.
019: *
020: * You should have received a copy of the GNU General Public License
021: * along with Resin Open Source; if not, write to the
022: * Free SoftwareFoundation, Inc.
023: * 59 Temple Place, Suite 330
024: * Boston, MA 02111-1307 USA
025: *
026: * @author Scott Ferguson
027: */
028:
029: package com.caucho.xsl;
030:
031: import com.caucho.vfs.Path;
032: import com.caucho.vfs.PersistentDependency;
033: import com.caucho.vfs.Vfs;
034: import com.caucho.xml.XMLWriter;
035:
036: import org.w3c.dom.Node;
037:
038: import javax.xml.transform.Templates;
039: import javax.xml.transform.URIResolver;
040: import java.util.ArrayList;
041: import java.util.Properties;
042:
043: /**
044: * A compiled XSL stylesheet. Stylesheets use 'transform' to transform
045: * an XML tree to an XML Document.
046: *
047: * <p>The resulting document can be printed, or it can be added to another
048: * XML tree.
049: */
050: abstract public class AbstractStylesheet implements CauchoStylesheet,
051: Templates {
052: // The path to the stylesheet source
053: private Path _path;
054: private ArrayList<PersistentDependency> _depends = new ArrayList<PersistentDependency>();
055: private ArrayList<String> _cacheDepends = new ArrayList<String>();
056: private ArrayList _globalParameters;
057:
058: protected Properties _output = new Properties();
059: protected AbstractStylesheet _stylesheet;
060:
061: protected String _errorPage;
062: protected URIResolver _uriResolver;
063: boolean _escapeEntities = true;
064:
065: /**
066: * Initialize the stylesheet with the search path.
067: *
068: * @param path the path of the stylepath used to search for stylesheets.
069: */
070: public void init(Path path) throws Exception {
071: /*
072: * Can't use best path because the stylesheets are relative to
073: * the search path.
074: if (path instanceof MergePath)
075: path = ((MergePath) path).getBestPath();
076: */
077:
078: _path = path;
079: }
080:
081: public void setURIResolver(URIResolver resolver) {
082: _uriResolver = resolver;
083: }
084:
085: public URIResolver getURIResolver() {
086: return _uriResolver;
087: }
088:
089: /**
090: * Copies the current stylesheet into the new stylesheet. Used to
091: * create the transformer.
092: *
093: * @param stylesheet the new stylesheet which will contain the copied values.
094: */
095: protected void copy(AbstractStylesheet stylesheet) {
096: stylesheet._stylesheet = this ;
097: stylesheet._depends = (ArrayList) _depends.clone();
098: stylesheet._output = (Properties) _output.clone();
099: stylesheet._errorPage = _errorPage;
100: stylesheet._globalParameters = _globalParameters;
101: stylesheet._path = _path;
102: stylesheet._uriResolver = _uriResolver;
103: }
104:
105: /**
106: * Clone the stylesheet. Used to create transformer.
107: */
108: public Object clone() {
109: try {
110: AbstractStylesheet instance;
111: instance = (AbstractStylesheet) getClass().newInstance();
112:
113: copy(instance);
114:
115: if (_path != null)
116: instance.init(_path);
117: else
118: instance.init(Vfs.lookup("anonymous.xsl"));
119:
120: return instance;
121: } catch (Exception e) {
122: return null;
123: }
124: }
125:
126: /**
127: * Returns the output properties for the stylesheet.
128: */
129: public Properties getOutputProperties() {
130: return _output;
131: }
132:
133: public Path getPath() {
134: return _path;
135: }
136:
137: /**
138: * Returns a stylesheet property.
139: */
140: public Object getProperty(String name) {
141: if (name.equals(DEPENDS))
142: return _depends;
143: else if (name.equals(CACHE_DEPENDS))
144: return _cacheDepends;
145: else if (name.equals("caucho.path"))
146: return _path;
147: else if (name.equals(GLOBAL_PARAM))
148: return _globalParameters;
149: else
150: return null;
151: }
152:
153: /**
154: * Sets a stylesheet property.
155: */
156: public void setProperty(String name, Object value) {
157: if (name.equals(GLOBAL_PARAM))
158: _globalParameters = (ArrayList) value;
159: }
160:
161: /**
162: * Creates a new transformer.
163: */
164: public javax.xml.transform.Transformer newTransformer() {
165: return new TransformerImpl((StylesheetImpl) clone());
166: }
167:
168: /**
169: * Returns true if the any of the source stylesheets have been modified
170: * since this stylesheet was compiled.
171: */
172: public boolean isModified() {
173: for (int i = 0; i < _depends.size(); i++) {
174: PersistentDependency depend = _depends.get(i);
175:
176: if (depend.isModified())
177: return true;
178: }
179:
180: return false;
181: }
182:
183: /**
184: * Add a dependency to the stylesheet. Used to keep track of source
185: * stylesheets.
186: *
187: * @param path the path of the source stylesheet.
188: */
189: protected void addDepend(PersistentDependency depend) {
190: if (!_depends.contains(depend))
191: _depends.add(depend);
192: }
193:
194: /**
195: * Returns the dependency list of the stylesheet.
196: */
197: public ArrayList<PersistentDependency> getDepends() {
198: return _depends;
199: }
200:
201: /**
202: * Adds a cache dependency.
203: */
204: protected void addCacheDepend(String path) {
205: _cacheDepends.add(path);
206: }
207:
208: public ArrayList<String> getCacheDepends() {
209: return _cacheDepends;
210: }
211:
212: /**
213: * Transforms the XML node to a new XML document based on this stylesheet.
214: *
215: * <p>Since Documents are DocumentFragments, calling functions can insert
216: * the contents using appendChild.
217: *
218: * @param xml source xml to convert
219: * @param out source xml to convert
220: * @return the converted document
221: */
222: abstract public void transform(Node xml, XMLWriter out,
223: TransformerImpl transformer) throws Exception;
224: }
|