com.lf.commons.io

Class AbstractDataSource

java.lang.Object

com.lf.commons.io.AbstractDataSource

All Implemented Interfaces:

javax.activation.DataSource

Direct Known Subclasses:

BinaryDataSource, ConfigurationDataSource, FileDataSource, ImageDataSource, PropertiesDataSource, TextDataSource, URLDataSource, XMLMessageDataSource

public abstract class AbstractDataSource
extends java.lang.Object
implements javax.activation.DataSource

Data source implementation representing arbitrary binary data.

Subclasses can either be populated directly by settings the binary data or delayed using the getOutputStream() method.

Since:

1.6

Version:

$Revision: 1.14 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
protected int	action The load action of the resource FILE_OPEN, ...
static int	ACTION_FILE_EDIT Represents editing a local file.
static int	ACTION_FILE_HEXEDIT Represents editing a local file.
static int	ACTION_FILE_OPEN Represents opening a local file.
static int	ACTION_UNKNOWN Represents not available.
static int	ACTION_URL_EDIT Represents editing a network file.
static int	ACTION_URL_HEXEDIT Represents editing a network file.
static int	ACTION_URL_OPEN Represents opening a network file.
protected java.util.Date	date The date and time of the represented data portion.
protected java.lang.String	encoding The character set of the represented data portion.
protected OrderedHashtable<java.lang.String,java.lang.String>	formatProps The format specific properties presented by the AbstractViewer class.
protected java.lang.String	name The name of the represented data portion.
protected java.lang.String	path The path of the represented data portion.
protected long	size The size of the represented data portion.
protected java.lang.String	type The MIME type (default is "application/octet-stream").

Constructor Summary

Constructors

Constructor and Description
AbstractDataSource() Constructor method for i18n purposes only.

Method Summary

Methods

Modifier and Type	Method and Description
void	configureUnit(java.lang.String id, Configuration config) Restores values from persistent data stores.
protected void	finalize() Clean-up method to help the gc.
abstract void	finish(java.io.OutputStream ostream) After the data has been written to the output stream it is flushed, closed and updated here.
int	getAction() Provides the load action of the resource FILE_OPEN, ...
java.lang.String	getContentType() This method returns the MIME type of the data in the form of a string.
java.util.Date	getDate() Provides the date and time for this data source.
java.lang.String	getDisplayAction(java.lang.String fallback) Provides the load action of the resource to be displayed.
java.lang.String	getEncoding() Provides the encoding of this data source.
OrderedHashtable<java.lang.String,java.lang.String>	getFormatProperties() Provides the format specific properties presented by the AbstractViewer class.
abstract javax.swing.Icon	getIcon() Provides the data source specific icon (optional).
abstract java.io.InputStream	getInputStream() This method returns an InputStream representing the data and throws the appropriate exception if it can not do so.
java.lang.String	getName() Return the name of this object where the name of the object is dependant on the nature of the underlying objects.
abstract java.io.OutputStream	getOutputStream() This method returns an OutputStream where the data can be written and throws the appropriate exception if it can not do so Note that a new OutputStream object must be returned each time this method is called, and the stream must be positioned at the location the data is to be written.
java.lang.String	getPath() Provides the path for this data source.
long	getSize() Provides the size for this data source in bytes.
void	loadTemporaryFile(java.lang.String id, Configuration config, ApplicationModel model) Restores values from persistent data stores.
void	setAction(int action) Setter for the the load action of the resource FILE_OPEN, ...
void	setContentType(java.lang.String type) Setter for the MIME content type.
void	setDate(java.util.Date date) Setter for the date.
void	setEncoding(java.lang.String encoding) Setter for the encoding of this data source.
protected void	setFormatProperty(java.lang.String prop, java.lang.String value) Add another format specific property to provide for this data source.
void	setName(java.lang.String name) Setter for the name.
void	setPath(java.lang.String path) Setter for the path.
void	setSize(long size) Setter for the size.
void	storeTemporaryFile(java.lang.String id, Configuration config, ApplicationModel model) Stores the current configuration values persistently.
void	storeUnit(java.lang.String id, Configuration config) Stores the current configuration values persistently.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ACTION_UNKNOWN

public static final int ACTION_UNKNOWN

Represents not available.

See Also:

Constant Field Values

ACTION_FILE_OPEN

public static final int ACTION_FILE_OPEN

Represents opening a local file.

See Also:

Constant Field Values

ACTION_FILE_EDIT

public static final int ACTION_FILE_EDIT

Represents editing a local file.

See Also:

Constant Field Values

ACTION_FILE_HEXEDIT

public static final int ACTION_FILE_HEXEDIT

Represents editing a local file.

See Also:

Constant Field Values

ACTION_URL_OPEN

public static final int ACTION_URL_OPEN

Represents opening a network file.

See Also:

Constant Field Values

ACTION_URL_EDIT

public static final int ACTION_URL_EDIT

Represents editing a network file.

See Also:

Constant Field Values

ACTION_URL_HEXEDIT

public static final int ACTION_URL_HEXEDIT

Represents editing a network file.

See Also:

Constant Field Values

name

protected java.lang.String name

The name of the represented data portion.

path

protected java.lang.String path

The path of the represented data portion.

size

protected long size

The size of the represented data portion.

date

protected java.util.Date date

The date and time of the represented data portion.

type

protected java.lang.String type

The MIME type (default is "application/octet-stream").

encoding

protected java.lang.String encoding

The character set of the represented data portion.

action

protected int action

The load action of the resource FILE_OPEN, ...

formatProps

protected OrderedHashtable<java.lang.String,java.lang.String> formatProps

The format specific properties presented by the AbstractViewer class.

Constructor Detail

AbstractDataSource

public AbstractDataSource()

Constructor method for i18n purposes only.

Since:

1.6

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Clean-up method to help the gc.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

Since:

1.6

getName

public java.lang.String getName()

Return the name of this object where the name of the object is dependant on the nature of the underlying objects.

DataSources encapsulating files may choose to return the filename of the object. (Typically this would be the last component of the filename, not an entire pathname.)

Specified by:

getName in interface javax.activation.DataSource

Returns:

The name of the object

Since:

1.6

getPath

public java.lang.String getPath()

Provides the path for this data source.

Returns:

The path

Since:

1.6

getSize

public long getSize()

Provides the size for this data source in bytes.

Returns:

The size

Since:

1.6

getDate

public java.util.Date getDate()

Provides the date and time for this data source.

Returns:

The date

Since:

1.6

getContentType

public java.lang.String getContentType()

This method returns the MIME type of the data in the form of a string.

It is suggested that getContentType return "application/octet-stream" if the DataSource implementation can not determine the data type.

Specified by:

getContentType in interface javax.activation.DataSource

Returns:

The MIME type (default is "application/octet-stream")

Since:

1.6

getEncoding

public java.lang.String getEncoding()

Provides the encoding of this data source.

Returns:

The encoding, may be null

Since:

1.6

getAction

public int getAction()

Provides the load action of the resource FILE_OPEN, ...

Returns:

The action, -1 if unknown

Since:

1.6

getDisplayAction

public java.lang.String getDisplayAction(java.lang.String fallback)

Provides the load action of the resource to be displayed.

Parameters:

fallback - The default

Returns:

The display action, fallback otherwise

Since:

1.6

setName

public void setName(java.lang.String name)

Setter for the name.

Parameters:

name - The name of the object

Since:

1.6

setPath

public void setPath(java.lang.String path)

Setter for the path.

Parameters:

path - The path of the object

Since:

1.6

setSize

public void setSize(long size)

Setter for the size.

Parameters:

size - The size of the object

Since:

1.6

setDate

public void setDate(java.util.Date date)

Setter for the date.

Parameters:

date - The date of the object

Since:

1.6

setContentType

public void setContentType(java.lang.String type)

Setter for the MIME content type.

Parameters:

type - The type of the object

Since:

1.6

setEncoding

public void setEncoding(java.lang.String encoding)

Setter for the encoding of this data source.

Parameters:

encoding - The encoding, may be null

Since:

1.6

setAction

public void setAction(int action)

Setter for the the load action of the resource FILE_OPEN, ...

Parameters:

action - The action, -1 if unknown

Since:

1.6

getInputStream

public abstract java.io.InputStream getInputStream()
                                            throws java.io.IOException

This method returns an InputStream representing the data and throws the appropriate exception if it can not do so.

Note that a new InputStream object must be returned each time this method is called, and the stream must be positioned at the beginning of the data.

Specified by:

getInputStream in interface javax.activation.DataSource

Returns:

An input stream

Throws:

java.io.IOException - If an error occurred

java.lang.NullPointerException - If the loaded content is null

Since:

1.6

getOutputStream

public abstract java.io.OutputStream getOutputStream()
                                              throws java.io.IOException

This method returns an OutputStream where the data can be written and throws the appropriate exception if it can not do so

Note that a new OutputStream object must be returned each time this method is called, and the stream must be positioned at the location the data is to be written.

Specified by:

getOutputStream in interface javax.activation.DataSource

Returns:

An output stream

Throws:

java.io.IOException - If an error occurred

Since:

1.6

finish

public abstract void finish(java.io.OutputStream ostream)
                     throws java.io.IOException

After the data has been written to the output stream it is flushed, closed and updated here.

Parameters:

ostream - An output stream

Throws:

java.io.IOException - If an error occurred

Since:

1.6

setFormatProperty

protected void setFormatProperty(java.lang.String prop,
                     java.lang.String value)

Add another format specific property to provide for this data source.

Parameters:

prop - The property

value - The value

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

getFormatProperties

public OrderedHashtable<java.lang.String,java.lang.String> getFormatProperties()

Provides the format specific properties presented by the AbstractViewer class.

Returns:

The container, may be empty

Since:

1.6

getIcon

public abstract javax.swing.Icon getIcon()

Provides the data source specific icon (optional).

Returns:

An icon, may be null

Since:

1.6

configureUnit

public void configureUnit(java.lang.String id,
                 Configuration config)

Restores values from persistent data stores.

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

storeUnit

public void storeUnit(java.lang.String id,
             Configuration config)

Stores the current configuration values persistently.

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

loadTemporaryFile

public void loadTemporaryFile(java.lang.String id,
                     Configuration config,
                     ApplicationModel model)

Restores values from persistent data stores.

Parameters:

id - The unique identifier for the instance

config - The configuration

model - The application model

Since:

1.6

storeTemporaryFile

public void storeTemporaryFile(java.lang.String id,
                      Configuration config,
                      ApplicationModel model)

Stores the current configuration values persistently.

Parameters:

id - The unique identifier for the instance

config - The configuration

model - The application model

Since:

1.6