com.haulmont.chile.core.model

Interface Instance

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

BaseEntity<T>, Entity<T>

All Known Implementing Classes:

AbstractCondition, AbstractConditionDescriptor, AbstractInstance, AbstractNotPersistentEntity, AbstractPermissionTarget, AbstractSearchFolder, AppFolder, AppPropertyEntity, AttributeLocaleData, AttributeTarget, BaseDbGeneratedIdEntity, BaseGenericIdEntity, BaseIdentityIdEntity, BaseIntegerIdEntity, BaseIntIdentityIdEntity, BaseLongIdEntity, BaseStringIdEntity, BaseUuidEntity, BasicPermissionTarget, CategorizedEntity, Category, CategoryAttribute, CategoryAttributeConfiguration, CategoryAttributeEnumValue, CategoryAttributeValue, Config, Constraint, CustomCondition, CustomConditionCreator, CustomConditionDescriptor, DummyCategorizedEntity, DummyEmbeddableEntity, DummyIdentityIdEntity, DummyIntegerIdEntity, DummyIntIdentityIdEntity, DummyLongIdEntity, DummyStringIdEntity, DynamicAttributesCondition, DynamicAttributesConditionCreator, DynamicAttributesEntity, EmbeddableEntity, EntityBasicPropertyDiff, EntityClassPropertyDiff, EntityCollectionPropertyDiff, EntityDiff, EntityLogAttr, EntityLogItem, EntityPropertyDiff, EntitySnapshot, EntityStatistics, FileDescriptor, FilterEntity, Folder, FtsCondition, FtsConditionDescriptor, FtsQueue, Group, GroupCondition, GroupConditionDescriptor, GroupHierarchy, HeaderConditionDescriptor, InfoParamEntity, JmxInstance, KeyValueEntity, LocalizedConstraintMessage, LockDescriptor, LockInfo, LockNotSupported, LoggedAttribute, LoggedEntity, ManagedBeanAttribute, ManagedBeanDomain, ManagedBeanInfo, ManagedBeanOperation, ManagedBeanOperationParameter, MultiplePermissionTarget, NullEntity, OperationPermissionTarget, PerformanceParameter, Permission, Presentation, PropertyCondition, PropertyConditionDescriptor, QueryResult, ReferenceToEntity, RememberMeToken, Role, ScheduledExecution, ScheduledTask, ScreenAndComponent, ScreenComponentDescriptor, ScreenHistoryEntity, ScreenProfilerEvent, SearchFolder, SendingAttachment, SendingMessage, Server, SessionAttribute, SessionLogEntry, StandardEntity, ThreadSnapshot, UiPermissionTarget, User, UserRole, UserSessionEntity, UserSetting, UserSubstitution

public interface Instance
extends java.io.Serializable

Interface to be implemented by data model objects.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Instance.BeanPropertyPath Property path descriptor.
static class	Instance.PropertyChangeEvent Event object for Instance.PropertyChangeListener.
static interface	Instance.PropertyChangeListener Interface to track changes in data model objects.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(Instance.PropertyChangeListener listener) Add listener to track attributes changes.
java.lang.String	getInstanceName() Deprecated. Use MetadataTools.getInstanceName(com.haulmont.chile.core.model.Instance) instead.
MetaClass	getMetaClass()
<T> T	getValue(java.lang.String name) Get an attribute value.
<T> T	getValueEx(Instance.BeanPropertyPath propertyPath) Get an attribute value.
<T> T	getValueEx(java.lang.String propertyPath) Get an attribute value.
void	removeAllListeners() Remove all Instance.PropertyChangeListeners.
void	removePropertyChangeListener(Instance.PropertyChangeListener listener) Remove listener.
void	setValue(java.lang.String name, java.lang.Object value) Set an attribute value.
void	setValueEx(Instance.BeanPropertyPath propertyPath, java.lang.Object value) Set an attribute value.
void	setValueEx(java.lang.String propertyPath, java.lang.Object value) Set an attribute value.

Method Detail

getMetaClass

MetaClass getMetaClass()

Returns:

metaclass of this object. Throws exception if the metaclass is not found.

getInstanceName

@Deprecated
java.lang.String getInstanceName()

Deprecated. Use MetadataTools.getInstanceName(com.haulmont.chile.core.model.Instance) instead.

Returns:

Instance name as defined by NamePattern or toString().

getValue

@Nullable
<T> T getValue(java.lang.String name)

Get an attribute value.

Parameters:

name - attribute name according to JavaBeans notation

Returns:

attribute value

setValue

void setValue(java.lang.String name,
              @Nullable
              java.lang.Object value)

Set an attribute value.
An implementor should first read a current value of the attribute, and then call an appropriate setter method only if the new value differs. This ensures triggering of Instance.PropertyChangeListeners only if the attribute was actually changed.

Parameters:

name - attribute name according to JavaBeans notation

value - attribute value

getValueEx

@Nullable
<T> T getValueEx(java.lang.String propertyPath)

Get an attribute value. Locates the attribute by the given path in object graph starting from this instance.
The path must consist of attribute names according to JavaBeans notation, separated by dots, e.g. car.driver.name.

Parameters:

propertyPath - path to an attribute

Returns:

attribute value. If any traversing attribute value is null or is not an Instance, this method stops here and returns this value.

getValueEx

@Nullable
<T> T getValueEx(Instance.BeanPropertyPath propertyPath)

Get an attribute value. Locates the attribute by the given path in object graph starting from this instance.
The path must consist of attribute names according to JavaBeans notation, separated by dots, e.g. car.driver.name.

Parameters:

propertyPath - path to an attribute

Returns:

attribute value. If any traversing attribute value is null or is not an Instance, this method stops here and returns this value.

setValueEx

void setValueEx(java.lang.String propertyPath,
                @Nullable
                java.lang.Object value)

Set an attribute value. Locates the attribute by the given path in object graph starting from this instance.
The path must consist of attribute names according to JavaBeans notation, separated by dots, e.g. car.driver.name.
In the example above this method first gets value of car.driver attribute, and if it is not null and is an Instance, sets value of name attribute in it.
An implementor should first read a current value of the attribute, and then call an appropriate setter method only if the new value differs. This ensures triggering of Instance.PropertyChangeListeners only if the attribute was actually changed.

Parameters:

propertyPath - path to an attribute

value - attribute value

setValueEx

void setValueEx(Instance.BeanPropertyPath propertyPath,
                java.lang.Object value)

Set an attribute value. Locates the attribute by the given path in object graph starting from this instance.
The path must consist of attribute names according to JavaBeans notation, separated by dots, e.g. car.driver.name.
In the example above this method first gets value of car.driver attribute, and if it is not null and is an Instance, sets value of name attribute in it.
An implementor should first read a current value of the attribute, and then call an appropriate setter method only if the new value differs. This ensures triggering of Instance.PropertyChangeListeners only if the attribute was actually changed.

Parameters:

propertyPath - path to an attribute

value - attribute value

addPropertyChangeListener

void addPropertyChangeListener(Instance.PropertyChangeListener listener)

Add listener to track attributes changes.

Parameters:

listener - listener

removePropertyChangeListener

void removePropertyChangeListener(Instance.PropertyChangeListener listener)

Remove listener.

Parameters:

listener - listener to remove

removeAllListeners

void removeAllListeners()

Remove all Instance.PropertyChangeListeners.