com.codename1.rad.models

Class PropertySelector

java.lang.Object

com.codename1.rad.models.PropertySelector

public class PropertySelector
extends Object

A class for retrieving properties from an entity hierarchy in a dynamic way. E.g. If you have an entity that is expected to have a property, which is itself an entity, which has a property that we want to retrieve. This class encapsulates the retrieval of such a sub-property by specifying a "path" to the property.

Author:

shannah

Constructor Summary

Constructors

Constructor and Description
PropertySelector(Entity root, Property property) Creates a new property selector.
PropertySelector(Entity root, Tag... tags) Creates a new property selector
PropertySelector(PropertySelector parent, Property property) Creates a new property selector with the given parent selector.
PropertySelector(PropertySelector parent, Tag... tags) Creates a new property selector with the given parent selector.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(ActionListener<PropertyChangeEvent> l) Adds a change listener on property.
PropertySelector	child(int index, Property prop)
PropertySelector	child(int index, Tag... tags)
PropertySelector	child(Property prop) Alias of createChildSelector(com.codename1.rad.models.Property)
PropertySelector	child(Tag... tags) Alias of #createChildSelector(com.codename1.rad.models.Tag…)
PropertySelector	createChildSelector(int index, Property property)
PropertySelector	createChildSelector(int index, Tag... tags)
PropertySelector	createChildSelector(Property property) Creates a child selector on this property selector.
PropertySelector	createChildSelector(Tag... tags) Creates a child selector for this property selector.
Image	createImageToFile(EncodedImage placeholder) Wrapper for Entity.createImageToFile(com.codename1.rad.models.Property, com.codename1.ui.EncodedImage)
Image	createImageToFile(EncodedImage placeholder, String file) Wrapper for Entity.createImageToFile(com.codename1.rad.models.Property, com.codename1.ui.EncodedImage)
Image	createImageToFile(EncodedImage placeholder, String file, URLImage.ImageAdapter adapter) Wrapper for Entity.createImageToFile(com.codename1.rad.models.Property, com.codename1.ui.EncodedImage)
Image	createImageToFile(EncodedImage placeholder, URLImage.ImageAdapter adapter) Wrapper for Entity.createImageToFile(com.codename1.rad.models.Property, com.codename1.ui.EncodedImage)
Image	createImageToStorage(EncodedImage placeholder) Wrapper for Entity.createImageToFile(com.codename1.rad.models.Tag, com.codename1.ui.EncodedImage)
Image	createImageToStorage(EncodedImage placeholder, String storageFile) Wrapper for Entity.createImageToStorage(com.codename1.rad.models.Property, com.codename1.ui.EncodedImage)
Image	createImageToStorage(EncodedImage placeholder, String storageFile, URLImage.ImageAdapter adapter) Wrapper for createImageToStorage(com.codename1.ui.EncodedImage)
Image	createImageToStorage(EncodedImage placeholder, URLImage.ImageAdapter adapter) Wrapper for Entity.createImageToStorage(com.codename1.rad.models.Property, com.codename1.ui.EncodedImage)
boolean	exists() Checks if the property of this selector exists.
<T> T	get(ContentType<T> type, T defaultValue) Gets the property value as the given type.
<T> T	getAs(Class<T> cls, T defaultValue)
Boolean	getBoolean(boolean defaultVal) Gets the selected property as boolean
Date	getDate(Date defaultVal) Gets the selected property value as Date.
Double	getDouble(double defaultVal) Gets the selected property value as double.
Entity	getEntity(Entity defaultVal) Gets the selected property value as Entity.
EntityList	getEntityList(EntityList defaultVal) Gets the selected property value as EntityList.
Float	getFloat(float defaultVal) Gets the selected property value as float.
Integer	getInt(int defaultVal) Gets the selected property value as int.
Entity	getLeafEntity() Resolves the entity of this property selector.
Property	getLeafProperty() Resolves the property of this property selector.
PropertySelector	getParent() Gets the parent property selector.
PropertySelector	getRoot() Gets the root property selector.
String	getText(String defaultValue) Gets the selected property value as text.
boolean	isEmpty() Checks if property is empty.
boolean	isFalsey() Checks if property is falsey.
static PropertySelector	propertySelector(Entity root, Property prop)
static PropertySelector	propertySelector(Entity root, Tag... tags)
void	removePropertyChangeListener(ActionListener<PropertyChangeEvent> l) Removes property change listener from property.
<T> boolean	set(ContentType<T> type, T value)
boolean	setBoolean(boolean val)
boolean	setDate(Date val)
boolean	setDouble(double val)
boolean	setEntity(Entity val)
boolean	setEntityList(EntityList val)
boolean	setFloat(float val)
boolean	setInt(int val)
boolean	setText(String value)

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertySelector

public PropertySelector(Entity root,
                        Tag... tags)

Creates a new property selector

Parameters:

root - The root entity to select properties on.

tags - The tags to use for property selection.

PropertySelector

public PropertySelector(Entity root,
                        Property property)

Creates a new property selector.

Parameters:

root - The root entity to select properties on.

property - The property to get values from.

PropertySelector

public PropertySelector(PropertySelector parent,
                        Tag... tags)

Creates a new property selector with the given parent selector.

Parameters:

parent - The parent selector

tags - The tags to select from.

PropertySelector

public PropertySelector(PropertySelector parent,
                        Property property)

Creates a new property selector with the given parent selector.

Parameters:

parent - THe parent selector

property - The property.

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(ActionListener<PropertyChangeEvent> l)

Adds a change listener on property.

Parameters:

l - The listener to add.

removePropertyChangeListener

public void removePropertyChangeListener(ActionListener<PropertyChangeEvent> l)

Removes property change listener from property.

Parameters:

l -

set

public <T> boolean set(ContentType<T> type,
                       T value)

getAs

public <T> T getAs(Class<T> cls,
                   T defaultValue)

get

public <T> T get(ContentType<T> type,
                 T defaultValue)

Gets the property value as the given type.

Type Parameters:

T - The type to coerce the property value to.

Parameters:

type - The type to coerce the property value to.

defaultValue - The default value which will be returned if either the property is not found, or is null.

Returns:

createChildSelector

public PropertySelector createChildSelector(Property property)

Creates a child selector on this property selector.

Parameters:

property - The property to select on.

Returns:

The child property selector.

createChildSelector

public PropertySelector createChildSelector(Tag... tags)

Creates a child selector for this property selector.

Parameters:

tags - The tags used to lookup the property in the child selector.

Returns:

The child property selector.

createChildSelector

public PropertySelector createChildSelector(int index,
                                            Property property)

createChildSelector

public PropertySelector createChildSelector(int index,
                                            Tag... tags)

child

public PropertySelector child(Property prop)

Alias of createChildSelector(com.codename1.rad.models.Property)

Parameters:

prop -

Returns:

child

public PropertySelector child(int index,
                              Property prop)

child

public PropertySelector child(Tag... tags)

Alias of #createChildSelector(com.codename1.rad.models.Tag…)

Parameters:

tags -

Returns:

child

public PropertySelector child(int index,
                              Tag... tags)

getText

public String getText(String defaultValue)

Gets the selected property value as text.

Parameters:

defaultValue - The value to return if the property value was null

Returns:

The property value as text.

setText

public boolean setText(String value)

getBoolean

public Boolean getBoolean(boolean defaultVal)

Gets the selected property as boolean

Parameters:

defaultVal - The value to return if the property value was null.

Returns:

The property as boolean.

setBoolean

public boolean setBoolean(boolean val)

getDate

public Date getDate(Date defaultVal)

Gets the selected property value as Date.

Parameters:

defaultVal - The value to return if the property value was null

Returns:

The property value as date.

setDate

public boolean setDate(Date val)

getEntity

public Entity getEntity(Entity defaultVal)

Gets the selected property value as Entity.

Parameters:

defaultVal - The value to return if the property value was null

Returns:

The property value as entity.

setEntity

public boolean setEntity(Entity val)

getEntityList

public EntityList getEntityList(EntityList defaultVal)

Gets the selected property value as EntityList.

Parameters:

defaultVal - The value to return if the property value was null

Returns:

The property value as EntityList.

setEntityList

public boolean setEntityList(EntityList val)

getFloat

public Float getFloat(float defaultVal)

Gets the selected property value as float.

Parameters:

defaultVal - The value to return if the property value was null

Returns:

The property value as float.

setFloat

public boolean setFloat(float val)

getDouble

public Double getDouble(double defaultVal)

Gets the selected property value as double.

Parameters:

defaultVal - The value to return if the property value was null

Returns:

The property value as double.

setDouble

public boolean setDouble(double val)

getInt

public Integer getInt(int defaultVal)

Gets the selected property value as int.

Parameters:

defaultVal - The value to return if the property value was null

Returns:

The property value as int.

setInt

public boolean setInt(int val)

isEmpty

public boolean isEmpty()

Checks if property is empty.

Returns:

isFalsey

public boolean isFalsey()

Checks if property is falsey.

Returns:

createImageToStorage

public Image createImageToStorage(EncodedImage placeholder,
                                  URLImage.ImageAdapter adapter)

Wrapper for Entity.createImageToStorage(com.codename1.rad.models.Property, com.codename1.ui.EncodedImage)

Parameters:

placeholder -

adapter -

Returns:

Image

createImageToStorage

public Image createImageToStorage(EncodedImage placeholder)

Wrapper for Entity.createImageToFile(com.codename1.rad.models.Tag, com.codename1.ui.EncodedImage)

Parameters:

placeholder -

Returns:

createImageToStorage

public Image createImageToStorage(EncodedImage placeholder,
                                  String storageFile)

Wrapper for Entity.createImageToStorage(com.codename1.rad.models.Property, com.codename1.ui.EncodedImage)

Parameters:

placeholder -

storageFile -

Returns:

createImageToStorage

public Image createImageToStorage(EncodedImage placeholder,
                                  String storageFile,
                                  URLImage.ImageAdapter adapter)

Wrapper for createImageToStorage(com.codename1.ui.EncodedImage)

Parameters:

placeholder -

storageFile -

adapter -

Returns:

createImageToFile

public Image createImageToFile(EncodedImage placeholder,
                               URLImage.ImageAdapter adapter)

Wrapper for Entity.createImageToFile(com.codename1.rad.models.Property, com.codename1.ui.EncodedImage)

Parameters:

placeholder -

adapter -

Returns:

createImageToFile

public Image createImageToFile(EncodedImage placeholder)

Wrapper for Entity.createImageToFile(com.codename1.rad.models.Property, com.codename1.ui.EncodedImage)

Parameters:

placeholder -

Returns:

createImageToFile

public Image createImageToFile(EncodedImage placeholder,
                               String file)

Wrapper for Entity.createImageToFile(com.codename1.rad.models.Property, com.codename1.ui.EncodedImage)

Parameters:

placeholder -

file -

Returns:

createImageToFile

public Image createImageToFile(EncodedImage placeholder,
                               String file,
                               URLImage.ImageAdapter adapter)

Wrapper for Entity.createImageToFile(com.codename1.rad.models.Property, com.codename1.ui.EncodedImage)

Parameters:

placeholder -

file -

adapter -

Returns:

getLeafProperty

public Property getLeafProperty()

Resolves the property of this property selector.

Returns:

The property resolved by this property selector.

getLeafEntity

public Entity getLeafEntity()

Resolves the entity of this property selector.

Returns:

The entity of this property selector.

getParent

public PropertySelector getParent()

Gets the parent property selector.

Returns:

The parent property selector.

getRoot

public PropertySelector getRoot()

Gets the root property selector. If this selector is the root selector, then this will just return itself. It it is a child selector, it will walk up its parent tree until it reaches the root.

Returns:

exists

public boolean exists()

Checks if the property of this selector exists.

Returns:

propertySelector

public static PropertySelector propertySelector(Entity root,
                                                Property prop)

propertySelector

public static PropertySelector propertySelector(Entity root,
                                                Tag... tags)