Kanzi 3.9.10
DataContext Class Reference

DataContext acts as a container for data. More...

Inheritance diagram for DataContext:
[legend]

Classes

interface  ModifiedSubscriptionFunction
 Callback functions for Modified Subscription events. More...
 
class  ModifiedSubscriptionToken
 Token to represent a Modified Subscription. More...
 

Public Member Functions

ModifiedSubscriptionToken addModifiedNotificationHandler (ModifiedSubscriptionFunction modifiedHandlerFunction)
 Allows to subscribe to modifications in this data context.
 
DataObject getData ()
 Retrieves the root object of the underlying data tree.
 
DataContext lookupDataContext (String relativePath)
 Performs object look up by path.
 
void notifyModified ()
 Triggers modification procedure in this data context, which invokes the subscriptions.
 
void removeModifiedNotificationHandler (DataContext.ModifiedSubscriptionToken token)
 Removes a modification subscription.
 
- Public Member Functions inherited from Resource
String getName ()
 Gets the resource name.
 
String getUrl ()
 Gets the resource URL.
 
void setKeepAlive (boolean keepAlive)
 Sets the keep alive flag.
 
- Public Member Functions inherited from KanziObject
boolean equals (Object object)
 
Domain getDomain ()
 Returns the domain the object belongs to.
 
Metaclass getDynamicMetaclass ()
 Returns the metaclass of the dynamic type of the object.
 
long getNative ()
 Gets a pointer to the backing C++ instance.
 
TDataType getOptionalProperty (PropertyType< TDataType > propertyType)
 Returns the current value of a property type, but does not use the default value if there are no inputs to the property value.
 
TDataType getProperty (PropertyType< TDataType > propertyType)
 Returns the current value of a property type.
 
int hashCode ()
 
boolean hasValue (PropertyType< TDataType > propertyType)
 Evaluates whether there are any inputs into the property value.
 
boolean isStale ()
 Test if the object is stale i.e.
 
void removeLocalValue (PropertyType< TDataType > propertyType)
 Removes the local value associated with the property.
 
void setProperty (PropertyType< TDataType > propertyType, TDataType value)
 Sets the local value of a property type.
 
ObjectRef< TTypetryCreateObjectRef (Class< TType > clazz)
 Tries to create an owning ObjectRef instance to this KanziObject.
 

Static Public Attributes

static final Metaclass metaclass
 The Metaclass for the class.
 
- Static Public Attributes inherited from Resource
static final Metaclass metaclass
 The Metaclass for the class.
 
- Static Public Attributes inherited from KanziObject
static final Metaclass metaclass = new AbstractMetaclass("Kanzi.Object")
 The Metaclass for the class.
 

Additional Inherited Members

- Public Attributes inherited from ResourceMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Resource")
 Metaclass for Resource.
 
- Public Attributes inherited from DataContextMetadata
DynamicPropertyType< ResourceDataContextProperty
 Source of data for this node and its descendants.
 
DynamicPropertyType< ResourceItemsSourceProperty
 Data object which provides data sources for list items.
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.DataContext")
 Metaclass for DataContext.
 

Detailed Description

DataContext acts as a container for data.

All data within the data context is described as a tree of data objects. The class provides access and look-up functionality of the contained data objects.

Member Function Documentation

◆ addModifiedNotificationHandler()

ModifiedSubscriptionToken addModifiedNotificationHandler ( ModifiedSubscriptionFunction modifiedHandlerFunction)

Allows to subscribe to modifications in this data context.

Parameters
modifiedHandlerFunctionCallback that is invoked when a change occurs in this data context.
Returns
Token that can be used to identify and remove a given subscription.

◆ getData()

DataObject getData ( )

Retrieves the root object of the underlying data tree.

Returns
The data object that is the root of the data tree.

Reimplemented in DataSource.

◆ lookupDataContext()

DataContext lookupDataContext ( String relativePath)

Performs object look up by path.

Parameters
relativePathPath of the object where to look at, separated by '.'
Returns
Data object that was found, or null if there was no such object.

Reimplemented in DataSource.

◆ removeModifiedNotificationHandler()

void removeModifiedNotificationHandler ( DataContext.ModifiedSubscriptionToken token)

Removes a modification subscription.

Parameters
tokenToken to identify the subscription that should be removed.

Member Data Documentation

◆ metaclass

final Metaclass metaclass
static
Initial value:
=
com.rightware.kanzi.metadata.DataContextMetadata.metaclass

The Metaclass for the class.