|
Docmosis API 4.5.0 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.docmosis.template.population.NestingDataProvider
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()
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public NestingDataProvider(DataProvider delegate)
public NestingDataProvider(DataProvider delegate, MutableDataProviderFactory dpFactory)
Method Detail |
public boolean getBoolean(String key)
DataProvider
getBoolean
in interface DataProvider
key
- the key to lookup
public DataProvider getDataProvider(String key, int index)
DataProvider
getDataProvider
in interface DataProvider
key
- the key (name) of the data provider to look for.index
- the index of the data provider.
public int getDataProviderCount(String key)
DataProvider
getDataProviderCount
in interface DataProvider
key
- the key (name) of the data providers to look for.
public InputStream getImage(String key)
DataProvider
getImage
in interface DataProvider
key
- the key under which to locate the image.
public String getString(String key)
DataProvider
getString
in interface DataProvider
key
- the to look up the value
public boolean hasBooleanKey(String key)
DataProvider
hasBooleanKey
in interface DataProvider
key
- the key to lookup
public boolean hasDataProviderKey(String key)
DataProvider
hasDataProviderKey
in interface DataProvider
key
- the key with which to lookup the data provider
public boolean hasImageKey(String key)
DataProvider
hasImageKey
in interface DataProvider
key
- the key for the String
public boolean hasStringKey(String key)
DataProvider
hasStringKey
in interface DataProvider
key
- the key for the String
public void addDataProvider(String key, DataProvider dataProvider)
addDataProvider
in interface MutableDataProvider
public static void addDataProvider(String key, DataProvider dp, MutableDataProvider building, MutableDataProviderFactory dpFactory)
public void setBoolean(String key, boolean value)
setBoolean
in interface MutableDataProvider
public void setImage(String key, File file)
setImage
in interface MutableDataProvider
public static void setImage(String key, File file, MutableDataProvider building, MutableDataProviderFactory dpFactory)
public void setImage(String key, InputStream inputStream)
setImage
in interface MutableDataProvider
public static void setImage(String key, InputStream inputStream, MutableDataProvider building, MutableDataProviderFactory dpFactory)
public void setString(String key, String value)
setString
in interface MutableDataProvider
public static void setString(String key, String value, MutableDataProvider building, MutableDataProviderFactory dpFactory)
public void setTrue(String key)
setTrue
in interface MutableDataProvider
public void setFalse(String key)
setFalse
in interface MutableDataProvider
public void cleanup()
Cleanable
cleanup
in interface Cleanable
public void setDataFormatter(Class type, DataFormatter formatter)
public void setDateFormat(String format)
public void setDateFormat(SimpleDateFormat format)
public String toString()
public String toDebugString(int level)
|
Docmosis API 4.5.0 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |