Key
Type
Required
Default
Description
target
any
Yes
---
The target to populate
JSONString
string
Yes
---
The JSON string to populate the object with. It has to be valid JSON and also a structure with name-key value pairs.
scope
string
No
Use scope injection instead of setters population. Ex: scope=variables.instance.
trustedSetter
boolean
No
false
If set to true, the setter method will be called even if it does not exist in the bean
include
string
No
A list of keys to include in the population
exclude
string
No
A list of keys to exclude in the population
ignoreEmpty
boolean
No
false
Ignore empty values on populations, great for ORM population
nullEmptyInclude
string
No
A list of keys to NULL when empty
nullEmptyExclude
string
No
A list of keys to NOT NULL when empty
composeRelationships
boolean
No
false
Automatically attempt to compose relationships from memento
Key
Type
Required
Default
Description
target
any
Yes
---
The target to populate
qry
query
yes
---
The query to populate the bean object with
rowNumber
Numeric
No
1
The query row number to use for population
scope
string
No
Use scope injection instead of setters population. Ex: scope=variables.instance.
trustedSetter
boolean
No
false
If set to true, the setter method will be called even if it does not exist in the bean
include
string
No
A list of keys to include in the population
exclude
string
No
A list of keys to exclude in the population
ignoreEmpty
boolean
No
false
Ignore empty values on populations, great for ORM population
nullEmptyInclude
string
No
A list of keys to NULL when empty
nullEmptyExclude
string
No
A list of keys to NOT NULL when empty
composeRelationships
boolean
No
false
Automatically attempt to compose relationships from memento
Key
Type
Required
Default
Description
target
any
Yes
---
The target to populate
xml
any
Yes
---
The XML string or packet
root
string
No
The XML root element to start from
scope
string
No
Use scope injection instead of setters population. Ex: scope=variables.instance.
trustedSetter
boolean
No
false
If set to true, the setter method will be called even if it does not exist in the bean
include
string
No
A list of keys to include in the population
exclude
string
No
A list of keys to exclude in the population
ignoreEmpty
boolean
No
false
Ignore empty values on populations, great for ORM population
nullEmptyInclude
string
No
A list of keys to NULL when empty
nullEmptyExclude
string
No
A list of keys to NOT NULL when empty
composeRelationships
boolean
No
false
Automatically attempt to compose relationships from memento
Key
Type
Required
Default
Description
target
any
Yes
---
This can be an instantiated bean object or a bean instantiation path as a string. If you pass an instantiation path and the bean has an 'init' method. It will be executed. This method follows the bean contract (set{property_name}). Example: setUsername(), setfname()
qry
query
yes
---
The query to populate the bean object with
rowNumber
Numeric
No
1
The query row number to use for population
scope
string
No
Use scope injection instead of setters population. Ex: scope=variables.instance.
trustedSetter
boolean
No
false
If set to true, the setter method will be called even if it does not exist in the bean
include
string
No
A list of keys to include in the population
exclude
string
No
A list of keys to exclude in the population
prefix
string
Yes
---
The prefix used to filter, Example: 'user_' would apply to the following columns: 'user_id' and 'user_name' but not 'address_id'.
ignoreEmpty
boolean
No
false
Ignore empty values on populations, great for ORM population
nullEmptyInclude
string
No
A list of keys to NULL when empty
nullEmptyExclude
string
No
A list of keys to NOT NULL when empty
composeRelationships
boolean
No
false
Automatically attempt to compose relationships from memento
WireBox also comes packaged with our handy object populator that has been so successful in our ColdBox applications. The object populator object can populate objects with data from XML, JSON, WDDX, structures, queries and much more. So we highly encourage you to check it out as it will really help out in your applications.
The way to retrieve it is to use the getObjectPopulator() method on the injector and then call one of our populate methods on the object. You can also use the wirebox:populator injection DSL to retrieve it.
Key
Type
Required
Default
Description
target
any
Yes
---
The target to populate
memento
struct
yes
---
The structure to populate the object with.
scope
string
No
Use scope injection instead of setters population. Ex: scope=variables.instance.
trustedSetter
boolean
No
false
If set to true, the setter method will be called even if it does not exist in the bean
include
string
No
A list of keys to include in the population
exclude
string
No
A list of keys to exclude in the population
ignoreEmpty
boolean
No
false
Ignore empty values on populations, great for ORM population
nullEmptyInclude
string
No
A list of keys to NULL when empty
nullEmptyExclude
string
No
A list of keys to NOT NULL when empty
composeRelationships
boolean
No
false
Automatically attempt to compose relationships from memento