DataObject Class Reference

DataObject is a node in a tree of data. More...

Inheritance diagram for DataObject:

Public Member Functions
void	addChild (DataObject child)
	Adds data object as child of this object.
DataObject	getChild (int index)
	Retrieves a child object in given index.
int	getChildCount ()
	Retrieves the count of child objects in this data object.
int	getChildIndex (DataObject child)
	Retrieves the index of a child data object.
String	getName ()
	Allows to retrieve the name of the object.
DataObject	getParent ()
	Retrieves the parent DataObject of this DataObject.
DataObjectType	getType ()
	Allows to retrieve the name of the object.
Object	getValue ()
	Gets the value as a boxed Object.
boolean	hasChild (DataObject child)
	Checks whether or not the child exists.
void	insertChild (int index, DataObject child)
	Inserts data object as child of this object, allows to specify index of the object.
Iterable< DataObject >	iterateChildren ()
	Gets an Iterable object used to iterate the DataObject children.
void	removeAllChildren ()
	Removes all children.
void	removeChild (DataObject child)
	Removes a child object from list of childs.
void	removeChild (int index)
	Removes a child object in given index.
void	setName (String name)
	Sets the name of the DataObject.
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.
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	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< TType >	tryCreateObjectRef (Class< TType > clazz)
	Tries to create an owning ObjectRef instance to this KanziObject.

Static Public Member Functions
static< ObjectType extends DataObject > ObjectRef< ObjectType >	create (Domain domain, String name)
	Creates a DataObject.

Static Public Attributes
static final Metaclass	metaclass
	The Metaclass for the class.
Static Public Attributes inherited from DataContext
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< Resource >	DataContextProperty
	Source of data for this node and its descendants.
DynamicPropertyType< Resource >	ItemsSourceProperty
	Data object which provides data sources for list items.
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.DataContext")
	Metaclass for DataContext.
Public Attributes inherited from DataObjectMetadata
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.DataObject")
	Metaclass for DataObject.

Detailed Description

DataObject is a node in a tree of 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

addChild()

void addChild

(

DataObject

child

)

Adds data object as child of this object.

Parameters

child

Child object to add.

create()

static< ObjectType extends DataObject > ObjectRef< ObjectType > create ( Domain domain, String name )

static

Creates a DataObject.

Parameters

domain	UI Domain where this DataObject belongs.
name	The name of the DataObject.

Reimplemented in DataObjectBool, DataObjectInt, DataObjectReal, and DataObjectString.

getChild()

DataObject getChild

(

int

index

)

Retrieves a child object in given index.

Returns

Child data object in given index.

getChildCount()

int getChildCount

(

)

Retrieves the count of child objects in this data object.

Returns

Child object count.

getChildIndex()

int getChildIndex

(

DataObject

child

)

Retrieves the index of a child data object.

Returns

Index of the item in question, throws exception if there is no such child.

getName()

String getName

(

)

Allows to retrieve the name of the object.

Returns

Returns the name of the object.

Reimplemented from Resource.

getParent()

DataObject getParent

(

)

Retrieves the parent DataObject of this DataObject.

Returns

The parent DataObject of this DataObject.

getType()

DataObjectType getType

(

)

Allows to retrieve the name of the object.

Returns

Returns the type of the object.

getValue()

Object getValue

(

)

Gets the value as a boxed Object.

Returns

Returns the value as an Object.

Reimplemented in DataObjectBool, DataObjectInt, DataObjectReal, and DataObjectString.

hasChild()

boolean hasChild

(

DataObject

child

)

Checks whether or not the child exists.

Returns

true if there is such child, otherwise false.

insertChild()

void insertChild	(	int	index,
		DataObject	child )

Inserts data object as child of this object, allows to specify index of the object.

Parameters

index	Index where to add given object.
child	Child object to add.

iterateChildren()

Iterable< DataObject > iterateChildren

(

)

Gets an Iterable object used to iterate the DataObject children.

Returns

An iterable of DataObject children.

removeChild() [1/2]

void removeChild

(

DataObject

child

)

Removes a child object from list of childs.

Parameters

child

Child object to remove.

removeChild() [2/2]

void removeChild

(

int

index

)

Removes a child object in given index.

Parameters

index

of the child object to remove.

setName()

void setName

(

String

name

)

Sets the name of the DataObject.

Parameters

name

The name

Member Data Documentation

metaclass

final Metaclass metaclass

static

Initial value:

=
        com.rightware.kanzi.metadata.DataObjectMetadata.metaclass

The Metaclass for the class.