Pr22.Util

Class Variant

java.lang.Object

Pr22.Util.Variant

public class Variant
extends java.lang.Object

Class for variant data management. The Variant class stores references to the variant data objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Variant.ListT Value used for constructing a list type variant.
static class	Variant.NullT Value used for constructing a NULL type variant.
static class	Variant.Types Available variant types.

Constructor Summary

Constructors

Constructor and Description
Variant() Defines an empty variant class.
Variant(int id, byte[] val) Constructor, defines a byte array type variant class.
Variant(int id, double val) Constructor, defines a floating point type variant class.
Variant(int id, float val) Constructor, defines a floating point type variant class.
Variant(int id, Frame frame) Constructor, defines a frame type variant class.
Variant(int id, int val) Constructor, defines an integer type variant class.
Variant(int id, int[] val) Constructor, defines an integer array type variant class.
Variant(int id, long val) Constructor, defines a long type variant class.
Variant(int id, java.lang.String val) Constructor, defines a string type variant class.
Variant(int id, Variant.ListT listT) Constructor, defines a list type variant class.
Variant(int id, Variant.NullT nullt) Constructor, defines a NULL type variant class.
Variant(java.lang.String name, byte[] val) Constructor, defines a byte array type variant class.
Variant(java.lang.String name, double val) Constructor, defines a floating point type variant class.
Variant(java.lang.String name, float val) Constructor, defines a floating point type variant class.
Variant(java.lang.String name, Frame frame) Constructor, defines a frame type variant class.
Variant(java.lang.String name, int val) Constructor, defines an integer type variant class.
Variant(java.lang.String name, int[] val) Constructor, defines an integer array type variant class.
Variant(java.lang.String name, long val) Constructor, defines a long type variant class.
Variant(java.lang.String name, java.lang.String val) Constructor, defines a string type variant class.
Variant(java.lang.String name, Variant.ListT listT) Constructor, defines a list type variant class.
Variant(java.lang.String name, Variant.NullT nullt) Constructor, defines a NULL type variant class.
Variant(Variant source) References an existing variant.

Method Summary

Modifier and Type	Method and Description
Variant	addChild(Variant item) Adds a child element to the variant.
Variant	addChild(Variant item, VariantPos position) Adds a child element to the variant.
Variant	addListItem(Variant item) Adds an item to the list type variant.
Variant	addListItem(Variant item, VariantPos position) Adds an item to the list type variant.
Variant	at(int ix) Returns an item of the list type variant.
Variant	changeToList() Modifies an existing variant to list type.
Variant	clear() Modifies an existing variant to NULL type.
Variant	create(int id, java.lang.String name) Creates a NULL type variant structure.
Variant	create(int id, java.lang.String name, double data) Creates a floating point type variant structure.
Variant	create(int id, java.lang.String name, float data) Creates a floating point type variant structure.
Variant	create(int id, java.lang.String name, Frame data) Creates a frame type variant structure.
Variant	create(int id, java.lang.String name, int data) Creates an integer type variant structure.
Variant	create(int id, java.lang.String name, long data) Creates a long type variant structure.
Variant	create(int id, java.lang.String name, java.lang.String data) Creates a string type variant structure.
Variant	createArray(int id, java.lang.String name, byte[] varray) Creates a byte type variant array structure.
Variant	createArray(int id, java.lang.String name, int[] varray) Creates and integer type variant array structure.
Variant	createList(int id, java.lang.String name) Creates a list type variant structure.
Variant	duplicate() Duplicates, copies the variant and all of its descendants.
Variant	getChild(int id, int ix) Returns a child of a variant.
Variant	getChild(java.lang.String name, int ix) Returns a child of a variant.
Variant	getChild(VariantPos position) Returns a child of a variant.
Variant	getChildByIndex(int ix) Returns a child of a variant.
int	getId() Returns the Id of the variant.
Variant	getItemByPath(java.lang.String path) Returns a variant from a tree.
Variant	getListItem(int ix) Returns an item of the list type variant.
Variant	getListItem(VariantPos position) Returns an item of the list type variant.
java.lang.String	getName() Returns the name of the variant.
int	getNChildren() Returns the number of children in the variant.
int	getNItems() Returns the number of items in the variant.
int	getSize() Returns the item size of the variant.
Variant.Types	getType() Returns the type of the variant.
Variant	leave() Finishes working with the actual variant object.
Variant	member(int id) Returns a child of a variant.
Variant	member(int id, int ix) Returns a child of a variant.
Variant	member(java.lang.String name) Returns a child of a variant.
Variant	member(java.lang.String name, int ix) Returns a child of a variant.
Variant	ref() References an existing variant to enable multiple Disposing.
Variant	setId(int id) Sets the Id of the variant.
Variant	setName(java.lang.String name) Sets the name of the variant.
byte[]	toByteArray() Returns the value of the variant converted to byte array.
double	toDouble() Returns the value of the variant converted to floating point.
float	toFloat() Returns the value of the variant converted to floating point.
Frame	toFrame() Returns the value of the variant converted to frame.
int	toInt() Returns the value of the variant converted to integer.
int[]	toIntArray() Returns the value of the variant converted to integer array.
long	toLong() Returns the value of the variant converted to long.
java.lang.String	toString() Returns the value of the variant converted to string.
java.lang.String	toStringEx() Returns the value of the variant converted to string or throws an exception.
Variant	update(double data) Modifies the type and the value of an existing variant.
Variant	update(float data) Modifies the type and the value of an existing variant.
Variant	update(Frame data) Modifies the type and the value of an existing variant.
Variant	update(int data) Modifies the type and the value of an existing variant.
Variant	update(long data) Modifies the type and the value of an existing variant.
Variant	update(java.lang.String data) Modifies the type and the value of an existing variant.
Variant	updateArray(byte[] varray) Modifies the type and the value of an existing variant.
Variant	updateArray(int[] varray) Modifies the type and the value of an existing variant.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Variant

public Variant()

Defines an empty variant class. Empty variants cannot be modified without using a create method.

Variant

public Variant(Variant source)
        throws General

References an existing variant.

Parameters:

source - Source variant.

Throws:

General

Variant

public Variant(int id,
               Variant.NullT nullt)
        throws General

Constructor, defines a NULL type variant class.

Parameters:

id - The Id of the variant.

nullt - Value used for constructing a NULL type variant.

Throws:

General

Variant

public Variant(java.lang.String name,
               Variant.NullT nullt)
        throws General

Constructor, defines a NULL type variant class.

Parameters:

name - The name of the variant.

nullt - Value used for constructing a NULL type variant.

Throws:

General

Variant

public Variant(int id,
               int val)
        throws General

Constructor, defines an integer type variant class.

Parameters:

id - The Id of the variant.

val - The value of the variant.

Throws:

General

Variant

public Variant(java.lang.String name,
               int val)
        throws General

Constructor, defines an integer type variant class.

Parameters:

name - The name of the variant.

val - The value of the variant.

Throws:

General

Variant

public Variant(int id,
               long val)
        throws General

Constructor, defines a long type variant class.

Parameters:

id - The Id of the variant.

val - The value of the variant.

Throws:

General

Variant

public Variant(java.lang.String name,
               long val)
        throws General

Constructor, defines a long type variant class.

Parameters:

name - The name of the variant.

val - The value of the variant.

Throws:

General

Variant

public Variant(int id,
               float val)
        throws General

Constructor, defines a floating point type variant class.

Parameters:

id - The Id of the variant.

val - The value of the variant.

Throws:

General

Variant

public Variant(java.lang.String name,
               float val)
        throws General

Constructor, defines a floating point type variant class.

Parameters:

name - The name of the variant.

val - The value of the variant.

Throws:

General

Variant

public Variant(int id,
               double val)
        throws General

Constructor, defines a floating point type variant class.

Parameters:

id - The Id of the variant.

val - The value of the variant.

Throws:

General

Variant

public Variant(java.lang.String name,
               double val)
        throws General

Constructor, defines a floating point type variant class.

Parameters:

name - The name of the variant.

val - The value of the variant.

Throws:

General

Variant

public Variant(int id,
               java.lang.String val)
        throws General

Constructor, defines a string type variant class.

Parameters:

id - The Id of the variant.

val - The value of the variant.

Throws:

General

Variant

public Variant(java.lang.String name,
               java.lang.String val)
        throws General

Constructor, defines a string type variant class.

Parameters:

name - The name of the variant.

val - The value of the variant.

Throws:

General

Variant

public Variant(int id,
               int[] val)
        throws General

Constructor, defines an integer array type variant class.

Parameters:

id - The Id of the variant.

val - The value of the variant.

Throws:

General

Variant

public Variant(java.lang.String name,
               int[] val)
        throws General

Constructor, defines an integer array type variant class.

Parameters:

name - The name of the variant.

val - The value of the variant.

Throws:

General

Variant

public Variant(int id,
               byte[] val)
        throws General

Constructor, defines a byte array type variant class.

Parameters:

id - The Id of the variant.

val - The value of the variant.

Throws:

General

Variant

public Variant(java.lang.String name,
               byte[] val)
        throws General

Constructor, defines a byte array type variant class.

Parameters:

name - The name of the variant.

val - The value of the variant.

Throws:

General

Variant

public Variant(int id,
               Frame frame)
        throws General

Constructor, defines a frame type variant class.

Parameters:

id - The Id of the variant.

frame - The value of the variant.

Throws:

General

Variant

public Variant(java.lang.String name,
               Frame frame)
        throws General

Constructor, defines a frame type variant class.

Parameters:

name - The name of the variant.

frame - The value of the variant.

Throws:

General

Variant

public Variant(int id,
               Variant.ListT listT)
        throws General

Constructor, defines a list type variant class.

Parameters:

id - The Id of the variant.

listT - Value used for constructing a list type variant.

Throws:

General

Variant

public Variant(java.lang.String name,
               Variant.ListT listT)
        throws General

Constructor, defines a list type variant class.

Parameters:

name - The name of the variant.

listT - Value used for constructing a list type variant.

Throws:

General

Method Detail

leave

public Variant leave()
              throws General

Finishes working with the actual variant object. The class became an empty variant class. Empty variants cannot be modified without using a create method.

Returns:

The variant object.

Throws:

General

getId

public int getId()
          throws General

Returns the Id of the variant.

Returns:

The Id of the variant.

Throws:

General

setId

public Variant setId(int id)
              throws General

Sets the Id of the variant.

Parameters:

id - The new Id of the variant.

Returns:

The variant object.

Throws:

General

getName

public java.lang.String getName()
                         throws General

Returns the name of the variant.

Returns:

The name of the variant.

Throws:

General

setName

public Variant setName(java.lang.String name)
                throws General

Sets the name of the variant.

Parameters:

name - The new name of the variant.

Returns:

The variant object.

Throws:

General

getType

public Variant.Types getType()
                      throws General

Returns the type of the variant.

Returns:

The type of the variant.

Throws:

General

getSize

public int getSize()
            throws General

Returns the item size of the variant.

Returns:

The item size of the variant.

Throws:

General

getNItems

public int getNItems()
              throws General

Returns the number of items in the variant. This value is useful for array and list type variants.

Returns:

The number of items in the variant.

Throws:

General

duplicate

public Variant duplicate()
                  throws General

Duplicates, copies the variant and all of its descendants. The Variant class stores references to variant data objects. Modifying the data structure of a variant affects all the variables that references the same memory area. In order to avoid this behavior the variant can be duplicated before modification.

Returns:

The variant object references the copy of this variant.

Throws:

General

ref

public final Variant ref()
                  throws General

References an existing variant to enable multiple Disposing.

Returns:

The variant object references this variant.

Throws:

General

create

public final Variant create(int id,
                            java.lang.String name)
                     throws General

Creates a NULL type variant structure.

Parameters:

id - The Id of the variant.

name - The name of the variant.

Returns:

The variant object.

Throws:

General

clear

public final Variant clear()
                    throws General

Modifies an existing variant to NULL type.

Returns:

The variant object.

Throws:

General

create

public final Variant create(int id,
                            java.lang.String name,
                            int data)
                     throws General

Creates an integer type variant structure.

Parameters:

id - The Id of the variant.

name - The name of the variant.

data - The value of the variant.

Returns:

The variant object.

Throws:

General

update

public Variant update(int data)
               throws General

Modifies the type and the value of an existing variant.

Parameters:

data - The value of the variant.

Returns:

The variant object.

Throws:

General

toInt

public int toInt()
          throws General

Returns the value of the variant converted to integer.

Returns:

The value of the variant converted to integer.

Throws:

General

create

public final Variant create(int id,
                            java.lang.String name,
                            long data)
                     throws General

Creates a long type variant structure.

Parameters:

id - The Id of the variant.

name - The name of the variant.

data - The value of the variant.

Returns:

The variant object.

Throws:

General

update

public Variant update(long data)
               throws General

Modifies the type and the value of an existing variant.

Parameters:

data - The value of the variant.

Returns:

The variant object.

Throws:

General

toLong

public long toLong()
            throws General

Returns the value of the variant converted to long.

Returns:

The value of the variant converted to long.

Throws:

General

create

public final Variant create(int id,
                            java.lang.String name,
                            float data)
                     throws General

Creates a floating point type variant structure.

Parameters:

id - The Id of the variant.

name - The name of the variant.

data - The value of the variant.

Returns:

The variant object.

Throws:

General

update

public Variant update(float data)
               throws General

Modifies the type and the value of an existing variant.

Parameters:

data - The value of the variant.

Returns:

The variant object.

Throws:

General

toFloat

public float toFloat()
              throws General

Returns the value of the variant converted to floating point.

Returns:

The value of the variant converted to floating point.

Throws:

General

create

public final Variant create(int id,
                            java.lang.String name,
                            double data)
                     throws General

Creates a floating point type variant structure.

Parameters:

id - The Id of the variant.

name - The name of the variant.

data - The value of the variant.

Returns:

The variant object.

Throws:

General

update

public Variant update(double data)
               throws General

Modifies the type and the value of an existing variant.

Parameters:

data - The value of the variant.

Returns:

The variant object.

Throws:

General

toDouble

public double toDouble()
                throws General

Returns the value of the variant converted to floating point.

Returns:

The value of the variant converted to floating point.

Throws:

General

create

public final Variant create(int id,
                            java.lang.String name,
                            java.lang.String data)
                     throws General

Creates a string type variant structure.

Parameters:

id - The Id of the variant.

name - The name of the variant.

data - The value of the variant.

Returns:

The variant object.

Throws:

General

update

public Variant update(java.lang.String data)
               throws General

Modifies the type and the value of an existing variant.

Parameters:

data - The value of the variant.

Returns:

The variant object.

Throws:

General

toStringEx

public java.lang.String toStringEx()
                            throws General

Returns the value of the variant converted to string or throws an exception.

Returns:

The value of the variant converted to string.

Throws:

General

toString

public java.lang.String toString()

Returns the value of the variant converted to string.

Overrides:

toString in class java.lang.Object

Returns:

The value of the variant converted to string.

createArray

public final Variant createArray(int id,
                                 java.lang.String name,
                                 int[] varray)
                          throws General

Creates and integer type variant array structure.

Parameters:

id - The Id of the variant.

name - The name of the variant.

varray - The array.

Returns:

The variant object.

Throws:

General

updateArray

public Variant updateArray(int[] varray)
                    throws General

Modifies the type and the value of an existing variant.

Parameters:

varray - The array.

Returns:

The variant object.

Throws:

General

toIntArray

public int[] toIntArray()
                 throws General

Returns the value of the variant converted to integer array.

Returns:

The value of the variant converted to integer array.

Throws:

General

createArray

public final Variant createArray(int id,
                                 java.lang.String name,
                                 byte[] varray)
                          throws General

Creates a byte type variant array structure.

Parameters:

id - The Id of the variant.

name - The name of the variant.

varray - The array.

Returns:

The variant object.

Throws:

General

updateArray

public Variant updateArray(byte[] varray)
                    throws General

Modifies the type and the value of an existing variant.

Parameters:

varray - The array.

Returns:

The variant object.

Throws:

General

toByteArray

public byte[] toByteArray()
                   throws General

Returns the value of the variant converted to byte array.

Returns:

The value of the variant converted to byte array.

Throws:

General

create

public final Variant create(int id,
                            java.lang.String name,
                            Frame data)
                     throws General

Creates a frame type variant structure.

Parameters:

id - The Id of the variant.

name - The name of the variant.

data - The value of the variant.

Returns:

The variant object.

Throws:

General

update

public Variant update(Frame data)
               throws General

Modifies the type and the value of an existing variant.

Parameters:

data - The value of the variant.

Returns:

The variant object.

Throws:

General

toFrame

public Frame toFrame()
              throws General

Returns the value of the variant converted to frame.

Returns:

The value of the variant converted to frame.

Throws:

General

at

public Variant at(int ix)
           throws General

Returns an item of the list type variant.

Parameters:

ix - The index of the requested item.

Returns:

The requested item.

Throws:

General

createList

public final Variant createList(int id,
                                java.lang.String name)
                         throws General

Creates a list type variant structure.

Parameters:

id - The Id of the variant.

name - The name of the variant.

Returns:

The variant list object.

Throws:

General

changeToList

public Variant changeToList()
                     throws General

Modifies an existing variant to list type.

Returns:

The variant object.

Throws:

General

addListItem

public Variant addListItem(Variant item)
                    throws General

Adds an item to the list type variant. The variant lists contains references to variants, so if the appended item is changed the modification affects the item in the list too. To avoid this behavior the item can be duplicated before appending with the duplicate() method.

Parameters:

item - The item to add to the list.

Returns:

The variant list object.

Throws:

General

addListItem

public Variant addListItem(Variant item,
                           VariantPos position)
                    throws General

Adds an item to the list type variant. The variant lists contains references to variants, so if the appended item is changed the modification affects the item in the list too. To avoid this behavior the item can be duplicated before appending with the duplicate() method.

Parameters:

item - The item to add to the list.

position - The position to insert or append the new item.

Returns:

The variant list object.

Throws:

General

getListItem

public Variant getListItem(int ix)
                    throws General

Returns an item of the list type variant.

Parameters:

ix - The index of the requested item.

Returns:

The requested item.

Throws:

General

getListItem

public Variant getListItem(VariantPos position)
                    throws General

Returns an item of the list type variant.

Parameters:

position - The position of the requested item.

Returns:

The requested item.

Throws:

General

member

public Variant member(int id)
               throws General

Returns a child of a variant. If the requested child is missing this method creates it automatically.

Parameters:

id - The Id of the requested child.

Returns:

The requested child.

Throws:

General

member

public Variant member(int id,
                      int ix)
               throws General

Returns a child of a variant. If the requested child is missing and the ix parameter is 0 this method creates the child automatically.

Parameters:

id - The Id of the requested child.

ix - The index of the requested child.

Returns:

The requested child.

Throws:

General

member

public Variant member(java.lang.String name)
               throws General

Returns a child of a variant. If the requested child is missing this method creates it automatically.

Parameters:

name - The name of the requested child.

Returns:

The requested child.

Throws:

General

member

public Variant member(java.lang.String name,
                      int ix)
               throws General

Returns a child of a variant. If the requested child is missing and the ix parameter is 0 this method creates the child automatically.

Parameters:

name - The name of the requested child.

ix - The index of the requested child.

Returns:

The requested child.

Throws:

General

getNChildren

public int getNChildren()
                 throws General

Returns the number of children in the variant.

Returns:

The number of children in the variant.

Throws:

General

addChild

public Variant addChild(Variant item)
                 throws General

Adds a child element to the variant.

Parameters:

item - The new child to add to the children list.

Returns:

The variant object.

Throws:

General

addChild

public Variant addChild(Variant item,
                        VariantPos position)
                 throws General

Adds a child element to the variant.

Parameters:

item - The new child to add to the children list.

position - The position to insert or append the new child.

Returns:

The variant object.

Throws:

General

getChildByIndex

public Variant getChildByIndex(int ix)
                        throws General

Returns a child of a variant.

Parameters:

ix - The index of the requested child.

Returns:

The requested child.

Throws:

General

getChild

public Variant getChild(int id,
                        int ix)
                 throws General

Returns a child of a variant.

Parameters:

id - The Id of the requested child.

ix - The index of the requested child.

Returns:

The requested child.

Throws:

General

getChild

public Variant getChild(java.lang.String name,
                        int ix)
                 throws General

Returns a child of a variant.

Parameters:

name - The name of the requested child.

ix - The index of the requested child.

Returns:

The requested child.

Throws:

General

getChild

public Variant getChild(VariantPos position)
                 throws General

Returns a child of a variant.

Parameters:

position - The position of the requested child.

Returns:

The requested child.

Throws:

General

getItemByPath

public Variant getItemByPath(java.lang.String path)
                      throws General

Returns a variant from a tree. The variant data type can constitute a tree structure: every item in the tree is a variant. These variants can have child items that are also variants. The trees can be traversed level by level with the help of getChild(VariantPos position) and getListItem(VariantPos position) methods. If there is a need to reach a descendant variant located on a lower level, this method should be used instead. The item in the tree can be obtained by the path string that defines the exact location of the requested variant and has the following format: condition[=value] [,condition[=value]] [/condition[=value] [,condition[=value]]]

The path contains separators:

• the '/' separates the levels of the tree,
• the ',' separates the search conditions of a node,
• the '=' signs that a value follows,

and identifiers:

• the 'C' selects a child item,
• the 'L' selects a list item,
• the 'X' signs that the value defines the index of the item,
• the 'D' signs that the value defines the Id of the item,
• the 'N' signs that the value defines the name of the item,
• the 'V' signs that the value defines the value of the item.

The values are used as integers except 'name' values that have to be quoted with " or ' character; and 'value' values that may be quoted with " or ' character to sign that string comparison is required. Indexing is made by order.

Parameters:

path - The path string.

Returns:

The requested descendant item.

Throws:

General