Kanzi  3.9.5
Java API
DataObjectList Class Referenceabstract

DataObjectList is a specialization of DataObject for list data. More...

Inheritance diagram for DataObjectList:
[legend]

Public Member Functions

abstract DataObject acquireItem (int index)
 Acquires an item from the list at the provided index. More...
 
void close ()
 Close the object, and release native resources.
 
abstract ObjectRef<? extends DataObjectgetItemTemplate ()
 Returns tree structure of the data source for individual list item. More...
 
abstract int itemCount ()
 Gets the count of items in the list. More...
 
abstract void releaseItem (int index)
 Release the memory resources associated with a particular item. More...
 
- Public Member Functions inherited from DataObject
void addChild (DataObject child)
 Adds data object as child of this object. More...
 
DataObject getChild (int index)
 Retrieves a child object in given index. More...
 
int getChildCount ()
 Retrieves the count of child objects in this data object. More...
 
int getChildIndex (DataObject child)
 Retrieves the index of a child data object. More...
 
String getName ()
 Allows to retrieve the name of the object. More...
 
DataObject getParent ()
 Retrieves the parent DataObject of this DataObject. More...
 
DataObjectType getType ()
 Allows to retrieve the name of the object. More...
 
Object getValue ()
 Gets the value as a boxed Object. More...
 
boolean hasChild (DataObject child)
 Checks whether or not the child exists. More...
 
void insertChild (int index, DataObject child)
 Inserts data object as child of this object, allows to specify index of the object. More...
 
Iterable< DataObjectiterateChildren ()
 Gets an Iterable object used to iterate the DataObject children. More...
 
void removeAllChildren ()
 Removes all children.
 
void removeChild (DataObject child)
 Removes a child object from list of childs. More...
 
void removeChild (int index)
 Removes a child object in given index. More...
 
void setName (String name)
 Sets the name of the DataObject. More...
 
void setParent (DataObject parent)
 Assigns a parent DataObject to this DataObject.
 
- Public Member Functions inherited from DataContext
ModifiedSubscriptionToken addModifiedNotificationHandler (ModifiedSubscriptionFunction modifiedHandlerFunction)
 Allows to subscribe to modifications in this data context. More...
 
DataObject getData ()
 Retrieves the root object of the underlying data tree. More...
 
DataContext lookupDataContext (String relativePath)
 Performs object look up by path. More...
 
void notifyModified ()
 Triggers modification procedure in this data context, which invokes the subscriptions.
 
void removeModifiedNotificationHandler (DataContext.ModifiedSubscriptionToken token)
 Removes a modification subscription. More...
 
- Public Member Functions inherited from Resource
String getName ()
 Gets the resource name. More...
 
String getUrl ()
 Gets the resource URL. More...
 
void setKeepAlive (boolean keepAlive)
 Sets the keep alive flag. More...
 
- Public Member Functions inherited from KanziObject
boolean equals (Object object)
 
Domain getDomain ()
 Returns the domain the object belongs to. More...
 
Metaclass getDynamicMetaclass ()
 Returns the metaclass of the dynamic type of the object. More...
 
long getNative ()
 Gets a pointer to the backing C++ instance. More...
 
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. More...
 
TDataType getProperty (PropertyType< TDataType > propertyType)
 Returns the current value of a property type. More...
 
EnumType getProperty (PropertyType< Integer > propertyType, Class< EnumType > enumClass)
 Returns the current value of an integer property type converted to a matching constant from specified enumeration. More...
 
int hashCode ()
 
boolean hasValue (PropertyType< TDataType > propertyType)
 Evaluates whether there are any inputs into the property value. More...
 
boolean isStale ()
 Test if the object is stale i.e. More...
 
void removeLocalValue (PropertyType< TDataType > propertyType)
 Removes the local value associated with the property. More...
 
void setProperty (PropertyType< TDataType > propertyType, TDataType value)
 Sets the local value of a property type. More...
 
void setProperty (PropertyType< Integer > propertyType, EnumType value)
 Sets the local value of an integer property type using a constant from an enumeration. More...
 

Static Public Attributes

static final Metaclass metaclass
 The Metaclass for the class. More...
 
- Static Public Attributes inherited from DataObject
static final Metaclass metaclass
 The Metaclass for the class. More...
 
- Static Public Attributes inherited from DataContext
static final Metaclass metaclass
 The Metaclass for the class. More...
 
- Static Public Attributes inherited from Resource
static final Metaclass metaclass = com.rightware.kanzi.metadata.ResourceMetadata.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.
 

Protected Member Functions

 DataObjectList (Domain domain, long nativeObject, Metaclass metaclass)
 Wraps a given native DataObjectList Called by KanziObject.connectResource(long) when connecting to a native DataObjectList. More...
 
void initialize ()
 Initializes the DataObjectList.
 

Static Protected Member Functions

static< Derived extends DataObjectList > ObjectRef< Derived > createDerived (Domain domain, String name, Metaclass metaclass)
 Creates a derived class instance. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from DataObject
static< ObjectType extends DataObject > ObjectRef< ObjectType > create (Domain domain, String name)
 Creates a DataObject. More...
 
- 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. More...
 
DynamicPropertyType< ResourceItemsSourceProperty
 Data object which provides data sources for list items. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.DataContext")
 Metaclass for DataContext.
 
- Public Attributes inherited from DataObjectMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.DataObject")
 Metaclass for DataObject.
 
- Public Attributes inherited from DataObjectListMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.DataObjectList")
 Metaclass for DataObjectList.
 

Detailed Description

DataObjectList is a specialization of DataObject for list data.

Constructor & Destructor Documentation

◆ DataObjectList()

DataObjectList ( Domain  domain,
long  nativeObject,
Metaclass  metaclass 
)
protected

Wraps a given native DataObjectList Called by KanziObject.connectResource(long) when connecting to a native DataObjectList.

Parameters
domainUI Domain where this DataObjectList belongs
nativeObjectNative object that is backing this DataObjectList
metaclassMetaclass data for this DataObjectList

Member Function Documentation

◆ acquireItem()

abstract DataObject acquireItem ( int  index)
abstract

Acquires an item from the list at the provided index.

Parameters
indexThe item index
Returns
The DataObject

◆ createDerived()

static <Derived extends DataObjectList> ObjectRef<Derived> createDerived ( Domain  domain,
String  name,
Metaclass  metaclass 
)
staticprotected

Creates a derived class instance.

Call this method as part of the create method for a derived class.

Parameters
domainUI Domain where this data object belongs.
nameName of the data object
metaclassMetaclass data of the data object.
Returns
An ObjectRef that holds the created instance.

◆ getItemTemplate()

abstract ObjectRef<? extends DataObject> getItemTemplate ( )
abstract

Returns tree structure of the data source for individual list item.

Only hierarchy and object types are valid, the data might not be.

Returns
template of an individual item

◆ itemCount()

abstract int itemCount ( )
abstract

Gets the count of items in the list.

Returns
number of items in the list

◆ releaseItem()

abstract void releaseItem ( int  index)
abstract

Release the memory resources associated with a particular item.

Parameters
indexThe item index.

Member Data Documentation

◆ metaclass

final Metaclass metaclass
static