com.codename1.rad.models

Class Entity

java.lang.Object

java.util.Observable

com.codename1.rad.models.Entity

Direct Known Subclasses:

Aggregate, EntityList

public class Entity
extends Observable

The base class for Model objects in CodeRAD. The Entity class contains all of the plumbing necessary for property binding, change listeners, property lookup, and data conversion. Subclasses of Entity should define a static EntityType object which serves as a sort of meta-class for the entity class. The EntityType keeps track of the properties in the entity, and provides property lookup via Tags, which is necessary for loose-coupling.

Example Entity Class

The following figure shows the definition of a very simple entity class:

public class UserProfile extends Entity {
   public static StringProperty name, description; (1)
   public static final EntityType TYPE = new EntityType(){{ (2)
       name = string(); (3)
       description = string();
   }};
   {
       setEntityType(TYPE); (4)
   }
}

1. We define 2 properties of type StringProperty on the class. A StringProperty is simply a property that contains a String. These are defined public static so that we can access them conveniently from anywhere.

2. We define an EntityType for the class. This is also public static because it is class-level (all objects of this class should share the same entity type).

3. We create name and description properties on this entity type. Notice that this code runs in the instance intializer of the EntityType (the {{ and }} braces are not a typo). Running this code inside the instance initializer will ensure that the properties are added to the `EntityType’s property index.

4. Inside the UserProfile instance initializer, we set the entity type to the entity type that we created above.

Note	Why can’t we just use POJOs for our models?* The Entity class provides a lot of useful plumbing that is necessary for building reusable components that can bind to each other. This includes property lookup, property binding, change events, and data conversion.

Adding Tags to Properties

In the above entity class, we haven’t "tagged" any of the properties so it can’t be used as a view model for any view, unless that view has been specifically designed for this class, which would limit its reusability. This is simple to remedy, though. Let’s tag the name property with Thing.name, and description with Thing.description:

name = string(tags(Thing.name));
description = string(tags(Thing.description));

Tip	Properties can contain multiple tags. E.g. If we want the name field to also be treated as the "ID" field, we could do: name = string(tags(Thing.name, Thing.identifier));

Accessing Property Values

We can access a property value using its property directly. E.g.

String name = model.get(UserProfile.name);

Notice here we didn’t need to cast the return value to "String" because the Profile.name property is declared as a string property.

We can also access the "name" property using the Thing.name tag, which is what allows us to use this as a loosely coupled view model:

String name = (String)model.get(Thing.name);

Warning

When using tags to access properties, it is best to use one of the getXXX(Tag) variants that explicitly converts the content type. E.g. com.codename1.rad.models.Entity#getText(com.codename1.rad.models.Tag). This is because there is no guarantee that a given entity is storing its Thing.name property as a String. It could use any type of property. Using getText() or getBoolean() will automatically handle data-conversion if possible. See ContentType for more information about data conversion in properties.

Using the convenience wrapper getText() and setText() we can then set the values on the name property in a generic way:

model.setText(Thing.name, "Steve");
String name = model.getText(Thing.name); // "Steve"

Tip

Technically, you don’t need to provide direct property access to your entity properties at all. In our above UserProfile class we retained explicit references to the name and description properties, but we could have simply omitted this. I.e. The following is also a perfectly valid entity type definition: An entity type that doesn’t retain explicit references to its properties. The properties can still be accessed via their assigned tags. public class UserProfile extends Entity { public static final EntityType TYPE = new EntityType(){{ string(tags(Thing.name)); string(tags(Thing.description)); }}; { setEntityType(TYPE); } }

Author:

shannah

Constructor Summary

Constructors

Constructor and Description
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.
protected void	clearChanged()
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.
static EntityTypeBuilder	entityTypeBuilder(Class<? extends Entity> cls)
Property	findProperty(Tag... tags) Finds the property corresponding to the given tags.
protected void	firePropertyChangeEvent(PropertyChangeEvent pce) Fires a property change event to registered listeners.
protected void	fireVetoablePropertyChangeEvent(VetoablePropertyChangeEvent pce) Fires a property change event to registered listeners.
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.
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.
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.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

Entity

public Entity()

Method Detail

addPropertyChangeListener

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

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

Parameters:

property - The property to listen on.

l - The listener.

hasPropertyChangeListeners

public boolean hasPropertyChangeListeners(Property prop)

hasVetoablePropertyChangeListeners

public boolean hasVetoablePropertyChangeListeners(Property prop)

removePropertyChangeListener

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

Removes a property change listener.

Parameters:

property - The property to listen to.

l - The listener.

addPropertyChangeListener

public void addPropertyChangeListener(ActionListener<PropertyChangeEvent> l)

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

Parameters:

l - The listener.

removePropertyChangeListener

public void removePropertyChangeListener(ActionListener<PropertyChangeEvent> l)

Removes property change listener.

Parameters:

l - The listener.

firePropertyChangeEvent

protected void firePropertyChangeEvent(PropertyChangeEvent pce)

Fires a property change event to registered listeners.

Parameters:

pce - The event.

addVetoablePropertyChangeListener

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

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

Parameters:

property - The property to listen on.

l - The listener.

removeVetoablePropertyChangeListener

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

Removes a property change listener.

Parameters:

property - The property to listen to.

l - The listener.

addVetoablePropertyChangeListener

public void addVetoablePropertyChangeListener(ActionListener<VetoablePropertyChangeEvent> l)

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

Parameters:

l - The listener.

removeVetoablePropertyChangeListener

public void removeVetoablePropertyChangeListener(ActionListener<VetoablePropertyChangeEvent> l)

Removes property change listener.

Parameters:

l - The listener.

fireVetoablePropertyChangeEvent

protected void fireVetoablePropertyChangeEvent(VetoablePropertyChangeEvent pce)

Fires a property change event to registered listeners.

Parameters:

pce - The event.

createImageToStorage

public Image createImageToStorage(Tag tag,
                                  EncodedImage placeholder,
                                  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.

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)

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.

Parameters:

prop - The property to store the image in.

placeholder - The placeholder image.

adapter -

Returns:

The Image

createImageToStorage

public Image createImageToStorage(Tag tag,
                                  EncodedImage placeholder)

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.

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)

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.

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)

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.

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)

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.

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)

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.

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)

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.

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

createImageToFile

public Image createImageToFile(Tag tag,
                               EncodedImage placeholder,
                               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.

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)

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.

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)

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.

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)

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.

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)

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.

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)

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.

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)

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.

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)

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.

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.

setEntityType

public void setEntityType(EntityType entityType)

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);
    }
}

Parameters:

entityType -

getEntityType

public EntityType getEntityType()

Gets the entity type of this entity.

Returns:

The entity type.

getEntityList

public EntityList getEntityList(Tag... tag)

Gets a property as an EntityList.

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)

Gets property as an EntityList

Parameters:

prop - The property to retrieve.

Returns:

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

getEntity

public Entity getEntity(Tag... tag)

Gets the a property as an 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)

Gets the a property value as an 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.

getAggregate

public Aggregate getAggregate()

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

Returns:

the aggregate

clearChanged

protected void clearChanged()

Overrides:

clearChanged in class Observable

get

public Object get(Object key)

Gets a property value.

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.

set

public void set(Object key,
                Object value)

Sets a property value.

Parameters:

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

value - The value to set.

toMap

public Map toMap(Object... keys)

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.

Parameters:

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

Returns:

A Map with the specified properties.

get

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

Gets the value of the specified property.

Type Parameters:

T -

Parameters:

prop - The property to retrieve.

Returns:

findProperty

public Property findProperty(Tag... tags)

Finds the property corresponding to the given tags.

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.

getText

public String getText(Property prop)

Gets a property as text.

Parameters:

prop - The property

Returns:

The property value as text.

getText

public String getText(Tag... tags)

Gets a property value as text.

Parameters:

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

Returns:

The property value as text.

getBoolean

public Boolean getBoolean(Property prop)

Gets property value as Boolean. Consider using 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.

Parameters:

prop - The property.

Returns:

The property value as boolean.

getBoolean

public Boolean getBoolean(Tag... tags)

Gets property value as Boolean. Consider using 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.

Parameters:

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

Returns:

The property value as a Boolean.

getDouble

public Double getDouble(Property prop)

Gets a property value as a Double.

Parameters:

prop - The property.

Returns:

The property value as a Double

getDouble

public Double getDouble(Tag... tags)

Gets property value as a Double.

Parameters:

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

Returns:

Property value as Double

getInt

public Integer getInt(Property prop)

Gets property value as Integer

Parameters:

prop - Th property

Returns:

The property value as Integer.

getInt

public Integer getInt(Tag... tags)

Gets property value as an Integer.

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)

Gets property value as Long

Parameters:

prop - Th property

Returns:

The property value as Long.

getLong

public Long getLong(Tag... tags)

Gets property value as a Long.

Parameters:

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

Returns:

Property value as Long

get

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

Gets property value as given content type.

Type Parameters:

V - Content Type

Parameters:

prop - The property to get

contentType - The content type.

Returns:

The value as the given content type.

set

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

Sets property as given content type.

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)

Sets the property value as the given content type.

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)

Sets the property value as the given content type.

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.

setText

public void setText(Property prop,
                    String text)

setText

public boolean setText(Tag tag,
                       String text)

Sets the given property as text.

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)

Sets property as text

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.

setDouble

public void setDouble(Property prop,
                      double val)

Sets property as Double

Parameters:

prop - The property to set

val - The value to set.

setDouble

public boolean setDouble(Tag tag,
                         double val)

Sets property as double.

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)

Sets property as double.

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)

Sets property as Long

Parameters:

prop - The property to set

val - The value to set.

setLong

public boolean setLong(Tag tag,
                       long val)

Sets property as long.

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)

Sets property as long.

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.

setFloat

public void setFloat(Property prop,
                     float val)

Sets property as Float

Parameters:

prop - The property to set

val - The value to set.

setFloat

public boolean setFloat(Tag tag,
                        float val)

Sets property as float.

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)

Sets property as float.

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)

Sets property as int

Parameters:

prop - The property to set

val - The value to set.

setInt

public boolean setInt(Tag tag,
                      int val)

Sets property as int.

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)

Sets property as int.

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.

setBoolean

public void setBoolean(Property prop,
                       boolean val)

Sets property as boolean

Parameters:

prop - The property to set

val - The value to set.

setBoolean

public boolean setBoolean(Tag tag,
                          boolean val)

Sets property as boolean.

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)

Sets property as boolean.

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.

getDate

public Date getDate(Property prop)

Gets property as date

Parameters:

prop - The property to set

Returns:

The property as a date.

getDate

public Date getDate(Tag... tags)

Gets property as date.

Parameters:

tags - Tags used to lookup property.

Returns:

The property as a Date.

setDate

public void setDate(Property prop,
                    Date date)

Sets property as Date

Parameters:

prop - The property to set

date - The value to set.

setDate

public boolean setDate(Tag tag,
                       Date date)

Sets property as Date.

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)

Sets property as Date.

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.

setEntity

public void setEntity(Property prop,
                      Entity e)

Sets property as Entity

Parameters:

prop - The property to set

e - The value to set.

setEntity

public boolean setEntity(Tag tag,
                         Entity e)

Sets property as 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)

Sets property as 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.

isEntity

public boolean isEntity(Property prop)

Checks if property is an Entity.

Parameters:

prop - The property.

Returns:

True only if the property value is an Entity.

isEntity

public boolean isEntity(Tag tag)

Checks if property is an entity.

Parameters:

tag - The tag to lookup property.

Returns:

True only if the property value is an entity.

isEmpty

public boolean isEmpty(Property prop)

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

Parameters:

prop - The property

Returns:

True if property value is empty.

isEmpty

public boolean isEmpty(Tag tag)

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

Parameters:

tag - The tag used to lookup property.

Returns:

True if property is empty.

isFalsey

public boolean isFalsey(Property prop)

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.

Parameters:

prop - The property to check.

Returns:

True if the property value is "falsey".

isFalsey

public boolean isFalsey(Tag tag)

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.

Parameters:

tag - The tag to lookup the property.

Returns:

True if property value is "falsey".

setChanged

public void setChanged(Property prop,
                       boolean firePropertyChange)

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

Parameters:

prop - The property to mark as changed.

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

add

public void add(Property prop,
                Entity value)

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.

Parameters:

prop - The property to set.

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

getEntityListNonNull

public EntityList getEntityListNonNull(Property prop)

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.

Parameters:

prop - The property.

Returns:

The property value as an entity list.

Throws:

IllegalStateException - If the property type is not an EntityList type.

getEntityNonNull

public Entity getEntityNonNull(Property prop)

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.

Parameters:

prop - The property to get.

Returns:

The property value as an Entity.

Throws:

IllegalStateException - If the property type is not an Entity type.

entityTypeBuilder

public static EntityTypeBuilder entityTypeBuilder(Class<? extends Entity> cls)