com.lf.commons.io.ds

Class ConfigurationDataSource

java.lang.Object

com.lf.commons.io.AbstractDataSource

com.lf.commons.io.ds.ConfigurationDataSource

All Implemented Interfaces:

ConfigurableUnit, javax.activation.DataSource

public class ConfigurationDataSource
extends AbstractDataSource
implements ConfigurableUnit

Data source implementation representing Configuration objects.

Since:

1.6

Version:

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

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
protected Configuration	config The managed content.
protected ApplicationModel	model The application model.
static java.lang.String	PROP_COMMENT Represents a format specific property (String).
static java.lang.String	PROP_COMPRESSION Represents a format specific property (String).
static java.lang.String	PROP_FORMAT Represents a format specific property (String).
static java.lang.String	PROP_ORDERED Represents a format specific property (Boolean).
static java.lang.String	PROP_SECURE Represents a format specific property (Boolean).
static java.lang.String	PROP_SORTING Represents a format specific property (Boolean).

Fields inherited from class com.lf.commons.io.AbstractDataSource

action, ACTION_FILE_EDIT, ACTION_FILE_HEXEDIT, ACTION_FILE_OPEN, ACTION_UNKNOWN, ACTION_URL_EDIT, ACTION_URL_HEXEDIT, ACTION_URL_OPEN, date, encoding, formatProps, name, path, size, type

Constructor Summary

Constructors

Constructor and Description
ConfigurationDataSource() Constructor method for i18n purposes only.
ConfigurationDataSource(java.lang.String name, java.lang.String path, java.util.Date date, java.lang.String type, Configuration config, int action) Init functionality.

Method Summary

Methods

Modifier and Type	Method and Description
void	configureUnit(java.lang.String id, Configuration config) Restores values from persistent data stores.
void	finish(java.io.OutputStream ostream) After the data has been written to the output stream it is flushed, closed and updated here.
Configuration	getConfiguration() Provides a Configuration object.
OrderedHashtable<java.lang.String,java.lang.String>	getFormatProperties() Provides the format specific properties presented by the AbstractViewer class.
javax.swing.Icon	getIcon() Provides the data source specific icon (optional).
java.io.InputStream	getInputStream() This method returns an InputStream representing the data and throws the appropriate exception if it can not do so.
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.
void	storeUnit(java.lang.String id, Configuration config) Stores the current configuration values persistently.
void	unitRegistered(ApplicationModel model, java.lang.String id) Informs the configurable unit that it was registered with a model.
void	unitUnregistered(ApplicationModel model, java.lang.String id) Informs the configurable unit that it was unregistered with a model.

Methods inherited from class com.lf.commons.io.AbstractDataSource

finalize, getAction, getContentType, getDate, getDisplayAction, getEncoding, getName, getPath, getSize, loadTemporaryFile, setAction, setContentType, setDate, setEncoding, setFormatProperty, setName, setPath, setSize, storeTemporaryFile

Methods inherited from class java.lang.Object

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

Field Detail

PROP_FORMAT

public static final java.lang.String PROP_FORMAT

Represents a format specific property (String).

PROP_COMMENT

public static final java.lang.String PROP_COMMENT

Represents a format specific property (String).

PROP_COMPRESSION

public static final java.lang.String PROP_COMPRESSION

Represents a format specific property (String).

PROP_SORTING

public static final java.lang.String PROP_SORTING

Represents a format specific property (Boolean).

PROP_ORDERED

public static final java.lang.String PROP_ORDERED

Represents a format specific property (Boolean).

PROP_SECURE

public static final java.lang.String PROP_SECURE

Represents a format specific property (Boolean).

config

protected Configuration config

The managed content.

model

protected ApplicationModel model

The application model.

Constructor Detail

ConfigurationDataSource

public ConfigurationDataSource()

Constructor method for i18n purposes only.

Since:

1.6

ConfigurationDataSource

public ConfigurationDataSource(java.lang.String name,
                       java.lang.String path,
                       java.util.Date date,
                       java.lang.String type,
                       Configuration config,
                       int action)

Init functionality.

Parameters:

name - The name of the represented data portion (optional)

path - The path of this object (optional)

date - The date of this object (optional)

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

config - The managed content

action - The load action AbstractDataSource.FILE_OPEN, ...

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

Method Detail

getInputStream

public 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

Specified by:

getInputStream in class AbstractDataSource

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 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

Specified by:

getOutputStream in class AbstractDataSource

Returns:

An output stream

Throws:

java.io.IOException - If an error occurred

Since:

1.6

finish

public 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.

Specified by:

finish in class AbstractDataSource

Parameters:

ostream - An output stream

Throws:

java.io.IOException - If an error occurred

Since:

1.6

getFormatProperties

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

Provides the format specific properties presented by the AbstractViewer class.

Overrides:

getFormatProperties in class AbstractDataSource

Returns:

The container, may be null or empty

Since:

1.6

getConfiguration

public Configuration getConfiguration()

Provides a Configuration object.

Returns:

A variables container, may be null

Since:

1.6

getIcon

public javax.swing.Icon getIcon()

Provides the data source specific icon (optional).

Specified by:

getIcon in class AbstractDataSource

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.

Specified by:

configureUnit in interface ConfigurableUnit

Overrides:

configureUnit in class AbstractDataSource

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.

Specified by:

storeUnit in interface ConfigurableUnit

Overrides:

storeUnit in class AbstractDataSource

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

unitRegistered

public void unitRegistered(ApplicationModel model,
                  java.lang.String id)

Informs the configurable unit that it was registered with a model.

Specified by:

unitRegistered in interface ConfigurableUnit

Parameters:

model - The application model

id - The unique identifier for the instance

Since:

1.6

unitUnregistered

public void unitUnregistered(ApplicationModel model,
                    java.lang.String id)

Informs the configurable unit that it was unregistered with a model.

Specified by:

unitUnregistered in interface ConfigurableUnit

Parameters:

model - The application model

id - The unique identifier for the instance

Since:

1.6