Package com.nfbsoftware.xml

Interface IXslDocument

All Superinterfaces:

Serializable

All Known Implementing Classes:

XslDocument

public interface IXslDocument
extends Serializable

Author:

Brendan Clemenzi

Method Summary

Modifier and Type	Method	Description
void	load(File file)	This method replaces the content of the current root node with that of the input file.
void	load(File file, String encoding)	This method replaces the content of the current root node with that of the input file.
void	load(InputStream in)	This method replaces the content of the current root node with that of the InputStream.
void	load(InputStream in, String encoding)	This method replaces the content of the current root node with that of the InputStream.
void	load(Reader reader)	This method replaces the content of the current root node with that of the Reader.
void	load(String xml)	This method replaces the content of the current root node with that of the input string.
String	transform(IXmlElement xmlElement)	This method transforms the xml document using this style sheet.
String	transform(File xmlFile)	This method transforms the xml document using this style sheet.
String	transform(File xmlFile, String enc)	This method transforms the xml document using this style sheet.
String	transform(InputStream stream)	This method transforms the xml document using this style sheet.
String	transform(InputStream stream, String encoding)	This method transforms the xml document using this style sheet.
String	transform(Reader reader)	This method transforms the xml document using this style sheet.
String	transform(String xml)	This method transforms the xml document using this style sheet.
IXmlDocument	transformToXmlDocument(IXmlElement xmlElement)	This method transforms the xml document using this style sheet.
IXmlDocument	transformToXmlDocument(File xmlFile)	This method transforms the xml document using this style sheet.
IXmlDocument	transformToXmlDocument(File xmlFile, String encoding)	This method transforms the xml document using this style sheet.
IXmlDocument	transformToXmlDocument(InputStream stream)	This method transforms the xml document using this style sheet.
IXmlDocument	transformToXmlDocument(InputStream stream, String encoding)	This method transforms the xml document using this style sheet.
IXmlDocument	transformToXmlDocument(Reader reader)	This method transforms the xml document using this style sheet.
IXmlDocument	transformToXmlDocument(String xml)	This method transforms the xml document using this style sheet.

Method Details

load

void load(File file)
   throws XmlDocumentCheckedException

This method replaces the content of the current root node with that of the input file.

Parameters:

file - points to the XML file

Throws:

XmlDocumentCheckedException - If the XML is invalid.

load

void load(File file,
 String encoding)
   throws XmlDocumentCheckedException

This method replaces the content of the current root node with that of the input file.

Parameters:

file - points to the XML file

encoding - The name of the supported character encoding

Throws:

XmlDocumentCheckedException - If the XML is invalid.

load

void load(InputStream in)
   throws XmlDocumentCheckedException

This method replaces the content of the current root node with that of the InputStream.

Parameters:

in - A stream containing an XML document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

load

void load(InputStream in,
 String encoding)
   throws XmlDocumentCheckedException

This method replaces the content of the current root node with that of the InputStream.

Parameters:

in - A stream containing an XML document.

encoding - The name of the supported character encoding

Throws:

XmlDocumentCheckedException - If the XML is invalid.

load

void load(Reader reader)
   throws XmlDocumentCheckedException

This method replaces the content of the current root node with that of the Reader.

Parameters:

reader - A reader containing an XML document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

load

void load(String xml)
   throws XmlDocumentCheckedException

This method replaces the content of the current root node with that of the input string.

Parameters:

xml - A string contains an XML document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

transform

String transform(File xmlFile)
          throws XmlDocumentCheckedException

This method transforms the xml document using this style sheet.

Parameters:

xmlFile - a file containing the XML document.

Returns:

The XML document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

transform

String transform(File xmlFile,
 String enc)
          throws XmlDocumentCheckedException

This method transforms the xml document using this style sheet.

Parameters:

xmlFile - the file containing the XML document.

enc - the encoding of the file

Returns:

The XML document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

transform

String transform(InputStream stream)
          throws XmlDocumentCheckedException

This method transforms the xml document using this style sheet.

Parameters:

stream - stream containing the XML document.

Returns:

The XML document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

transform

String transform(InputStream stream,
 String encoding)
          throws XmlDocumentCheckedException

This method transforms the xml document using this style sheet.

Parameters:

stream - stream containing the XML document.

encoding - the encoding of the stream

Returns:

The XML document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

transform

String transform(IXmlElement xmlElement)
          throws XmlDocumentCheckedException

This method transforms the xml document using this style sheet.

Parameters:

xmlElement - a string containing the XML document

Returns:

The XML document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

transform

String transform(Reader reader)
          throws XmlDocumentCheckedException

This method transforms the xml document using this style sheet.

Parameters:

reader - a reader containing the XML document

Returns:

The XML document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

transform

String transform(String xml)
          throws XmlDocumentCheckedException

This method transforms the xml document using this style sheet.

Parameters:

xml - a string containing the XML document

Returns:

The XML document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

transformToXmlDocument

IXmlDocument transformToXmlDocument(File xmlFile)
                             throws XmlDocumentCheckedException

This method transforms the xml document using this style sheet.

Parameters:

xmlFile - a file containing the XML document.

Returns:

The XML document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

transformToXmlDocument

IXmlDocument transformToXmlDocument(File xmlFile,
 String encoding)
                             throws XmlDocumentCheckedException

This method transforms the xml document using this style sheet.

Parameters:

xmlFile - a file containing the XML document.

encoding - the encoding of the stream

Returns:

The XML document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

transformToXmlDocument

IXmlDocument transformToXmlDocument(InputStream stream)
                             throws XmlDocumentCheckedException

This method transforms the xml document using this style sheet.

Parameters:

stream - stream containing the XML document.

Returns:

The XML document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

transformToXmlDocument

IXmlDocument transformToXmlDocument(InputStream stream,
 String encoding)
                             throws XmlDocumentCheckedException

This method transforms the xml document using this style sheet.

Parameters:

stream - stream containing the XML document.

encoding - the encoding of the stream

Returns:

The XML document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

transformToXmlDocument

IXmlDocument transformToXmlDocument(IXmlElement xmlElement)
                             throws XmlDocumentCheckedException

This method transforms the xml document using this style sheet.

Parameters:

xmlElement - the XML document

Returns:

The XML document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

transformToXmlDocument

IXmlDocument transformToXmlDocument(Reader reader)
                             throws XmlDocumentCheckedException

This method transforms the xml document using this style sheet.

Parameters:

reader - a reader containing the XML document

Returns:

The XML document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.

transformToXmlDocument

IXmlDocument transformToXmlDocument(String xml)
                             throws XmlDocumentCheckedException

This method transforms the xml document using this style sheet.

Parameters:

xml - a string containing the XML document

Returns:

The XML document.

Throws:

XmlDocumentCheckedException - If the XML is invalid.