io.starter.OpenXLS

Interface Document

All Known Subinterfaces:

WorkBook

All Known Implementing Classes:

DocumentHandle, WorkBookHandle

public interface Document

An interface representing an OpenXLS document. This interface provides no functionality beyond the abstract DocumentHandle class. Use that type instead.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEBUG_HIGH
static int	DEBUG_LOW
static int	DEBUG_MEDIUM

Method Summary

Modifier and Type	Method and Description
void	addProperty(String name, Object val) add non-Excel property
String	getName() Returns the name of this WorkBook
Object	getProperty(String name) get a non-Excel property
void	reset() Clears all values in a template WorkBook.
void	setDebugLevel(int l) Set the Debugging level.
void	setName(String nm) Sets the internal name of this WorkBookHandle.
void	write(File file) Writes the document to the given file in its native format.
void	write(File file, int format) Writes the document to the given file in the requested format.
void	write(OutputStream dest) Writes the document to the given stream in its native format.
void	write(OutputStream dest, int format) Writes the document to the given stream in the requested format.

Field Detail

DEBUG_LOW

static final int DEBUG_LOW

See Also:

Constant Field Values

DEBUG_MEDIUM

static final int DEBUG_MEDIUM

See Also:

Constant Field Values

DEBUG_HIGH

static final int DEBUG_HIGH

See Also:

Constant Field Values

Method Detail

getProperty

Object getProperty(String name)

get a non-Excel property

Returns:

Returns the properties.

addProperty

void addProperty(String name,
                 Object val)

add non-Excel property

Parameters:

properties - The properties to set.

setName

void setName(String nm)

Sets the internal name of this WorkBookHandle. Overrides the default for 'getName()' which returns the file name source of this WorkBook by default.

Parameters:

WorkBook - Name

setDebugLevel

void setDebugLevel(int l)

Set the Debugging level. Higher values output more debugging info during execution.

getName

String getName()

Returns the name of this WorkBook

Returns:

String name of WorkBook

reset

void reset()

Clears all values in a template WorkBook. Use this method to 'reset' the values of your WorkBook in memory to defaults. For example, if you load a Servlet with a single WorkBookHandle instance, then modify values and stream to a Client system, yo should call 'clearAll()' when the request is completed to remove the modified values and set them back to a default.

write

void write(OutputStream dest,
           int format)
    throws IOException

Writes the document to the given stream in the requested format.

Parameters:

dest - the stream to which the document should be written

format - the constant representing the desired output format

Throws:

IllegalArgumentException - if the given type code is invalid

IOException - if an error occurs while writing to the stream

write

void write(OutputStream dest)
    throws IOException

Writes the document to the given stream in its native format.

Parameters:

dest - the stream to which the document should be written

Throws:

IOException - if an error occurs while writing to the stream

write

void write(File file,
           int format)
    throws IOException

Writes the document to the given file in the requested format.

Parameters:

file - the path to which the document should be written

format - the constant representing the desired output format

Throws:

IllegalArgumentException - if the given type code is invalid

IOException - if an error occurs while writing to the file

write

void write(File file)
    throws IOException

Writes the document to the given file in its native format.

Parameters:

file - the path to which the document should be written

Throws:

IOException - if an error occurs while writing to the stream