dleslie 01/01/19 10:48:54
Modified: java/compat_src compatOverview.html
java/compat_src/org/apache/xalan/xpath/xml package.html
java/compat_src/org/apache/xalan/xslt StylesheetRoot.java
XSLTEngineImpl.java XSLTInputSource.java
XSLTProcessor.java XSLTProcessorFactory.java
XSLTResultTarget.java package.html
Log:
Javadoc cleanup -- down from 75 javadoc warnings to 3
(haven't yet figured out exactly what the remaining 3 warmings mean).
Removed many refs to API that is no longer there., so if we
expand this API, should add refs back.
Revision Changes Path
1.2 +1 -5 xml-xalan/java/compat_src/compatOverview.html
Index: compatOverview.html
===================================================================
RCS file: /home/cvs/xml-xalan/java/compat_src/compatOverview.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- compatOverview.html 2001/01/11 22:30:03 1.1
+++ compatOverview.html 2001/01/19 18:48:50 1.2
@@ -1,14 +1,10 @@
<HTML><HEAD></HEAD><BODY>
- <P>This compataiblity API supports limited use of the Xalan-Java 1.x API
in the Xalan-Java 2 environment. For the Xalan-Java 2 API, see <A
href="../apidocs/index.html" target="_top">Xalan-Java 2 API</A>.</P>
+ <P>This compatatiblity API supports limited use of the Xalan-Java 1 API
in the Xalan-Java 2 environment. For the Xalan-Java 2 API, see <A
href="../apidocs/index.html" target="_top">Xalan-Java 2 API</A>.</P>
<P><B>Basic procedure for performing transformations:</B></P>
<OL>
<LI>Use one of the [EMAIL PROTECTED]
org.apache.xalan.xslt.XSLTProcessorFactory} static getProcessor methods to
instantiate an [EMAIL PROTECTED]
org.apache.xalan.xslt.XSLTProcessor}.<BR><BR>
- By default, the XSLTProcessor uses the [EMAIL PROTECTED]
org.apache.xalan.xpath.dtm.DTMLiaison} and the
- high-performance DTM (Document Table Model) DOM parser to process the
input. If your input or output
- is a DOM node (rather than a URL, file, or stream), Xalan-Java uses
[EMAIL PROTECTED] org.apache.xalan.xpath.xdom.XercesLiaison
- XercesLiaison} and the Xerces DOM parser.<BR><BR>
The XSLT and XPath engines are independent from any given DOM or XML
implementation. All parser-dependent
calls are funneled through the [EMAIL PROTECTED]
org.apache.xalan.xpath.xml.XMLParserLiaison}.<BR><BR></LI>
<LI>Set up [EMAIL PROTECTED] org.apache.xalan.xslt.XSLTInputSource}
objects for the XML input and XSL stylesheet.
1.2 +1 -6
xml-xalan/java/compat_src/org/apache/xalan/xpath/xml/package.html
Index: package.html
===================================================================
RCS file:
/home/cvs/xml-xalan/java/compat_src/org/apache/xalan/xpath/xml/package.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- package.html 2001/01/11 22:30:12 1.1
+++ package.html 2001/01/19 18:48:51 1.2
@@ -3,13 +3,8 @@
<P>An implementation of the [EMAIL PROTECTED]
org.apache.xalan.xpath.xml.XMLParserLiaison} interface provides a liaison
between the XSLT processor and an XML parser. Unless you specify an XML
parser and your own implementation of
- the XMLParserLiaison interface, Xalan-Java uses one of the following
extensions of the
+ the XMLParserLiaison interface, Xalan-Java uses the
[EMAIL PROTECTED]
org.apache.xalan.xpath.xml.XMLParserLiaisonDefault}:</P>
- <UL>
- <LI>[EMAIL PROTECTED] org.apache.xalan.xpath.dtm.DTMLiaison
org.apache.xalan.xpath.dtm.DTMLiaison} for the DTM XML Parser</LI>
- <LI>[EMAIL PROTECTED] org.apache.xalan.xpath.xdom.XercesLiaison
org.apache.xalan.xpath.xdom.XercesLiaison} for the Xerces XML
- Parser</LI>
- </UL>
<P>This package also includes four implementations of the <A
href="http://www.megginson.com/SAX/sax.html"; target="_top">SAX</A> <A
href="http://www.megginson.com/SAX/javadoc/org.xml.sax.DocumentHandler.html#_top";
target="_top">org.xml.sax.DocumentHandler</A> interface:</P>
<UL>
<LI>[EMAIL PROTECTED] org.apache.xalan.xpath.xml.FormatterToDOM}</LI>
1.5 +2 -2
xml-xalan/java/compat_src/org/apache/xalan/xslt/StylesheetRoot.java
Index: StylesheetRoot.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/compat_src/org/apache/xalan/xslt/StylesheetRoot.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- StylesheetRoot.java 2001/01/17 15:24:20 1.4
+++ StylesheetRoot.java 2001/01/19 18:48:51 1.5
@@ -269,8 +269,8 @@
{
ParserAdapter handler = new ParserAdapter(new
org.apache.xerces.parsers.SAXParser());
// Patch from Costin Manolache
- if( "org.apache.xalan.xpath.dtm.DTMLiaison".equals(
processor.getXMLProcessorLiaison().getClass().getName()))
- processor.error(XSLTErrorResources.ER_CANT_USE_DTM_FOR_OUTPUT);
//"Can't use a DTMLiaison for an output DOM node... pass a
org.apache.xalan.xpath.xdom.XercesLiaison instead!");
+// if( "org.apache.xalan.xpath.dtm.DTMLiaison".equals(
processor.getXMLProcessorLiaison().getClass().getName()))
+//
processor.error(XSLTErrorResources.ER_CANT_USE_DTM_FOR_OUTPUT); //Can't use a
DTMLiaison for an output DOM node... pass a
org.apache.xalan.xpath.xdom.XercesLiaison instead!");
switch(outputTarget.getNode().getNodeType())
{
1.6 +5 -5
xml-xalan/java/compat_src/org/apache/xalan/xslt/XSLTEngineImpl.java
Index: XSLTEngineImpl.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/compat_src/org/apache/xalan/xslt/XSLTEngineImpl.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- XSLTEngineImpl.java 2001/01/18 17:46:53 1.5
+++ XSLTEngineImpl.java 2001/01/19 18:48:52 1.6
@@ -721,7 +721,7 @@
if(iSource instanceof DOMSource)
{
//if(getXMLProcessorLiaison() instanceof
org.apache.xalan.xpath.dtm.DTMLiaison)
- // error(XSLTErrorResources.ER_CANT_USE_DTM_FOR_INPUT); //"Can't use
a DTMLiaison for a input DOM node... pass a
org.apache.xalan.xpath.xdom.XercesLiaison instead!");
+ // error(XSLTErrorResources.ER_CANT_USE_DTM_FOR_INPUT);
sourceTree = ((DOMSource)iSource).getNode();
}
@@ -2164,8 +2164,8 @@
/**
* Get the preferred stylesheet for the XSLTInputSource XML document,
* as identified by the xml-stylesheet PI, and matching the media and
- * charset criteria. See [EMAIL PROTECTED]
http://www.w3.org/TR/xml-stylesheet/
- * Associating Style Sheets with XML documents}
+ * charset criteria. See <a href="http://www.w3.org/TR/xml-stylesheet/";>
+ * Associating Style Sheets with XML documents</a>.
* Does not yet handle the LINK REL="stylesheet" syntax.
*
* @param media The media attribute to be matched. May be null, in which
@@ -2198,8 +2198,8 @@
/**
* Get a list of stylesheet specifications for the XSLTInputSource XML
document,
* as identified by the xml-stylesheet PI, and matching the media and
- * charset criteria. See [EMAIL PROTECTED]
http://www.w3.org/TR/xml-stylesheet/
- * Associating Style Sheets with XML documents}.
+ * charset criteria. See <a href="http://www.w3.org/TR/xml-stylesheet/";>
+ * Associating Style Sheets with XML documents</a>.
* Does not yet handle the LINK REL="stylesheet" syntax.
*
* @param media The media attribute to be matched. May be null, in which
1.2 +2 -35
xml-xalan/java/compat_src/org/apache/xalan/xslt/XSLTInputSource.java
Index: XSLTInputSource.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/compat_src/org/apache/xalan/xslt/XSLTInputSource.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XSLTInputSource.java 2001/01/11 19:29:08 1.1
+++ XSLTInputSource.java 2001/01/19 18:48:52 1.2
@@ -84,14 +84,10 @@
/**
* Zero-argument default constructor -- Before you can use the new
XSLTInputSource object in a transformation,
- * you must define the document source with setSystemId(), setNode(),
setByteStream(), or setCharacterStream().
+ * you must define the document source with setSystemId().
*
* @see #setSystemId(String)
- * @see #setNode(Node)
- * @see #setByteStream
- * @see #setCharacterStream
* @see #setEncoding(String)
- * @see #setPublicId(String)
*/
public XSLTInputSource ()
{
@@ -107,11 +103,7 @@
*
* @param systemId The system identifier (URI).
* @see #setSystemId(String)
- * @see #setNode(Node)
- * @see #setByteStream
* @see #setEncoding(String)
- * @see #setCharacterStream
- * @see #setPublicId(String)
*/
public XSLTInputSource (String systemId)
{
@@ -122,16 +114,11 @@
/**
- * Create a new input source with a byte stream -- the equivalent of
creating an input source
- * with the zero-argument constructor and setting the new object's
ByteStream property.
+ * Create a new input source with a byte stream.
*
* @param byteStream The raw byte stream containing the document.
- * @see #setByteStream
* @see #setSystemId(String)
- * @see #setNode(Node)
* @see #setEncoding(String)
- * @see #setCharacterStream
- * @see #setPublicId(String)
*/
public XSLTInputSource (InputStream byteStream)
{
@@ -145,12 +132,8 @@
* <p>The character stream shall not include a byte order mark.</p>
*
* @param characterStream The character stream containing the document.
- * @see #setCharacterStream
- * @see #setByteStream
* @see #setSystemId(String)
- * @see #setNode(Node)
* @see #setEncoding(String)
- * @see #setPublicId(String)
*/
public XSLTInputSource (Reader characterStream)
{
@@ -163,12 +146,7 @@
* with the zero-argument constructor and setting the new object's Node
property.
*
* @param node The DOM Node containing the document.
- * @see #setNode(Node)
- * @see #setCharacterStream
- * @see #setByteStream
* @see #setSystemId(String)
- * @see #setEncoding(String)
- * @see #setPublicId(String)
*/
public XSLTInputSource (Node node)
{
@@ -181,12 +159,8 @@
* This operation sets the ByteStream, CharacterStream, SystemId,
PublicID, and Encoding properties.
*
* @param isource The SAX input source.
- * @see #setCharacterStream
- * @see #setByteStream
* @see #setSystemId(String)
* @see #setEncoding(String)
- * @see #setPublicId(String)
- * @see #setNode(Node)
*/
public XSLTInputSource (InputSource isource)
{
@@ -204,7 +178,6 @@
* @param characterStream The character stream containing the
* XML document or XSL stylesheet.
* @see #XSLTInputSource(Node)
- * @see #getCharacterStream()
* @see java.io.Reader
*
public void setNode (Node node)
@@ -217,7 +190,6 @@
*
* @return The DOM node containing the document, or null if none was
supplied.
* @see #XSLTInputSource(Node)
- * @see #setNode(Node)
*
public Node getNode ()
{
@@ -238,7 +210,6 @@
*
* @param encoding A string describing the character encoding.
* @see #setSystemId
- * @see #setByteStream
* @see #getEncoding
*/
public void setEncoding (String encoding)
@@ -251,9 +222,7 @@
* Get the character encoding for a byte stream or URI.
*
* @return The encoding, or null if none was supplied.
- * @see #setByteStream
* @see #getSystemId
- * @see #getByteStream
*/
public String getEncoding ()
{
@@ -271,7 +240,6 @@
*
* @param characterStream The character stream containing the
* XML document or other entity.
- * @see #getCharacterStream
* @see java.io.Reader
*
public void setCharacterStream (Reader characterStream)
@@ -284,7 +252,6 @@
* Get the character stream for this input source.
*
* @return The character stream, or null if none was supplied.
- * @see #setCharacterStream
*
public Reader getCharacterStream ()
{
1.3 +5 -5
xml-xalan/java/compat_src/org/apache/xalan/xslt/XSLTProcessor.java
Index: XSLTProcessor.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/compat_src/org/apache/xalan/xslt/XSLTProcessor.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- XSLTProcessor.java 2001/01/18 17:46:55 1.2
+++ XSLTProcessor.java 2001/01/19 18:48:52 1.3
@@ -187,15 +187,15 @@
/**
* Get the preferred stylesheet for the XSLTInputSource XML document,
* as identified by the xml-stylesheet PI, and matching the media and
- * charset criteria. See [EMAIL PROTECTED]
http://www.w3.org/TR/xml-stylesheet/
- * Associating Style Sheets with XML documents}
+ * charset criteria. See <a href="http://www.w3.org/TR/xml-stylesheet/";>
+ * Associating Style Sheets with XML documents</a>.
* Does not yet handle the LINK REL="stylesheet" syntax.
*
* @param media The media attribute to be matched. May be null, in which
* case the prefered stylesheet will be used (i.e., alternate
= no).
* @param title The value of the title attribute to match. May be null.
* @param charset The value of the charset attribute to match. May be
null.
- * @returns StylesheetSpec extends XSLTInputSource extedns SAX
InputSource; the return value
+ * @returns StylesheetSpec extends XSLTInputSource extends SAX
InputSource; the return value
* can be passed to the processStylesheet method.
*/
public StylesheetSpec getAssociatedStylesheet(XSLTInputSource source,
@@ -206,8 +206,8 @@
/**
* Get a list of stylesheet specifications for the XSLTInputSource XML
document,
* as identified by the xml-stylesheet PI, and matching the media and
- * charset criteria. See [EMAIL PROTECTED]
http://www.w3.org/TR/xml-stylesheet/
- * Associating Style Sheets with XML documents}.
+ * charset criteria. See <a href="http://www.w3.org/TR/xml-stylesheet/";>
+ * Associating Style Sheets with XML documents</a>.
* Does not yet handle the LINK REL="stylesheet" syntax.
*
* @param media The media attribute to be matched. May be null, in which
1.2 +6 -27
xml-xalan/java/compat_src/org/apache/xalan/xslt/XSLTProcessorFactory.java
Index: XSLTProcessorFactory.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/compat_src/org/apache/xalan/xslt/XSLTProcessorFactory.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XSLTProcessorFactory.java 2001/01/11 19:29:08 1.1
+++ XSLTProcessorFactory.java 2001/01/19 18:48:53 1.2
@@ -71,11 +71,7 @@
public class XSLTProcessorFactory
{
/**
- * Get a new XSLTProcessor with the default high-performance DTM (Document
Table Model) liaison and XML parser.
- * <p><b>Note</b> If you want to process DOM Node input, use [EMAIL
PROTECTED] #getProcessorUsingLiaisonName
- *
getProcessorUsingLiaisonName("org.apache.xalan.xpath.xdom.XercesLiaison")}.</p>
- * @return An implentation of the XSLTProcessor interface with which you
can perform transformations.
- * @see org.apache.xalan.xpath.dtm.DTMLiaison
+ * Get a new XSLTProcessor.
*/
public static XSLTProcessor getProcessor()
throws org.xml.sax.SAXException
@@ -85,18 +81,10 @@
}
/**
- * Get a new XSLTProcessor that will use a given XMLParserLiaison class to
interact with
- * a given XML parser. You can use this method, for example, if you are
processing DOM Node input with
- * org.apache.xalan.xpath.xdom.XercesLiaison and the Xerces XML parser.
- * <p>If your input is in the form of
- * a file, character stream, byte stream, or SAX DocumentHandler, you may
want to use the high-performance
- * DTM liaison and parser, in which case you can use the no-argument
constructor.</p>
- * @param parserLiaisonClassName The name of the ParserLiaison class.
- * @return An implentation of the XSLTProcessor interface with which you
can perform transformations.
- *
+ * Get a new XSLTProcessor (parserLiaisonClassName no longre used).
+ * *
* @see #getProcessor()
* @see org.apache.xalan.xpath.xml.XMLParserLiaison
- * @see org.apache.xalan.xpath.dtm.DTMLiaison
*/
public static XSLTProcessor getProcessorUsingLiaisonName(String
parserLiaisonClassName)
throws org.xml.sax.SAXException
@@ -107,17 +95,13 @@
}
/**
- * Get a new XSLTProcessor that will use the specified XMLParserLiaison to
interact
- * with a given XML parser. If your input is in the form of
- * a file, character stream, byte stream, or SAX DocumentHandler, you may
want to use the high-performance
- * DTM liaison and parser, in which case you can use the no-argument
getProcessor() method.
+ * Get a new XSLTProcessor (XMLParserLiaison no longer used).
*
* @param parserLiaison the XMLParserLiaison set up to interact with a
given XML parser.
- * @return An implentation of the XSLTProcessor interface with which you
can perform transformations.
+ * @return An implementation of the XSLTProcessor interface with which you
can perform transformations.
*
* @see #getProcessor()
* @see org.apache.xalan.xpath.xml.XMLParserLiaison
- * @see org.apache.xalan.xpath.dtm.DTMLiaison
*/
public static XSLTProcessor getProcessor(XMLParserLiaison parserLiaison)
{
@@ -138,10 +122,7 @@
}
/**
- * Get a new XSLTProcessor that will use the specified XMLParserLiaison
and XPathFactory to interact
- * with a given XML parser. If your input is in the form of
- * a file, character stream, byte stream, or SAX DocumentHandler, you may
want to use the high-performance
- * DTM liaison and parser, in which case you can use the no-argument
getProcessor() method.
+ * Get a new XSLTProcessor (XMLParserLiaison and XPathFactory no longer
used).
*
* @param parserLiaison the XMLParserLiaison set up to interact with a
given XML parser.
* @param xpathFactory A custom XPathFactory.
@@ -150,7 +131,6 @@
*
* @see #getProcessor()
* @see org.apache.xalan.xpath.xml.XMLParserLiaison
- * @see org.apache.xalan.xpath.dtm.DTMLiaison
*/
public static XSLTProcessor getProcessor(XMLParserLiaison parserLiaison,
XPathFactory xpathFactory)
@@ -169,5 +149,4 @@
return null;
}
}
-
}
1.2 +1 -22
xml-xalan/java/compat_src/org/apache/xalan/xslt/XSLTResultTarget.java
Index: XSLTResultTarget.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/compat_src/org/apache/xalan/xslt/XSLTResultTarget.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XSLTResultTarget.java 2001/01/11 19:29:08 1.1
+++ XSLTResultTarget.java 2001/01/19 18:48:53 1.2
@@ -92,9 +92,6 @@
* Zero-argument default constructor -- Before you can use the new
XSLTResultTarget object in a transformation,
* you must define the output container by setting its FileName,
CharacterStrea, ByteStream, or Node property.
*
- * @see #setFileName(String)
- * @see #setCharacterStream(Writer)
- * @see #setByteStream(OutputStream)
* @see #setNode(Node)
* @see #setDocumentHandler(DocumentHandler)
* @see #setEncoding(String)
@@ -110,9 +107,6 @@
*
* @param fileName Identifies the file that will contain the
transformation result (must be a valid system file name).
*
- * @see #setFileName(String)
- * @see #setCharacterStream(Writer)
- * @see #setByteStream(OutputStream)
* @see #setNode(Node)
* @see #setDocumentHandler(DocumentHandler)
* @see #setEncoding(String)
@@ -130,9 +124,6 @@
*
* @param byteStream The raw byte stream that will contain the
transformation result.
*
- * @see #setByteStream(OutputStream)
- * @see #setFileName(String)
- * @see #setCharacterStream(Writer)
* @see #setNode(Node)
* @see #setDocumentHandler(DocumentHandler)
* @see #setEncoding(String)
@@ -151,9 +142,6 @@
*
* @param characterStream The character stream where the transformation
result is written.
*
- * @see #setCharacterStream(Writer)
- * @see #setByteStream(OutputStream)
- * @see #setFileName(String)
* @see #setNode(Node)
* @see #setDocumentHandler(DocumentHandler)
* @see #setEncoding(String)
@@ -171,9 +159,6 @@
* @param node The DOM Node that will contain the transformation result.
*
* @see #setNode(Node)
- * @see #setCharacterStream(Writer)
- * @see #setByteStream(OutputStream)
- * @see #setFileName(String)
* @see #setDocumentHandler(DocumentHandler)
* @see #setEncoding(String)
*/
@@ -192,9 +177,6 @@
*
* @see #setDocumentHandler(DocumentHandler)
* @see #setNode(Node)
- * @see #setCharacterStream(Writer)
- * @see #setByteStream(OutputStream)
- * @see #setFileName(String)
* @see #setEncoding(String)
*/
public XSLTResultTarget(DocumentHandler handler)
@@ -204,8 +186,7 @@
saxResult.setHandler(((ParserAdapter)handler).getContentHandler());
setDocumentHandler(handler);
}
-
-
+
/**
* Set the file name or URL where the transformation result will be
written.
@@ -213,7 +194,6 @@
* @param fileName The system identifier as a string.
*
* @see #XSLTResultTarget(String)
- * @see #getFileName
*
public void setFileName (String fileName) // File?
{
@@ -227,7 +207,6 @@
* @return The file name or URL.
*
* @see #XSLTResultTarget(String)
- * @see #setFileName(String)
*/
public String getFileName ()
{
1.2 +1 -1
xml-xalan/java/compat_src/org/apache/xalan/xslt/package.html
Index: package.html
===================================================================
RCS file:
/home/cvs/xml-xalan/java/compat_src/org/apache/xalan/xslt/package.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- package.html 2001/01/11 22:30:14 1.1
+++ package.html 2001/01/19 18:48:53 1.2
@@ -1,5 +1,5 @@
<HTML><HEAD></HEAD><BODY>
- <P><B>The main Xalan-Java 1.x compatability package</B> -- facilities
for setting up and performing XSL transformations.</P>
+ <P><B>The main Xalan-Java 1 compatability package</B> -- facilities for
setting up and performing XSL transformations.</P>
<P>Use one of the [EMAIL PROTECTED]
org.apache.xalan.xslt.XSLTProcessorFactory} static getProcessor methods to
instantiate an [EMAIL PROTECTED] org.apache.xalan.xslt.XSLTProcessor}.
The XSLTProcessor interface defines the
