|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object | +--org.apache.xalan.xslt.XSLTResultTarget
Contains the result of a transformation that you perform with the XSLTProcessor process() method or one of the StylesheetRoot process() methods. Create an instance of this class to provide the process() method a container for the transformation result tree. You can use a file name or URL, character stream, byte stream, DOM Node, or SAX DocumentHandler to instantiate an XSLTResultTarget object.
XSLTProcessor.process(XSLTInputSource, XSLTInputSource, XSLTResultTarget),
StylesheetRoot| Constructor Summary | |
XSLTResultTarget()
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. |
|
XSLTResultTarget(org.xml.sax.DocumentHandler handler)
Create a new output target with a SAX Document handler, which will handle result events -- the equivalent of creating an output target with the zero-argument constructor and setting the new object's DocyumentHandler property. |
|
XSLTResultTarget(org.w3c.dom.Node n)
Create a new output target with a DOM Node -- the equivalent of creating an output target with the zero-argument constructor and setting the new object's Node property. |
|
XSLTResultTarget(java.io.OutputStream byteStream)
Create a new output target with a byte stream -- the equivalent of creating an output target with the zero-argument constructor and setting the new object's ByteStream property. |
|
XSLTResultTarget(java.lang.String fileName)
Create a new output target with a file name -- the equivalent of creating an output target with the zero-argument constructor and setting the new object's FileName property. |
|
XSLTResultTarget(java.io.Writer characterStream)
Create a new output target with a character stream -- the equivalent of creating an output target with the zero-argument constructor and setting the new object's CharacterStream property. |
|
| Method Summary | |
java.io.OutputStream |
getByteStream()
Get the byte stream that contains or will contain the transformation result. |
java.io.Writer |
getCharacterStream()
Get the character stream that was set with setWriter. |
org.xml.sax.DocumentHandler |
getDocumentHandler()
Get the SAX DocumentHandler that processes the result tree events. |
java.lang.String |
getEncoding()
Get the character encoding that was used. |
java.lang.String |
getFileName()
Get the file name where the results are or will be written, or null if none was supplied. |
org.w3c.dom.Node |
getNode()
Get the node that will contain the result DOM tree. |
javax.xml.transform.Result |
getResultObject()
Get the Result object associated with this XSLTResultTarget object . |
java.lang.String |
getSystemId()
Get the system identifier that was set with setSystemId. |
void |
setByteStream(java.io.OutputStream byteStrm)
Set the byte stream to contain the transformation result. |
void |
setCharacterStream(java.io.Writer writer)
Set the writer that is to receive the result. |
void |
setDocumentHandler(org.xml.sax.DocumentHandler handler)
Set a SAX DocumentHandler to process the result tree events. |
void |
setEncoding(java.lang.String encoding)
Set the character encoding, if known. |
void |
setFileName(java.lang.String fileName)
Set the file name or URL where the transformation result will be written. |
void |
setNode(org.w3c.dom.Node node)
Set the node that will contain the result DOM tree. |
void |
setSystemId(java.lang.String systemID)
Set the system identifier for this Result. |
| Methods inherited from class java.lang.Object |
equals,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
| Constructor Detail |
public XSLTResultTarget()
setFileName(String),
setCharacterStream(Writer),
setByteStream(OutputStream),
setNode(Node),
setDocumentHandler(DocumentHandler),
setEncoding(String)public XSLTResultTarget(java.lang.String fileName)
fileName - Identifies the file that will contain the transformation result (must be a valid system file name).setFileName(String),
setCharacterStream(Writer),
setByteStream(OutputStream),
setNode(Node),
setDocumentHandler(DocumentHandler),
setEncoding(String)public XSLTResultTarget(java.io.OutputStream byteStream)
byteStream - The raw byte stream that will contain the transformation result.setByteStream(OutputStream),
setFileName(String),
setCharacterStream(Writer),
setNode(Node),
setDocumentHandler(DocumentHandler),
setEncoding(String)public XSLTResultTarget(java.io.Writer characterStream)
characterStream - The character stream where the transformation result is written.setCharacterStream(Writer),
setByteStream(OutputStream),
setFileName(String),
setNode(Node),
setDocumentHandler(DocumentHandler),
setEncoding(String)public XSLTResultTarget(org.w3c.dom.Node n)
node - The DOM Node that will contain the transformation result.setNode(Node),
setCharacterStream(Writer),
setByteStream(OutputStream),
setFileName(String),
setDocumentHandler(DocumentHandler),
setEncoding(String)public XSLTResultTarget(org.xml.sax.DocumentHandler handler)
handler - The SAX Document handler to which the result is written.setDocumentHandler(DocumentHandler),
setNode(Node),
setCharacterStream(Writer),
setByteStream(OutputStream),
setFileName(String),
setEncoding(String)| Method Detail |
public void setFileName(java.lang.String fileName)
fileName - The system identifier as a string.XSLTResultTarget(String),
getFileName()public java.lang.String getFileName()
XSLTResultTarget(String),
setFileName(String)public void setEncoding(java.lang.String encoding)
encoding - The character encoding.public java.lang.String getEncoding()
public void setDocumentHandler(org.xml.sax.DocumentHandler handler)
handler - The SAX DocumentHandler to process result tree events.XSLTResultTarget(DocumentHandler),
getDocumentHandler()public org.xml.sax.DocumentHandler getDocumentHandler()
XSLTResultTarget(DocumentHandler),
setDocumentHandler(DocumentHandler)public void setNode(org.w3c.dom.Node node)
Document node,
a DocumentFragment node, or a
Element node. In other words, a node
that accepts children.node - The node to which the transformation
will be appended.public org.w3c.dom.Node getNode()
public void setByteStream(java.io.OutputStream byteStrm)
byteStream - A byte stream that will contain the transformation result.XSLTResultTarget(OutputStream),
setByteStream(OutputStream)public java.io.OutputStream getByteStream()
XSLTResultTarget(OutputStream),
setByteStream(OutputStream)public void setSystemId(java.lang.String systemID)
If the Result is not to be written to a file, the system identifier is optional. The application may still want to provide one, however, for use in error messages and warnings, or to resolve relative output identifiers.
systemId - The system identifier as a URI string.public java.lang.String getSystemId()
public void setCharacterStream(java.io.Writer writer)
writer - A valid Writer reference.public java.io.Writer getCharacterStream()
public javax.xml.transform.Result getResultObject()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||