com.f1j.data
Interface XSLTDocument

public interface XSLTDocument

This interface provides the API for setting the XSLT document associated with a range.

Field Summary

static short	eSourceBuffer XSLT Document is saved in the spreadsheet.
static short	eSourceNone No XSLT Document is used.
static short	eSourceURL XSLT Document references an external file.

Method Summary

java.lang.StringBuffer	getDocument() Returns the text of the XSLT document.
java.lang.String	getDocumentPath() Returns the reference to an external XSLT document.
java.lang.String	getLogFilePath() Returns the log file that will be written out.
short	getSourceType() Returns the XSLT document source type.
void	setDocument(java.lang.String document) Sets the text of the XSLT document as a String.
void	setDocument(java.lang.StringBuffer document) Sets the text of the XSLT document as a StringBuffer.
void	setDocumentPath(java.lang.String documentPath) Sets a reference to an external XSLT document.
void	setLogFilePath(java.lang.String log) Sets the reference for the log file that will be written out.
void	setSourceType(short type) Sets the XSLT document source type.

Field Detail

eSourceNone

public static final short eSourceNone

No XSLT Document is used.

eSourceBuffer

public static final short eSourceBuffer

XSLT Document is saved in the spreadsheet.

See Also:

setDocument(java.lang.StringBuffer)

eSourceURL

public static final short eSourceURL

XSLT Document references an external file.

See Also:

setDocumentPath(java.lang.String)

Method Detail

setDocument

public void setDocument(java.lang.StringBuffer document)

Sets the text of the XSLT document as a StringBuffer. This method saves the XSLT document in the spreadsheet file.

Parameters:

document - the text of the XSLT document as a StringBuffer.

See Also:

getDocument()

setDocument

public void setDocument(java.lang.String document)

Sets the text of the XSLT document as a String. This method saves the XSLT document in the spreadsheet file.

Parameters:

document - the text of the XSLT document as a String.

See Also:

getDocument()

getDocument

public java.lang.StringBuffer getDocument()

Returns the text of the XSLT document. This only works if the setDocument method was called to set the XSLT document.

Returns:

the text of the XSLT document as a StringBuffer.

See Also:

setDocument(java.lang.StringBuffer)

setDocumentPath

public void setDocumentPath(java.lang.String documentPath)
                     throws java.net.MalformedURLException

Sets a reference to an external XSLT document.

Parameters:

documentPath - the full path to the XSLT document associated with this range.

Throws:

MalformedURLException when a malformed URL has occurred.

See Also:

getDocumentPath()

getDocumentPath

public java.lang.String getDocumentPath()

Returns the reference to an external XSLT document.

Returns:

String indicating the document path.

See Also:

setDocumentPath(java.lang.String)

setLogFilePath

public void setLogFilePath(java.lang.String log)

Sets the reference for the log file that will be written out.

Parameters:

log - a String representing the full path for the log file.

See Also:

getLogFilePath()

getLogFilePath

public java.lang.String getLogFilePath()

Returns the log file that will be written out.

Returns:

a String representing the full path for the log file.

See Also:

setLogFilePath(java.lang.String)

setSourceType

public void setSourceType(short type)

Sets the XSLT document source type.

Parameters:

type - a short indicating the source type:

XSLT Document Source Types

Source Type	Description
eSourceBuffer	saves the XSLT Document in the spreadsheet
eSourceNone	uses no XSLT Document
eSourceURL	references an external XSLT Document

See Also:

getSourceType()

getSourceType

public short getSourceType()

Returns the XSLT document source type.

Returns:

type a short indicating the source type. See table in setSourceType.

See Also:

setSourceType(short)