XT Interface

com.bea.wlxt
XT Interface

public interface XT

Method Summary
public void
addMFLDocument(URL mflURI)
Add a MFL document to the cache.
public void
addMFLDocument(URL mflURI, InputSource mflInput)
Add a MFL document to the cache.
public void
addMFLDocument(URL mflURI, InputStream mflInput)
Add a MFL document to the cache.
public void
addMFLDocument(URL mflURI, Reader mflInput)
public void
addStylesheet(URL stylesheetURI)
Add a single stylesheet to the cache.
public void
addStylesheet(URL stylesheetURI, InputSource stylesheetInput)
Add a single stylesheet to the cache.
public void
clearMFLCache()
public void
init(Properties properties)
Initialize the WLXT with a Properties object.
public void
init(String filename)
Initialize WLXT with a Properties file.
public Document
parse(URL mflURI, InputStream binaryInput, PrintWriter debug)
Parse binary data given in binaryInput argument using the MFL document specified by mflURI.
public Document
parse(URL mflURI, InputStream binaryInput, String dtdSystemId, PrintWriter debug)
Parse binary data given in binaryInput argument using the MFL document specified by mflURI.
public Document
parse(URL mflURI, InputStream binaryInput, String defaultNamespace, String schemaLocation, PrintWriter debug)
Parse binary data given in binaryInput argument using the MFL document specified by mflURI.
public void
reinit(Properties properties)
Reinitialize the entire cache.
public void
reinitStylesheet(URL stylesheetURI)
Reinitialize a single stylesheet.
public void
serialize(URL mflURI, Document document, OutputStream binaryOutput, PrintWriter debug)
Serialize the XML data (given in document argument) to the binary format specified by the MFL document (mflURI).
public void
serialize(URL mflURI, InputStream xmlInput, OutputStream binaryOutput)
Serialize the XML data (given in xmlInput argument) to the binary format specified by the MFL document (mflURI).
public void
serialize(URL mflURI, InputSource xmlInput, OutputStream binaryOutput)
Serialize the XML data (given in xmlInput argument) to the binary format specified by the MFL document (mflURI).
public void
serialize(URL mflURI, InputStream xmlInput, OutputStream binaryOutput, PrintWriter debug)
Serialize the XML data (given in xmlInput argument) to the binary format specified by the MFL document (mflURI).
public void
serialize(URL mflURI, InputSource xmlInput, OutputStream binaryOutput, PrintWriter debug)
Serialize the XML data (given in xmlInput argument) to the binary format specified by the MFL document (mflURI).
public void
transform(InputSource xmlInput, OutputStream out, URL stylesheetURI)
Perform an XSLT transformation on the XML input argument using the specified stylesheet.
public void
transform(Document document, OutputStream out, URL stylesheetURI)
Perform an XSLT transformation on the document argument using the specified stylesheet.
public Document
transform(InputSource xmlInput, URL stylesheetURI)
Perform an XSLT transformation on the document argument using the specified stylesheet.
public Document
transform(Document document, URL stylesheetURI)
Perform an XSLT transformation on the document argument using the specified stylesheet.

Method Detail

addMFLDocument(URL) Method

DEPRECATED 

public void addMFLDocument(URL mflURI)
     throws Exception
Add a MFL document to the cache. This method causes the specified MFL document to be parsed and added to the WLXT object's cache. If a MFL Document has previously been added using this URI, the previous document is replaced.

Parameters

mflURI
The unique resource identifier for the MFL document

Exceptions

Exception

Related Topics

URL

addMFLDocument(URL, InputSource) Method

DEPRECATED 

public void addMFLDocument(URL mflURI, 
                           InputSource mflInput)
     throws Exception
Add a MFL document to the cache. The user can supply the InputSource for the content of the MFL document. This method causes the specified MFL document to be parsed and added to the WLXT object's cache. If a MFL Document has previously been added using this URI, the previous document is replaced.

Parameters

mflURI
The unique resource identifier for the MFL document
mflInput
The InputSource for the content of the MFL document

Exceptions

Exception

Related Topics

URL

addMFLDocument(URL, InputStream) Method

DEPRECATED 

public void addMFLDocument(URL mflURI, 
                           InputStream mflInput)
     throws Exception
Add a MFL document to the cache. The user can supply the InputSource for the content of the MFL document. This method causes the specified MFL document to be parsed and added to the WLXT object's cache. If a MFL Document has previously been added using this URI, the previous document is replaced.

Parameters

mflURI
The unique resource identifier for the MFL document
mflInput
The InputSource for the content of the MFL document

Exceptions

Exception

Related Topics

URL

addMFLDocument(URL, Reader) Method

public void addMFLDocument(URL mflURI, 
                           Reader mflInput)
     throws Exception

Exceptions

Exception

addStylesheet(URL) Method

DEPRECATED 

public void addStylesheet(URL stylesheetURI)
     throws Exception
Add a single stylesheet to the cache. This method causes the specified stylesheet to be added into the XSLTWrapper object's cache.

Parameters

stylesheetURI
The unique resource identifier for the stylesheet

Exceptions

Exception

Related Topics

URL

addStylesheet(URL, InputSource) Method

DEPRECATED 

public void addStylesheet(URL stylesheetURI, 
                          InputSource stylesheetInput)
     throws Exception
Add a single stylesheet to the cache. The user can supply the InputSource for the content of the stylesheet. This method causes the specified stylesheet to be added into the XSLTWrapper object's cache.

Parameters

stylesheetURI
The unique resource identifier for the stylesheet
stylesheetInput
The InputSource for the stylesheet

Exceptions

Exception

Related Topics

URL

clearMFLCache() Method

public void clearMFLCache()

init(Properties) Method

DEPRECATED 

public void init(Properties properties)
     throws Exception
Initialize the WLXT with a Properties object.

Parameters

properties
Properties object containing the property 'WLXT.stylesheets' and/or 'WLXT.MFLDocuments'.

Exceptions

Exception

Related Topics

Properties

init(String) Method

DEPRECATED 

public void init(String filename)
     throws Exception
Initialize WLXT with a Properties file. The properties file should contain the property 'WLXT.stylesheets' and/or 'WLXT.MFLDocuments'. The stylesheets listed in the 'WLXT.stylesheets' property are precompiled and cached internally. The MFL documents listed in the 'WLXT.MFLDocument' property are also precompiled and cached internally.

Parameters

filename
The name of the properties file

Exceptions

Exception

parse(URL, InputStream, PrintWriter) Method

DEPRECATED 

public Document parse(URL mflURI, 
                      InputStream binaryInput, 
                      PrintWriter debug)
     throws Exception
Parse binary data given in binaryInput argument using the MFL document specified by mflURI. The resulting DOM object is returned to the caller.

No DTD or schema reference is output in the resulting XML.

If the MFL document is not found in the cache, then it will be automatically processed and added to the cache.

Parameters

mflURI
URL to MFL document that should be used to parse binary data
binaryInput
InputStream of binary data that should be converted to XML
debug
PrintWriter to be used to display parse debug information. May be null to disable debug information.

Exceptions

Exception

parse(URL, InputStream, String, PrintWriter) Method

DEPRECATED 

public Document parse(URL mflURI, 
                      InputStream binaryInput, 
                      String dtdSystemId, 
                      PrintWriter debug)
     throws Exception
Parse binary data given in binaryInput argument using the MFL document specified by mflURI. The resulting DOM object is returned to the caller.

This method has a system id parameter that allows the user to specify the document type definition for the doctype element of the resulting XML.

If the MFL document is not found in the cache, then it will be automatically processed and added to the cache.

Parameters

mflURI
URL to MFL document that should be used to parse binary data
binaryInput
InputStream of binary data that should be converted to XML
dtdSystemId
The system id of the Document Type Definition. This id will be output in the DOCTYPE element of the resulting XML.
debug
PrintWriter to be used to display parse debug information. May be null to disable debug information.

Exceptions

Exception

parse(URL, InputStream, String, String, PrintWriter) Method

DEPRECATED 

public Document parse(URL mflURI, 
                      InputStream binaryInput, 
                      String defaultNamespace, 
                      String schemaLocation, 
                      PrintWriter debug)
     throws Exception
Parse binary data given in binaryInput argument using the MFL document specified by mflURI. The resulting DOM object is returned to the caller.

This method has default namespace parameter that causes the resulting XML to output a default namespace in the root node of the document. This method also has a schema location parameter cause the resulting XML to reference a schema as its content model.

If the MFL document is not found in the cache, then it will be automatically processed and added to the cache.

Parameters

mflURI
URL to MFL document that should be used to parse binary data
binaryInput
InputStream of binary data that should be converted to XML
defaultNamespace
can be null, if not null causes a default namespace to be declared in the root node of the resulting XML
schemaLocation
causes a reference to the specified schema to be output in the root node of the resulting XML
debug
PrintWriter to be used to display parse debug information. May be null to disable debug information.

Exceptions

Exception

reinit(Properties) Method

DEPRECATED 

public void reinit(Properties properties)
     throws Exception
Reinitialize the entire cache. This method causes all stylesheets and MFL documents to be reloaded into the cache. The properties object should contain the property 'WLXT.stylesheets' and/or 'WLXT.MFLDocuments'.

Parameters

properties
Properties object containing the property WLXT.stylesheets and/or WLXT.MFLDocuments

Exceptions

Exception

reinitStylesheet(URL) Method

DEPRECATED 

public void reinitStylesheet(URL stylesheetURI)
     throws Exception
Reinitialize a single stylesheet. This method causes the specified stylesheet to be reloaded into the cache.

Parameters

stylesheetURI
The unique resource identifier for the stylesheet

Exceptions

Exception

Related Topics

URL

serialize(URL, Document, OutputStream, PrintWriter) Method

DEPRECATED 

public void serialize(URL mflURI, 
                      Document document, 
                      OutputStream binaryOutput, 
                      PrintWriter debug)
     throws Exception
Serialize the XML data (given in document argument) to the binary format specified by the MFL document (mflURI). Each node of XML data is converted to the binary format specified by the MFL FieldFormat of the identical name. The order and grouping of the XML nodes must match the order and sequence specified in the MFL document.

If the MFL document is not found in the cache, then it will be automatically processed and added to the cache.

Parameters

mflURI
URL to MFL document that should be used to convert the XML data to the binary format
document
XML data that is to be converted to a binary format
binaryOutput
OutputStream that is to contain the binary data
debug
PrintWriter to be used to display (or log) debug information. May be null to disable debug information.

Exceptions

Exception

serialize(URL, InputStream, OutputStream) Method

DEPRECATED 

public void serialize(URL mflURI, 
                      InputStream xmlInput, 
                      OutputStream binaryOutput)
     throws Exception
Serialize the XML data (given in xmlInput argument) to the binary format specified by the MFL document (mflURI). Each node of XML data is converted to the binary format specified by the MFL FieldFormat of the identical name. The order and grouping of the XML nodes must match the order and sequence specified in the MFL document.

If the MFL document is not found in the cache, then it will be automatically processed and added to the cache.

Parameters

mflURI
URL to MFL document that should be used to convert the XML data to the binary format
xmlInput
XML data that is to be converted to a binary format
binaryOutput
OutputStream that is to contain the binary data

Exceptions

Exception

serialize(URL, InputSource, OutputStream) Method

DEPRECATED 

public void serialize(URL mflURI, 
                      InputSource xmlInput, 
                      OutputStream binaryOutput)
     throws Exception
Serialize the XML data (given in xmlInput argument) to the binary format specified by the MFL document (mflURI). Each node of XML data is converted to the binary format specified by the MFL FieldFormat of the identical name. The order and grouping of the XML nodes must match the order and sequence specified in the MFL document.

If the MFL document is not found in the cache, then it will be automatically processed and added to the cache.

Parameters

mflURI
URL to MFL document that should be used to convert the XML data to the binary format
xmlInput
XML data that is to be converted to a binary format
binaryOutput
OutputStream that is to contain the binary data

Exceptions

Exception

serialize(URL, InputStream, OutputStream, PrintWriter) Method

DEPRECATED 

public void serialize(URL mflURI, 
                      InputStream xmlInput, 
                      OutputStream binaryOutput, 
                      PrintWriter debug)
     throws Exception
Serialize the XML data (given in xmlInput argument) to the binary format specified by the MFL document (mflURI). Each node of XML data is converted to the binary format specified by the MFL FieldFormat of the identical name. The order and grouping of the XML nodes must match the order and sequence specified in the MFL document.

If the MFL document is not found in the cache, then it will be automatically processed and added to the cache.

Parameters

mflURI
URL to MFL document that should be used to convert the XML data to the binary format
xmlInput
XML data that is to be converted to a binary format
binaryOutput
OutputStream that is to contain the binary data
debug
PrintWriter to be used to display (or log) debug information. May be null to disable debug information.

Exceptions

Exception

serialize(URL, InputSource, OutputStream, PrintWriter) Method

DEPRECATED 

public void serialize(URL mflURI, 
                      InputSource xmlInput, 
                      OutputStream binaryOutput, 
                      PrintWriter debug)
     throws Exception
Serialize the XML data (given in xmlInput argument) to the binary format specified by the MFL document (mflURI). Each node of XML data is converted to the binary format specified by the MFL FieldFormat of the identical name. The order and grouping of the XML nodes must match the order and sequence specified in the MFL document.

If the MFL document is not found in the cache, then it will be automatically processed and added to the cache.

Parameters

mflURI
URL to MFL document that should be used to convert the XML data to the binary format
xmlInput
XML data that is to be converted to a binary format
binaryOutput
OutputStream that is to contain the binary data
debug
PrintWriter to be used to display (or log) debug information. May be null to disable debug information.

Exceptions

Exception

transform(InputSource, OutputStream, URL) Method

DEPRECATED 

public void transform(InputSource xmlInput, 
                      OutputStream out, 
                      URL stylesheetURI)
     throws Exception
Perform an XSLT transformation on the XML input argument using the specified stylesheet. The result of the transformation is written to the output stream parameter. If the stylesheet is not found in the cache, then it will be automatically processed and added to the cache.

Parameters

xmlInput
XML input to XSLT transformation
out
Output stream where the result of transformation is written.
stylesheetURI
The unique resource identifier for the stylesheet to use for the transformation

Exceptions

Exception

Related Topics

InputSource
URL

transform(Document, OutputStream, URL) Method

DEPRECATED 

public void transform(Document document, 
                      OutputStream out, 
                      URL stylesheetURI)
     throws Exception
Perform an XSLT transformation on the document argument using the specified stylesheet. The result of the transformation is put in the result parameter.

Parameters

document
DOM Document object to be transformed
out
Output stream where the result of transformation is written.
stylesheetURI
The unique resource identifier for the stylesheet to use for the transformation

Exceptions

Exception

Related Topics

Document
URL

transform(InputSource, URL) Method

DEPRECATED 

public Document transform(InputSource xmlInput, 
                          URL stylesheetURI)
     throws Exception
Perform an XSLT transformation on the document argument using the specified stylesheet. The result of the transformation is returned.

Parameters

xmlInput
XML input to XSLT transformation
stylesheetURI
The unique resource identifier for the stylesheet to use for the transformation

Returns

document DOM Document object that results from transformation

Exceptions

Exception

Related Topics

Document
URL

transform(Document, URL) Method

DEPRECATED 

public Document transform(Document document, 
                          URL stylesheetURI)
     throws Exception
Perform an XSLT transformation on the document argument using the specified stylesheet. The result of the transformation is returned.

Parameters

document
DOM Document object to be transformed
stylesheetURI
The unique resource identifier for the stylesheet to use for the transformation

Returns

document DOM Document object that results from transformation

Exceptions

Exception

Related Topics

Document
URL