com.docmosis.template.population
Class NestingDataProvider

java.lang.Object
  com.docmosis.template.population.NestingDataProvider

All Implemented Interfaces:

Cleanable, DataProvider, MutableDataProvider

public class NestingDataProvider
extends Object
implements MutableDataProvider, Cleanable

Constructor Summary

NestingDataProvider(DataProvider delegate)

NestingDataProvider(DataProvider delegate, MutableDataProviderFactory dpFactory)

Method Summary

void	addDataProvider(String key, DataProvider dataProvider)
static void	addDataProvider(String key, DataProvider dp, MutableDataProvider building, MutableDataProviderFactory dpFactory)
void	cleanup() Perform any cleanup duties such as freeing resources.
boolean	getBoolean(String key) Determine if the given key hs been set to true.
DataProvider	getDataProvider(String key, int index) Get the data provider contained within this data provider with the given key as a name, and an index.
int	getDataProviderCount(String key) Return the number of data providers contained within this data provider with the given key as a name.
InputStream	getImage(String key) Get an InputStream over the image with the given key.
String	getString(String key) Get the value for the given key
boolean	hasBooleanKey(String key) Determine if a value for the boolean key has been specified
boolean	hasDataProviderKey(String key) Determine if a data provider for the key has been specified (even if null)
boolean	hasImageKey(String key) Determine if the given image has been set (even if to null)
boolean	hasStringKey(String key) Determine if the given string has been set (even if to null)
void	setBoolean(String key, boolean value)
void	setDataFormatter(Class type, DataFormatter formatter)
void	setDateFormat(SimpleDateFormat format)
void	setDateFormat(String format)
void	setFalse(String key)
void	setImage(String key, File file)
static void	setImage(String key, File file, MutableDataProvider building, MutableDataProviderFactory dpFactory)
void	setImage(String key, InputStream inputStream)
static void	setImage(String key, InputStream inputStream, MutableDataProvider building, MutableDataProviderFactory dpFactory)
void	setString(String key, String value)
static void	setString(String key, String value, MutableDataProvider building, MutableDataProviderFactory dpFactory)
void	setTrue(String key)
String	toDebugString(int level)
String	toString()
String	toStringPretty() Attempt to return a pretty String representation of the DataProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

NestingDataProvider

public NestingDataProvider(DataProvider delegate)

NestingDataProvider

public NestingDataProvider(DataProvider delegate,
                           MutableDataProviderFactory dpFactory)

Method Detail

getBoolean

public boolean getBoolean(String key)

Description copied from interface: DataProvider

Determine if the given key hs been set to true.

Specified by:

getBoolean in interface DataProvider

Parameters:

key - the key to lookup

Returns:

false if the key is not set or has not been set to true

getDataProvider

public DataProvider getDataProvider(String key,
                                    int index)

Description copied from interface: DataProvider

Get the data provider contained within this data provider with the given key as a name, and an index.

Specified by:

getDataProvider in interface DataProvider

Parameters:

key - the key (name) of the data provider to look for.

index - the index of the data provider.

Returns:

a data provider.

getDataProviderCount

public int getDataProviderCount(String key)

Description copied from interface: DataProvider

Return the number of data providers contained within this data provider with the given key as a name.

Specified by:

getDataProviderCount in interface DataProvider

Parameters:

key - the key (name) of the data providers to look for.

Returns:

the number of data providers.

getImage

public InputStream getImage(String key)

Description copied from interface: DataProvider

Get an InputStream over the image with the given key. The stream will be closed by the consumer when finished. Document generation may request the same image more than once (even if the stream has been partially read).

Specified by:

getImage in interface DataProvider

Parameters:

key - the key under which to locate the image.

Returns:

null if the image cannot be found

getString

public String getString(String key)

Description copied from interface: DataProvider

Get the value for the given key

Specified by:

getString in interface DataProvider

Parameters:

key - the to look up the value

Returns:

the String value or null

hasBooleanKey

public boolean hasBooleanKey(String key)

Description copied from interface: DataProvider

Determine if a value for the boolean key has been specified

Specified by:

hasBooleanKey in interface DataProvider

Parameters:

key - the key to lookup

Returns:

true if the boolean value has been set, regardless of what the value is.

hasDataProviderKey

public boolean hasDataProviderKey(String key)

Description copied from interface: DataProvider

Determine if a data provider for the key has been specified (even if null)

Specified by:

hasDataProviderKey in interface DataProvider

Parameters:

key - the key with which to lookup the data provider

Returns:

true if a data provider has been set for the given key, even if null

hasImageKey

public boolean hasImageKey(String key)

Description copied from interface: DataProvider

Determine if the given image has been set (even if to null)

Specified by:

hasImageKey in interface DataProvider

Parameters:

key - the key for the String

Returns:

true if the key has been set.

hasStringKey

public boolean hasStringKey(String key)

Description copied from interface: DataProvider

Determine if the given string has been set (even if to null)

Specified by:

hasStringKey in interface DataProvider

Parameters:

key - the key for the String

Returns:

true if the key has been set.

addDataProvider

public void addDataProvider(String key,
                            DataProvider dataProvider)

Specified by:

addDataProvider in interface MutableDataProvider

addDataProvider

public static void addDataProvider(String key,
                                   DataProvider dp,
                                   MutableDataProvider building,
                                   MutableDataProviderFactory dpFactory)

setBoolean

public void setBoolean(String key,
                       boolean value)

Specified by:

setBoolean in interface MutableDataProvider

setImage

public void setImage(String key,
                     File file)

Specified by:

setImage in interface MutableDataProvider

setImage

public static void setImage(String key,
                            File file,
                            MutableDataProvider building,
                            MutableDataProviderFactory dpFactory)

setImage

public void setImage(String key,
                     InputStream inputStream)

Specified by:

setImage in interface MutableDataProvider

setImage

public static void setImage(String key,
                            InputStream inputStream,
                            MutableDataProvider building,
                            MutableDataProviderFactory dpFactory)

setString

public void setString(String key,
                      String value)

Specified by:

setString in interface MutableDataProvider

setString

public static void setString(String key,
                             String value,
                             MutableDataProvider building,
                             MutableDataProviderFactory dpFactory)

setTrue

public void setTrue(String key)

Specified by:

setTrue in interface MutableDataProvider

setFalse

public void setFalse(String key)

Specified by:

setFalse in interface MutableDataProvider

cleanup

public void cleanup()

Description copied from interface: Cleanable

Perform any cleanup duties such as freeing resources. This method should be able to be called multiple times and should not throw exceptions.

Specified by:

cleanup in interface Cleanable

setDataFormatter

public void setDataFormatter(Class type,
                             DataFormatter formatter)

setDateFormat

public void setDateFormat(String format)

setDateFormat

public void setDateFormat(SimpleDateFormat format)

toString

public String toString()

Overrides:

toString in class Object

toDebugString

public String toDebugString(int level)

toStringPretty

public String toStringPretty()

Description copied from interface: DataProvider

Attempt to return a pretty String representation of the DataProvider

Specified by:

toStringPretty in interface DataProvider

Returns:

the String value or null