com.codename1.rad.models

Class SimpleEntityWrapper

java.lang.Object

com.codename1.rad.models.SimpleEntityWrapper

All Implemented Interfaces:

Entity, EntityWrapper

public class SimpleEntityWrapper
extends Object
implements Entity

Field Summary

Fields

Modifier and Type	Field and Description
protected Entity	entity

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimpleEntityWrapper(Entity entity)

Method Summary

Modifier and Type	Method and Description
void	add(Property prop, Entity value) Adds an item to the given property.
void	addPropertyChangeListener(ActionListener<PropertyChangeEvent> l) Adds a listener to listen to all property changes on all properties.
void	addPropertyChangeListener(Property property, ActionListener<PropertyChangeEvent> l) Adds a listener to be notified of changes to the given property.
void	addVetoablePropertyChangeListener(ActionListener<VetoablePropertyChangeEvent> l) Adds a listener to listen to all property changes on all properties.
void	addVetoablePropertyChangeListener(Property property, ActionListener<VetoablePropertyChangeEvent> l) Adds a listener to be notified of changes to the given property.
<T> boolean	as(Class<T> cls, SuccessCallback<T> callback)
Image	createImageToFile(Property prop, EncodedImage placeholder) Creates an image for a given property to file system.
Image	createImageToFile(Property prop, EncodedImage placeholder, String file) Creates an image for a given property to file system.This behaves similarly to the URLImage.createToFileSystem(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String, com.codename1.ui.URLImage.ImageAdapter) except the URL is retrieved from the entity’s property, instead of as a parameter.
Image	createImageToFile(Property prop, EncodedImage placeholder, String file, URLImage.ImageAdapter adapter) Creates an image for a given property to file system.This behaves similarly to the URLImage.createToFileSystem(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String, com.codename1.ui.URLImage.ImageAdapter) except the URL is retrieved from the entity’s property, instead of as a parameter.
Image	createImageToFile(Property prop, EncodedImage placeholder, URLImage.ImageAdapter adapter) Creates an image for a given property to file system.
Image	createImageToFile(Tag tag, EncodedImage placeholder) Creates an image for a given property to file system.
Image	createImageToFile(Tag tag, EncodedImage placeholder, String file) Creates an image for a given property to file system.This behaves similarly to the URLImage.createToFileSystem(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String, com.codename1.ui.URLImage.ImageAdapter) except the URL is retrieved from the entity’s property, instead of as a parameter.
Image	createImageToFile(Tag tag, EncodedImage placeholder, String file, URLImage.ImageAdapter adapter) Creates an image for a given property to file system.This behaves similarly to the URLImage.createToFileSystem(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String, com.codename1.ui.URLImage.ImageAdapter) except the URL is retrieved from the entity’s property, instead of as a parameter.
Image	createImageToFile(Tag tag, EncodedImage placeholder, URLImage.ImageAdapter adapter) Creates an image for a given property to file system.
Image	createImageToStorage(Property prop, EncodedImage placeholder) Creates an image to storage on the given property.
Image	createImageToStorage(Property prop, EncodedImage placeholder, String storageFile) Creates an image to storage on the given property.This behaves similarly to the URLImage.createToStorage(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String) except the URL is retrieved from the entity’s property, instead of as a parameter.
Image	createImageToStorage(Property prop, EncodedImage placeholder, String storageFile, URLImage.ImageAdapter adapter) Creates an image to storage on the given property.This behaves similarly to the URLImage.createToStorage(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String) except the URL is retrieved from the entity’s property, instead of as a parameter.
Image	createImageToStorage(Property prop, EncodedImage placeholder, URLImage.ImageAdapter adapter) Creates an image to storage on the given property.
Image	createImageToStorage(Tag tag, EncodedImage placeholder) Creates an image to storage on the given property.
Image	createImageToStorage(Tag tag, EncodedImage placeholder, String storageFile) Creates an image for a given property to storage.
Image	createImageToStorage(Tag tag, EncodedImage placeholder, String storageFile, URLImage.ImageAdapter adapter) Creates an image for a given property to storage.This behaves similarly to the URLImage.createToStorage(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String) except the URL is retrieved from the entity’s property, instead of as a parameter.
Image	createImageToStorage(Tag tag, EncodedImage placeholder, URLImage.ImageAdapter adapter) Creates an image for a given property to storage.
Property	findProperty(Tag... tags) Finds the property corresponding to the given tags.
Object	get(Object key) Gets a property value.
<T> T	get(Property<T> prop) Gets the value of the specified property.
<V> V	get(Property prop, ContentType<V> contentType) Gets property value as given content type.
Aggregate	getAggregate() Gets the aggregate that this entity is a part of, or creates a new Aggregate with this entity as a its root.
<T> T	getAs(Property prop, Class<T> cls)
<T> boolean	getAs(Property prop, Class<T> cls, SuccessCallback<T> callback)
<T> T	getAs(Tag tag, Class<T> cls)
<T> boolean	getAs(Tag tag, Class<T> cls, SuccessCallback<T> callback)
Boolean	getBoolean(Property prop) Gets property value as Boolean.
Boolean	getBoolean(Tag... tags) Gets property value as Boolean.
Date	getDate(Property prop) Gets property as date
Date	getDate(Tag... tags) Gets property as date.
Double	getDouble(Property prop) Gets a property value as a Double.
Double	getDouble(Tag... tags) Gets property value as a Double.
BaseEntity	getEntity()
Entity	getEntity(Property prop) Gets the a property value as an Entity.
Entity	getEntity(Tag... tag) Gets the a property as an Entity.
EntityList	getEntityList(Property prop) Gets property as an EntityList
EntityList	getEntityList(Tag... tag) Gets a property as an EntityList.
EntityList	getEntityListNonNull(Property prop) Gets property as an EntityList.
Entity	getEntityNonNull(Property prop) Gets a property value as an Entity.
EntityType	getEntityType() Gets the entity type of this entity.
Integer	getInt(Property prop) Gets property value as Integer
Integer	getInt(Tag... tags) Gets property value as an Integer.
Long	getLong(Property prop) Gets property value as Long
Long	getLong(Tag... tags) Gets property value as a Long.
String	getText(Property prop) Gets a property as text.
String	getText(Tag... tags) Gets a property value as text.
boolean	hasPropertyChangeListeners(Property prop)
boolean	hasVetoablePropertyChangeListeners(Property prop)
boolean	isEmpty(Property prop) Checks if property is empty.
boolean	isEmpty(Tag tag) Checks if property is empty.
boolean	isEntity(Property prop) Checks if property is an Entity.
boolean	isEntity(Tag tag) Checks if property is an entity.
boolean	isFalsey(Property prop) Checks if property value is falsey.
boolean	isFalsey(Tag tag) Checks if property value is falsey.
void	removePropertyChangeListener(ActionListener<PropertyChangeEvent> l) Removes property change listener.
void	removePropertyChangeListener(Property property, ActionListener<PropertyChangeEvent> l) Removes a property change listener.
void	removeVetoablePropertyChangeListener(ActionListener<VetoablePropertyChangeEvent> l) Removes property change listener.
void	removeVetoablePropertyChangeListener(Property property, ActionListener<VetoablePropertyChangeEvent> l) Removes a property change listener.
boolean	set(ContentType inputType, Object val, Tag... tags) Sets the property value as the given content type.
void	set(Object key, Object value) Sets a property value.
void	set(Property prop, ContentType inputType, Object val) Sets property as given content type.
boolean	set(Tag tag, ContentType inputType, Object val) Sets the property value as the given content type.
boolean	setBoolean(boolean val, Tag... tags) Sets property as boolean.
void	setBoolean(Property prop, boolean val) Sets property as boolean
boolean	setBoolean(Tag tag, boolean val) Sets property as boolean.
void	setChanged(Property prop, boolean firePropertyChange) Marks a property value as "changed".
boolean	setDate(Date date, Tag... tags) Sets property as Date.
void	setDate(Property prop, Date date) Sets property as Date
boolean	setDate(Tag tag, Date date) Sets property as Date.
boolean	setDouble(double val, Tag... tags) Sets property as double.
void	setDouble(Property prop, double val) Sets property as Double
boolean	setDouble(Tag tag, double val) Sets property as double.
boolean	setEntity(Entity e, Tag... tags) Sets property as Entity.
void	setEntity(Property prop, Entity e) Sets property as Entity
boolean	setEntity(Tag tag, Entity e) Sets property as Entity.
void	setEntityType(EntityType entityType) Sets the entity type for this entity.
boolean	setFloat(float val, Tag... tags) Sets property as float.
void	setFloat(Property prop, float val) Sets property as Float
boolean	setFloat(Tag tag, float val) Sets property as float.
boolean	setInt(int val, Tag... tags) Sets property as int.
void	setInt(Property prop, int val) Sets property as int
boolean	setInt(Tag tag, int val) Sets property as int.
boolean	setLong(long val, Tag... tags) Sets property as long.
void	setLong(Property prop, long val) Sets property as Long
boolean	setLong(Tag tag, long val) Sets property as long.
void	setText(Property prop, String text)
boolean	setText(String text, Tag... tags) Sets property as text
boolean	setText(Tag tag, String text) Sets the given property as text.
Map	toMap(Object... keys) Converts the entity to a Map.

Methods inherited from class java.lang.Object

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

Field Detail

entity

protected final Entity entity

Constructor Detail

SimpleEntityWrapper

protected SimpleEntityWrapper(Entity entity)

Method Detail

getEntity

public BaseEntity getEntity()

Specified by:

getEntity in interface Entity

Specified by:

getEntity in interface EntityWrapper

add

public void add(Property prop,
                Entity value)

Description copied from interface: Entity

Adds an item to the given property. Assumes that the property value is an EntityList. If property is currently null, it will attempt to create an EntityList for the property, and add a value.

Specified by:

add in interface Entity

Parameters:

prop - The property to set.

value - The entity to add to the property’s entity list.

addPropertyChangeListener

public void addPropertyChangeListener(Property property,
                                      ActionListener<PropertyChangeEvent> l)

Description copied from interface: Entity

Adds a listener to be notified of changes to the given property.

Specified by:

addPropertyChangeListener in interface Entity

Parameters:

property - The property to listen on.

l - The listener.

addPropertyChangeListener

public void addPropertyChangeListener(ActionListener<PropertyChangeEvent> l)

Description copied from interface: Entity

Adds a listener to listen to all property changes on all properties.

Specified by:

addPropertyChangeListener in interface Entity

Parameters:

l - The listener.

addVetoablePropertyChangeListener

public void addVetoablePropertyChangeListener(Property property,
                                              ActionListener<VetoablePropertyChangeEvent> l)

Description copied from interface: Entity

Adds a listener to be notified of changes to the given property.

Specified by:

addVetoablePropertyChangeListener in interface Entity

Parameters:

property - The property to listen on.

l - The listener.

addVetoablePropertyChangeListener

public void addVetoablePropertyChangeListener(ActionListener<VetoablePropertyChangeEvent> l)

Description copied from interface: Entity

Adds a listener to listen to all property changes on all properties.

Specified by:

addVetoablePropertyChangeListener in interface Entity

Parameters:

l - The listener.

as

public <T> boolean as(Class<T> cls,
                      SuccessCallback<T> callback)

Specified by:

as in interface Entity

createImageToFile

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

Description copied from interface: Entity

Creates an image for a given property to file system. This behaves similarly to the URLImage.createToFileSystem(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String, com.codename1.ui.URLImage.ImageAdapter) except the URL is retrieved from the entity’s property, instead of as a parameter.

Specified by:

createImageToFile in interface Entity

Parameters:

tag - The tag used to look up the property to store.

placeholder - The placeholder image.

adapter - Adapter to manipulate the image when loading.

Returns:

The Image, usually a URLImage.

createImageToFile

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

Description copied from interface: Entity

Creates an image for a given property to file system. This behaves similarly to the URLImage.createToFileSystem(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String, com.codename1.ui.URLImage.ImageAdapter) except the URL is retrieved from the entity’s property, instead of as a parameter.

Specified by:

createImageToFile in interface Entity

Parameters:

prop - The property where the image url should be retrieved from.

placeholder - The placeholder image.

adapter - Adapter to manipulate the image when loading.

Returns:

The Image, usually a URLImage.

createImageToFile

public Image createImageToFile(Tag tag,
                               EncodedImage placeholder)

Description copied from interface: Entity

Creates an image for a given property to file system. This behaves similarly to the URLImage.createToFileSystem(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String, com.codename1.ui.URLImage.ImageAdapter) except the URL is retrieved from the entity’s property, instead of as a parameter.

Specified by:

createImageToFile in interface Entity

Parameters:

tag - The tag used to look up the property to store.

placeholder - The placeholder image.

Returns:

The Image, usually a URLImage.

createImageToFile

public Image createImageToFile(Property prop,
                               EncodedImage placeholder)

Description copied from interface: Entity

Creates an image for a given property to file system. This behaves similarly to the URLImage.createToFileSystem(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String, com.codename1.ui.URLImage.ImageAdapter) except the URL is retrieved from the entity’s property, instead of as a parameter.

Specified by:

createImageToFile in interface Entity

Parameters:

prop - The property where the image url should be retrieved from.

placeholder - The placeholder image.

Returns:

The Image, usually a URLImage.

createImageToFile

public Image createImageToFile(Tag tag,
                               EncodedImage placeholder,
                               String file)

Description copied from interface: Entity

Creates an image for a given property to file system.This behaves similarly to the URLImage.createToFileSystem(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String, com.codename1.ui.URLImage.ImageAdapter) except the URL is retrieved from the entity’s property, instead of as a parameter.

Specified by:

createImageToFile in interface Entity

Parameters:

tag - The tag used to look up the property to store.

placeholder - The placeholder image.

file - The path where to cache the image in the file system.

Returns:

The Image, usually a URLImage.

createImageToFile

public Image createImageToFile(Property prop,
                               EncodedImage placeholder,
                               String file)

Description copied from interface: Entity

Creates an image for a given property to file system.This behaves similarly to the URLImage.createToFileSystem(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String, com.codename1.ui.URLImage.ImageAdapter) except the URL is retrieved from the entity’s property, instead of as a parameter.

Specified by:

createImageToFile in interface Entity

Parameters:

prop - The property where the image URL should be retrieved from.

placeholder - The placeholder image.

file - The path where to cache the image in the file system.

Returns:

The Image, usually a URLImage.

createImageToFile

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

Description copied from interface: Entity

Creates an image for a given property to file system.This behaves similarly to the URLImage.createToFileSystem(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String, com.codename1.ui.URLImage.ImageAdapter) except the URL is retrieved from the entity’s property, instead of as a parameter.

Specified by:

createImageToFile in interface Entity

Parameters:

tag - The tag used to look up the property to store.

placeholder - The placeholder image.

file - The path where to cache the image in the file system.

adapter - Adapter to manipulate the image on load.

Returns:

The Image, usually a URLImage.

createImageToFile

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

Description copied from interface: Entity

Creates an image for a given property to file system.This behaves similarly to the URLImage.createToFileSystem(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String, com.codename1.ui.URLImage.ImageAdapter) except the URL is retrieved from the entity’s property, instead of as a parameter.

Specified by:

createImageToFile in interface Entity

Parameters:

prop - The property where the image URL should be retrieved from.

placeholder - The placeholder image.

file - The path where to cache the image in the file system.

adapter - Adapter to manipulate the image on load.

Returns:

The Image, usually a URLImage.

createImageToStorage

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

Description copied from interface: Entity

Creates an image for a given property to storage. This behaves similarly to the URLImage.createToStorage(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String) except the URL is retrieved from the entity’s property, instead of as a parameter.

Specified by:

createImageToStorage in interface Entity

Parameters:

tag - The tag used to look up the property to store.

placeholder - The placeholder image.

adapter - Adapter for manipulating the image.

Returns:

The Image, usually a URLImage.

See Also:

URLImage.createToStorage(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String)

createImageToStorage

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

Description copied from interface: Entity

Creates an image to storage on the given property. This behaves similarly to the URLImage.createToStorage(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String) except the URL is retrieved from the entity’s property, instead of as a parameter.

Specified by:

createImageToStorage in interface Entity

Parameters:

prop - The property to store the image in.

placeholder - The placeholder image.

Returns:

The Image

createImageToStorage

public Image createImageToStorage(Tag tag,
                                  EncodedImage placeholder)

Description copied from interface: Entity

Creates an image to storage on the given property. This behaves similarly to the URLImage.createToStorage(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String) except the URL is retrieved from the entity’s property, instead of as a parameter.

Specified by:

createImageToStorage in interface Entity

Parameters:

tag - The tag used to look up the property to store.

placeholder - The placeholder image.

Returns:

The Image

createImageToStorage

public Image createImageToStorage(Property prop,
                                  EncodedImage placeholder)

Description copied from interface: Entity

Creates an image to storage on the given property. This behaves similarly to the URLImage.createToStorage(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String) except the URL is retrieved from the entity’s property, instead of as a parameter.

Specified by:

createImageToStorage in interface Entity

Parameters:

prop - The property to store the image in.

placeholder - The placeholder image.

Returns:

The Image

createImageToStorage

public Image createImageToStorage(Tag tag,
                                  EncodedImage placeholder,
                                  String storageFile)

Description copied from interface: Entity

Creates an image for a given property to storage. This behaves similarly to the URLImage.createToStorage(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String) except the URL is retrieved from the entity’s property, instead of as a parameter.

Specified by:

createImageToStorage in interface Entity

Parameters:

tag - The tag used to look up the property to store.

placeholder - The placeholder image.

storageFile - The storage key to store the image in.

Returns:

The Image, usually a URLImage.

See Also:

URLImage.createToStorage(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String)

createImageToStorage

public Image createImageToStorage(Property prop,
                                  EncodedImage placeholder,
                                  String storageFile)

Description copied from interface: Entity

Creates an image to storage on the given property.This behaves similarly to the URLImage.createToStorage(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String) except the URL is retrieved from the entity’s property, instead of as a parameter.

Specified by:

createImageToStorage in interface Entity

Parameters:

prop - The property to store the image in.

placeholder - The placeholder image.

storageFile - The storage key where the image should be cached.

Returns:

The Image

createImageToStorage

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

Description copied from interface: Entity

Creates an image for a given property to storage.This behaves similarly to the URLImage.createToStorage(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String) except the URL is retrieved from the entity’s property, instead of as a parameter.

Specified by:

createImageToStorage in interface Entity

Parameters:

tag - The tag used to look up the property to store.

placeholder - The placeholder image.

storageFile - The storage key to store the image in.

adapter - Adapter to manipulate the image when loading.

Returns:

The Image, usually a URLImage.

See Also:

URLImage.createToStorage(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String)

createImageToStorage

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

Description copied from interface: Entity

Creates an image to storage on the given property.This behaves similarly to the URLImage.createToStorage(com.codename1.ui.EncodedImage, java.lang.String, java.lang.String) except the URL is retrieved from the entity’s property, instead of as a parameter.

Specified by:

createImageToStorage in interface Entity

Parameters:

prop - The property to store the image in.

placeholder - The placeholder image.

storageFile - The storage key where the image should be cached.

adapter - Adapter to manipulate the image when loading.

Returns:

The Image

findProperty

public Property findProperty(Tag... tags)

Description copied from interface: Entity

Finds the property corresponding to the given tags.

Specified by:

findProperty in interface Entity

Parameters:

tags - The tags to search for. The first tag resolving to a property is used.

Returns:

The matching property, or null if none found.

get

public Object get(Object key)

Description copied from interface: Entity

Gets a property value.

Specified by:

get in interface Entity

Parameters:

key - The lookup key for the property. This can be either a Property, a Tag, a Tags, or anything else.

Returns:

The property value.

get

public <T> T get(Property<T> prop)

Description copied from interface: Entity

Gets the value of the specified property.

Specified by:

get in interface Entity

Parameters:

prop - The property to retrieve.

Returns:

get

public <V> V get(Property prop,
                 ContentType<V> contentType)

Description copied from interface: Entity

Gets property value as given content type.

Specified by:

get in interface Entity

Type Parameters:

V - Content Type

Parameters:

prop - The property to get

contentType - The content type.

Returns:

The value as the given content type.

getAggregate

public Aggregate getAggregate()

Description copied from interface: Entity

Gets the aggregate that this entity is a part of, or creates a new Aggregate with this entity as a its root.

Specified by:

getAggregate in interface Entity

Returns:

the aggregate

getAs

public <T> T getAs(Property prop,
                   Class<T> cls)

Specified by:

getAs in interface Entity

getAs

public <T> T getAs(Tag tag,
                   Class<T> cls)

Specified by:

getAs in interface Entity

getAs

public <T> boolean getAs(Property prop,
                         Class<T> cls,
                         SuccessCallback<T> callback)

Specified by:

getAs in interface Entity

getAs

public <T> boolean getAs(Tag tag,
                         Class<T> cls,
                         SuccessCallback<T> callback)

Specified by:

getAs in interface Entity

getBoolean

public Boolean getBoolean(Property prop)

Description copied from interface: Entity

Gets property value as Boolean. Consider using Entity.isFalsey(com.codename1.rad.models.Property) instead of this method if it is possible that the property is null, or stores a type other than Boolean.

Specified by:

getBoolean in interface Entity

Parameters:

prop - The property.

Returns:

The property value as boolean.

getBoolean

public Boolean getBoolean(Tag... tags)

Description copied from interface: Entity

Gets property value as Boolean. Consider using Entity.isFalsey(com.codename1.rad.models.Tag) instead of this method if it is possible that the property is null, or stores a type other than Boolean.

Specified by:

getBoolean in interface Entity

Parameters:

tags - Tags to search for. First tag resolving to a property is used.

Returns:

The property value as a Boolean.

getDate

public Date getDate(Property prop)

Description copied from interface: Entity

Gets property as date

Specified by:

getDate in interface Entity

Parameters:

prop - The property to set

Returns:

The property as a date.

getDate

public Date getDate(Tag... tags)

Description copied from interface: Entity

Gets property as date.

Specified by:

getDate in interface Entity

Parameters:

tags - Tags used to lookup property.

Returns:

The property as a Date.

getDouble

public Double getDouble(Property prop)

Description copied from interface: Entity

Gets a property value as a Double.

Specified by:

getDouble in interface Entity

Parameters:

prop - The property.

Returns:

The property value as a Double

getDouble

public Double getDouble(Tag... tags)

Description copied from interface: Entity

Gets property value as a Double.

Specified by:

getDouble in interface Entity

Parameters:

tags - Tags to search for. First tag resolving to a property is used.

Returns:

Property value as Double

getEntity

public Entity getEntity(Tag... tag)

Description copied from interface: Entity

Gets the a property as an Entity.

Specified by:

getEntity in interface Entity

Parameters:

tag - Tag list to search for matching properties.

Returns:

The property value as an entity, or null if no such property found, or if matching property is not an entity.

getEntity

public Entity getEntity(Property prop)

Description copied from interface: Entity

Gets the a property value as an Entity.

Specified by:

getEntity in interface Entity

Parameters:

prop - The property whose value we wish to retrieve.

Returns:

The property value as an entity, or null if the property value is not an entity.

getEntityList

public EntityList getEntityList(Tag... tag)

Description copied from interface: Entity

Gets a property as an EntityList.

Specified by:

getEntityList in interface Entity

Parameters:

tag - The tag used to look up the property. More than one tag can be supplied. The first matching tag (i.e. for which the entity has a corresponding property) will be used.

Returns:

The property value as an EntityList or null if no property was found matching any of the tags.

getEntityList

public EntityList getEntityList(Property prop)

Description copied from interface: Entity

Gets property as an EntityList

Specified by:

getEntityList in interface Entity

Parameters:

prop - The property to retrieve.

Returns:

The property as an EntityList, or null if the property value is not an EntityList.

getEntityListNonNull

public EntityList getEntityListNonNull(Property prop)

Description copied from interface: Entity

Gets property as an EntityList. If the property is currently null, then this will attempt to create a new EntityList at this property, and return that.

Specified by:

getEntityListNonNull in interface Entity

Parameters:

prop - The property.

Returns:

The property value as an entity list.

getEntityNonNull

public Entity getEntityNonNull(Property prop)

Description copied from interface: Entity

Gets a property value as an Entity. If the property value is currently null, then this will attempt to create a new Entity at this property, and return that.

Specified by:

getEntityNonNull in interface Entity

Parameters:

prop - The property to get.

Returns:

The property value as an Entity.

getEntityType

public EntityType getEntityType()

Description copied from interface: Entity

Gets the entity type of this entity.

Specified by:

getEntityType in interface Entity

Returns:

The entity type.

getInt

public Integer getInt(Property prop)

Description copied from interface: Entity

Gets property value as Integer

Specified by:

getInt in interface Entity

Parameters:

prop - Th property

Returns:

The property value as Integer.

getInt

public Integer getInt(Tag... tags)

Description copied from interface: Entity

Gets property value as an Integer.

Specified by:

getInt in interface Entity

Parameters:

tags - Tags to search for. First tag resolving to a property is used.

Returns:

Property value as Integer

getLong

public Long getLong(Property prop)

Description copied from interface: Entity

Gets property value as Long

Specified by:

getLong in interface Entity

Parameters:

prop - Th property

Returns:

The property value as Long.

getLong

public Long getLong(Tag... tags)

Description copied from interface: Entity

Gets property value as a Long.

Specified by:

getLong in interface Entity

Parameters:

tags - Tags to search for. First tag resolving to a property is used.

Returns:

Property value as Long

getText

public String getText(Property prop)

Description copied from interface: Entity

Gets a property as text.

Specified by:

getText in interface Entity

Parameters:

prop - The property

Returns:

The property value as text.

getText

public String getText(Tag... tags)

Description copied from interface: Entity

Gets a property value as text.

Specified by:

getText in interface Entity

Parameters:

tags - The tags to search for. The first tag resolving to a property is used.

Returns:

The property value as text.

hasPropertyChangeListeners

public boolean hasPropertyChangeListeners(Property prop)

Specified by:

hasPropertyChangeListeners in interface Entity

hasVetoablePropertyChangeListeners

public boolean hasVetoablePropertyChangeListeners(Property prop)

Specified by:

hasVetoablePropertyChangeListeners in interface Entity

isEmpty

public boolean isEmpty(Property prop)

Description copied from interface: Entity

Checks if property is empty. This includes if property is null, an empty string, or an EntityList that is empty.

Specified by:

isEmpty in interface Entity

Parameters:

prop - The property

Returns:

True if property value is empty.

isEmpty

public boolean isEmpty(Tag tag)

Description copied from interface: Entity

Checks if property is empty. This includes if property is null, an empty string, or an EntityList that is empty.

Specified by:

isEmpty in interface Entity

Parameters:

tag - The tag used to lookup property.

Returns:

True if property is empty.

isEntity

public boolean isEntity(Property prop)

Description copied from interface: Entity

Checks if property is an Entity.

Specified by:

isEntity in interface Entity

Parameters:

prop - The property.

Returns:

True only if the property value is an Entity.

isEntity

public boolean isEntity(Tag tag)

Description copied from interface: Entity

Checks if property is an entity.

Specified by:

isEntity in interface Entity

Parameters:

tag - The tag to lookup property.

Returns:

True only if the property value is an entity.

isFalsey

public boolean isFalsey(Property prop)

Description copied from interface: Entity

Checks if property value is falsey. This includes if the entity doesn’t contain the property, if the property value is null, or an empty string, or a boolean false value, is numeric with a 0 value, or is an empty EntityList.

Specified by:

isFalsey in interface Entity

Parameters:

prop - The property to check.

Returns:

True if the property value is "falsey".

isFalsey

public boolean isFalsey(Tag tag)

Description copied from interface: Entity

Checks if property value is falsey. This includes if the entity doesn’t contain the property, if the property value is null, or an empty string, or a boolean false value, is numeric with a 0 value, or is an empty EntityList.

Specified by:

isFalsey in interface Entity

Parameters:

tag - The tag to lookup the property.

Returns:

True if property value is "falsey".

removePropertyChangeListener

public void removePropertyChangeListener(Property property,
                                         ActionListener<PropertyChangeEvent> l)

Description copied from interface: Entity

Removes a property change listener.

Specified by:

removePropertyChangeListener in interface Entity

Parameters:

property - The property to listen to.

l - The listener.

removePropertyChangeListener

public void removePropertyChangeListener(ActionListener<PropertyChangeEvent> l)

Description copied from interface: Entity

Removes property change listener.

Specified by:

removePropertyChangeListener in interface Entity

Parameters:

l - The listener.

removeVetoablePropertyChangeListener

public void removeVetoablePropertyChangeListener(Property property,
                                                 ActionListener<VetoablePropertyChangeEvent> l)

Description copied from interface: Entity

Removes a property change listener.

Specified by:

removeVetoablePropertyChangeListener in interface Entity

Parameters:

property - The property to listen to.

l - The listener.

removeVetoablePropertyChangeListener

public void removeVetoablePropertyChangeListener(ActionListener<VetoablePropertyChangeEvent> l)

Description copied from interface: Entity

Removes property change listener.

Specified by:

removeVetoablePropertyChangeListener in interface Entity

Parameters:

l - The listener.

set

public void set(Object key,
                Object value)

Description copied from interface: Entity

Sets a property value.

Specified by:

set in interface Entity

Parameters:

key - The lookup key for the property. This can be a Property, Tag, or Tags.

value - The value to set.

set

public void set(Property prop,
                ContentType inputType,
                Object val)

Description copied from interface: Entity

Sets property as given content type.

Specified by:

set in interface Entity

Parameters:

prop - The property to set

inputType - The content type of the input data

val - The value to set.

set

public boolean set(Tag tag,
                   ContentType inputType,
                   Object val)

Description copied from interface: Entity

Sets the property value as the given content type.

Specified by:

set in interface Entity

Parameters:

tag - The tag used to lookup the property.

inputType - The content type of the value that is being set.

val - The value.

Returns:

true if it was successfully set. false if it was not, generally due to no property being found matching the tag.

set

public boolean set(ContentType inputType,
                   Object val,
                   Tag... tags)

Description copied from interface: Entity

Sets the property value as the given content type.

Specified by:

set in interface Entity

Parameters:

inputType - The content type of the input data.

val - The value to set.

tags - The tags used to lookup the property. The first tag resolving to a property is used.

Returns:

True if the value was set. False if not. Usually false means that there was no property matching the provided tags.

setBoolean

public void setBoolean(Property prop,
                       boolean val)

Description copied from interface: Entity

Sets property as boolean

Specified by:

setBoolean in interface Entity

Parameters:

prop - The property to set

val - The value to set.

setBoolean

public boolean setBoolean(Tag tag,
                          boolean val)

Description copied from interface: Entity

Sets property as boolean.

Specified by:

setBoolean in interface Entity

Parameters:

tag - Tag used to lookup property.

val - The value to set.

Returns:

True if successful. False if no matching properties were found for tag.

setBoolean

public boolean setBoolean(boolean val,
                          Tag... tags)

Description copied from interface: Entity

Sets property as boolean.

Specified by:

setBoolean in interface Entity

Parameters:

val - The value to set.

tags - Tags used to lookup property.

Returns:

True if successful. False if no matching properties were found for tags.

setChanged

public void setChanged(Property prop,
                       boolean firePropertyChange)

Description copied from interface: Entity

Marks a property value as "changed". This will propagate a call to #setChanged() (marking the whole object as changed), and it will fire a property change event, if the firePropertyChange argument is true.

Specified by:

setChanged in interface Entity

Parameters:

prop - The property to mark as changed.

firePropertyChange - True to fire a property change event to all listeners of this property.

setDate

public void setDate(Property prop,
                    Date date)

Description copied from interface: Entity

Sets property as Date

Specified by:

setDate in interface Entity

Parameters:

prop - The property to set

date - The value to set.

setDate

public boolean setDate(Tag tag,
                       Date date)

Description copied from interface: Entity

Sets property as Date.

Specified by:

setDate in interface Entity

Parameters:

tag - Tag used to lookup property.

date - The value to set.

Returns:

True if successful. False if no matching properties were found for tag.

setDate

public boolean setDate(Date date,
                       Tag... tags)

Description copied from interface: Entity

Sets property as Date.

Specified by:

setDate in interface Entity

Parameters:

date - The value to set.

tags - Tags used to lookup property.

Returns:

True if successful. False if no matching properties were found for tags.

setDouble

public void setDouble(Property prop,
                      double val)

Description copied from interface: Entity

Sets property as Double

Specified by:

setDouble in interface Entity

Parameters:

prop - The property to set

val - The value to set.

setDouble

public boolean setDouble(Tag tag,
                         double val)

Description copied from interface: Entity

Sets property as double.

Specified by:

setDouble in interface Entity

Parameters:

tag - Tag used to lookup property.

val - The value to set.

Returns:

True if successful. False if no matching properties were found for tag.

setDouble

public boolean setDouble(double val,
                         Tag... tags)

Description copied from interface: Entity

Sets property as double.

Specified by:

setDouble in interface Entity

Parameters:

val - The value to set.

tags - Tags used to lookup property.

Returns:

True if successful. False if no matching properties were found for tags.

setEntity

public void setEntity(Property prop,
                      Entity e)

Description copied from interface: Entity

Sets property as Entity

Specified by:

setEntity in interface Entity

Parameters:

prop - The property to set

e - The value to set.

setEntity

public boolean setEntity(Tag tag,
                         Entity e)

Description copied from interface: Entity

Sets property as Entity.

Specified by:

setEntity in interface Entity

Parameters:

tag - Tag used to lookup property.

e - The value to set.

Returns:

True if successful. False if no matching properties were found for tag.

setEntity

public boolean setEntity(Entity e,
                         Tag... tags)

Description copied from interface: Entity

Sets property as Entity.

Specified by:

setEntity in interface Entity

Parameters:

e - The value to set.

tags - Tags used to lookup property.

Returns:

True if successful. False if no matching properties were found for tags.

setEntityType

public void setEntityType(EntityType entityType)

Description copied from interface: Entity

Sets the entity type for this entity. The general pattern for entity definitions is to call this either in the constructor, or in the instance INIT section, AFTER defining the Entity Type.

E.g.

public class Person extends Entity {
    public static final EntityType TYPE = new EntityType() {{
        string(Thing.name);
        string(Thing.description);
    }};
    {
        setEntityType(TYPE);
    }
}

Specified by:

setEntityType in interface Entity

setFloat

public void setFloat(Property prop,
                     float val)

Description copied from interface: Entity

Sets property as Float

Specified by:

setFloat in interface Entity

Parameters:

prop - The property to set

val - The value to set.

setFloat

public boolean setFloat(Tag tag,
                        float val)

Description copied from interface: Entity

Sets property as float.

Specified by:

setFloat in interface Entity

Parameters:

tag - Tag used to lookup property.

val - The value to set.

Returns:

True if successful. False if no matching properties were found for tag.

setFloat

public boolean setFloat(float val,
                        Tag... tags)

Description copied from interface: Entity

Sets property as float.

Specified by:

setFloat in interface Entity

Parameters:

val - The value to set.

tags - Tags used to lookup property.

Returns:

True if successful. False if no matching properties were found for tags.

setInt

public void setInt(Property prop,
                   int val)

Description copied from interface: Entity

Sets property as int

Specified by:

setInt in interface Entity

Parameters:

prop - The property to set

val - The value to set.

setInt

public boolean setInt(Tag tag,
                      int val)

Description copied from interface: Entity

Sets property as int.

Specified by:

setInt in interface Entity

Parameters:

tag - Tag used to lookup property.

val - The value to set.

Returns:

True if successful. False if no matching properties were found for tag.

setInt

public boolean setInt(int val,
                      Tag... tags)

Description copied from interface: Entity

Sets property as int.

Specified by:

setInt in interface Entity

Parameters:

val - The value to set.

tags - Tags used to lookup property.

Returns:

True if successful. False if no matching properties were found for tags.

setLong

public void setLong(Property prop,
                    long val)

Description copied from interface: Entity

Sets property as Long

Specified by:

setLong in interface Entity

Parameters:

prop - The property to set

val - The value to set.

setLong

public boolean setLong(Tag tag,
                       long val)

Description copied from interface: Entity

Sets property as long.

Specified by:

setLong in interface Entity

Parameters:

tag - Tag used to lookup property.

val - The value to set.

Returns:

True if successful. False if no matching properties were found for tag.

setLong

public boolean setLong(long val,
                       Tag... tags)

Description copied from interface: Entity

Sets property as long.

Specified by:

setLong in interface Entity

Parameters:

val - The value to set.

tags - Tags used to lookup property.

Returns:

True if successful. False if no matching properties were found for tags.

setText

public void setText(Property prop,
                    String text)

Specified by:

setText in interface Entity

setText

public boolean setText(Tag tag,
                       String text)

Description copied from interface: Entity

Sets the given property as text.

Specified by:

setText in interface Entity

Parameters:

tag - The tag used to lookup the property.

text - The text to set.

Returns:

True if it was successful. False otherwise. False generally means that there was no matching property.

setText

public boolean setText(String text,
                       Tag... tags)

Description copied from interface: Entity

Sets property as text

Specified by:

setText in interface Entity

Parameters:

text - Text to set as property value.

tags - Tags used to lookup property.

Returns:

True if successful. False if there were no matching properties.

toMap

public Map toMap(Object... keys)

Description copied from interface: Entity

Converts the entity to a Map. This will return a Map whose keys correspond to the keys supplied, and values are the correponding value in the entity.

Specified by:

toMap in interface Entity

Parameters:

keys - The keys to use for lookup. Can be Tag, Property, or Tags.

Returns:

A Map with the specified properties.