com.sparsity.sparksee.gdb.ValueArray Class Reference

ValueArray class. More...

Public Member Functions
long[]	GetOID (int index, int size)
	Get a subset of the Values from this long array.
long[]	GetLong ()
	Get all the Values from this long array.
void	SetBoolean (int index, bool[] values) throws System.ApplicationException, System.ArgumentException, System.ApplicationException
	Set a subset of the values of this bool array.
bool[]	GetBoolean (int index, int size)
	Get a subset of the Values from this boolean array.
void	SetDouble (int index, double[] values) throws System.ApplicationException, System.ArgumentException, System.ApplicationException
	Set a subset of the values of this double array.
void	SetInteger (int[] values) throws System.ApplicationException, System.ApplicationException
	Set all the values of this int array.
double[]	GetDouble ()
	Get all the Values from this double array.
long[]	GetTimestamp ()
	Get all the Values from this timestamp array.
bool[]	GetBoolean ()
	Get all the Values from this boolean array.
boolean	IsClosed ()
	Gets if ValueArray instance has been closed or not.
void	SetTimestamp (long[] values) throws System.ApplicationException, System.ApplicationException
	Set all the values of this timestamp array.
void	Set (int index, com.sparsity.sparksee.gdb.Value value) throws System.ApplicationException, System.ArgumentException
	Set a Value to a specific array position.
void	Close ()
	Closes the ValueArray instance.
void	SetLong (long[] values) throws System.ApplicationException, System.ApplicationException
	Set all the values of this long array.
int[]	GetInteger (int index, int size)
	Get a subset of the Values from this int array.
void	SetLong (int index, long[] values) throws System.ApplicationException, System.ArgumentException, System.ApplicationException
	Set a subset of the values of this long array.
long[]	GetTimestamp (int index, int size)
	Get a subset of the Values from this timestamp array.
void	SetDouble (double[] values) throws System.ApplicationException, System.ApplicationException
	Set all the values of this double array.
void	SetOID (long[] values) throws System.ApplicationException, System.ApplicationException
	Set all the values of this oid array.
void	SetTimestamp (int index, long[] values) throws System.ApplicationException, System.ArgumentException, System.ApplicationException
	Set a subset of the values of this timestamp array.
long[]	GetLong (int index, int size)
	Get a subset of the Values from this long array.
void	MakeNull () throws System.ApplicationException
	Sets the attribute array to Null.
void	SetBoolean (bool[] values) throws System.ApplicationException, System.ApplicationException
	Set all the values of this bool array.
long[]	GetOID ()
	Get all the Values from this OID array.
double[]	GetDouble (int index, int size)
	Get a subset of the Values from this double array.
int[]	GetInteger ()
	Get all the Values from this int array.
int	Size ()
	Returns the array size.
void	Set (com.sparsity.sparksee.gdb.Value value) throws System.ApplicationException, System.ArgumentException
	Set a Value to the whole array.
void	SetOID (int index, long[] values) throws System.ApplicationException, System.ArgumentException, System.ApplicationException
	Set a subset of the values of this oid array.
void	Get (int index, com.sparsity.sparksee.gdb.Value value) throws System.ApplicationException, System.ArgumentException
	Get a Value from the array.
void	SetInteger (int index, int[] values) throws System.ApplicationException, System.ArgumentException, System.ApplicationException
	Set a subset of the values of this int array.

Detailed Description

ValueArray class.

It allows for getting and setting ValueArray attribute values.

It is very important to close the ValueArray once no more get or set operations will be performed.

Creation of a new ValueArray: (i) Set all the ValueArray elements using Graph::SetAttributeArray (ii) perform as many get/set operations as you need to the ValueArray instance. Lastly, (iii) Close the ValueArray

Use of an existing ValueArray: (i) Get a ValueArray instance using Graph::GetAttributeArray (ii) perform as many get/set operations as you need to the ValueArray instance. Lastly, (iii) Close the ValueArray

Check out the 'Attributes and values' section in the SPARKSEE User Manual for more details on this.

Author

Sparsity Technologies http://www.sparsity-technologies.com

Member Function Documentation

void com.sparsity.sparksee.gdb.ValueArray.Close

(

)

Closes the ValueArray instance.

It must be called to ensure the integrity of all data.

void com.sparsity.sparksee.gdb.ValueArray.Get	(	int	index,
		com.sparsity.sparksee.gdb.Value	value
	)		throws System.ApplicationException, System.ArgumentException

Get a Value from the array.

AppErrorIf the ValueArray is not available

Parameters

index	[in] Position of the element to get [0..N-1]
value	[out] Value to get the array element

Exceptions

System.ApplicationException	null
System.ArgumentException	If the index is out of range or the Value not valid

bool [] com.sparsity.sparksee.gdb.ValueArray.GetBoolean	(	int	index,
		int	size
	)

Get a subset of the Values from this boolean array.

Parameters

index	Position of the first element to get [0..N-1]
size	Number of elements to get [1..N]

Returns

Returns all the requested values

bool [] com.sparsity.sparksee.gdb.ValueArray.GetBoolean

(

)

Get all the Values from this boolean array.

Returns

Returns all the values

double [] com.sparsity.sparksee.gdb.ValueArray.GetDouble

(

)

Get all the Values from this double array.

Returns

Returns all the values

double [] com.sparsity.sparksee.gdb.ValueArray.GetDouble	(	int	index,
		int	size
	)

Get a subset of the Values from this double array.

Parameters

index	Position of the first element to get [0..N-1]
size	Number of elements to get [1..N]

Returns

Returns all the requested values

int [] com.sparsity.sparksee.gdb.ValueArray.GetInteger	(	int	index,
		int	size
	)

Get a subset of the Values from this int array.

Parameters

index	Position of the first element to get [0..N-1]
size	Number of elements to get [1..N]

Returns

Returns all the requested values

int [] com.sparsity.sparksee.gdb.ValueArray.GetInteger

(

)

Get all the Values from this int array.

Returns

Returns all the values

long [] com.sparsity.sparksee.gdb.ValueArray.GetLong

(

)

Get all the Values from this long array.

Returns

Returns all the values

long [] com.sparsity.sparksee.gdb.ValueArray.GetLong	(	int	index,
		int	size
	)

Get a subset of the Values from this long array.

Parameters

index	Position of the first element to get [0..N-1]
size	Number of elements to get [1..N]

Returns

Returns all the requested values

long [] com.sparsity.sparksee.gdb.ValueArray.GetOID	(	int	index,
		int	size
	)

Get a subset of the Values from this long array.

Parameters

index	Position of the first element to get [0..N-1]
size	Number of elements to get [1..N]

Returns

Returns all the requested values

long [] com.sparsity.sparksee.gdb.ValueArray.GetOID

(

)

Get all the Values from this OID array.

Returns

Returns all the values

long [] com.sparsity.sparksee.gdb.ValueArray.GetTimestamp

(

)

Get all the Values from this timestamp array.

Returns

Returns all the values

long [] com.sparsity.sparksee.gdb.ValueArray.GetTimestamp	(	int	index,
		int	size
	)

Get a subset of the Values from this timestamp array.

Parameters

index	Position of the first element to get [0..N-1]
size	Number of elements to get [1..N]

Returns

Returns all the requested values

boolean com.sparsity.sparksee.gdb.ValueArray.IsClosed

(

)

Gets if ValueArray instance has been closed or not.

See Also

Close()

Returns

TRUE if the ValueArray instance has been closed, FALSE otherwise.

void com.sparsity.sparksee.gdb.ValueArray.MakeNull

(

)

throws System.ApplicationException

Sets the attribute array to Null.

The ValueArray can not be used after this call.

Exceptions

System.ApplicationException

null

void com.sparsity.sparksee.gdb.ValueArray.Set	(	int	index,
		com.sparsity.sparksee.gdb.Value	value
	)		throws System.ApplicationException, System.ArgumentException

Set a Value to a specific array position.

AppErrorIf the ValueArray is not available

Parameters

index	[in] Position of the element to set [0..N-1]
value	[in] Value to set in the array element

Exceptions

System.ApplicationException	null
System.ArgumentException	If the index is out of range or the Value not valid

void com.sparsity.sparksee.gdb.ValueArray.Set

(

com.sparsity.sparksee.gdb.Value

value

)

throws System.ApplicationException, System.ArgumentException

Set a Value to the whole array.

AppErrorIf the ValueArray is not available

Parameters

value

[in] Value to set in all the array elements

Exceptions

System.ApplicationException	null
System.ArgumentException	If the Value is not valid

void com.sparsity.sparksee.gdb.ValueArray.SetBoolean	(	int	index,
		bool[]	values
	)		throws System.ApplicationException, System.ArgumentException, System.ApplicationException

Set a subset of the values of this bool array.

UnsupportedOperationErrorIf array DataType is not bool AppErrorIf the ValueArray is not available

Parameters

index	[in] Position of the first element to set [0..N-1]
values	The values to set

Exceptions

System.ApplicationException	null
System.ArgumentException	If the index or size is out of range
System.ApplicationException	null

void com.sparsity.sparksee.gdb.ValueArray.SetBoolean

(

bool[]

values

)

throws System.ApplicationException, System.ApplicationException

Set all the values of this bool array.

AppErrorIf the ValueArray is not available

Parameters

values

All the values to set

Exceptions

System.ApplicationException	If array DataType is not bool
System.ApplicationException	null

void com.sparsity.sparksee.gdb.ValueArray.SetDouble	(	int	index,
		double[]	values
	)		throws System.ApplicationException, System.ArgumentException, System.ApplicationException

Set a subset of the values of this double array.

UnsupportedOperationErrorIf array DataType is not Double AppErrorIf the ValueArray is not available

Parameters

index	[in] Position of the first element to set [0..N-1]
values	The values to set

Exceptions

System.ApplicationException	null
System.ArgumentException	If the index or size is out of range
System.ApplicationException	null

void com.sparsity.sparksee.gdb.ValueArray.SetDouble

(

double[]

values

)

throws System.ApplicationException, System.ApplicationException

Set all the values of this double array.

AppErrorIf the ValueArray is not available

Parameters

values

All the values to set

Exceptions

System.ApplicationException	If array DataType is not Double
System.ApplicationException	null

void com.sparsity.sparksee.gdb.ValueArray.SetInteger

(

int[]

values

)

throws System.ApplicationException, System.ApplicationException

Set all the values of this int array.

AppErrorIf the ValueArray is not available

Parameters

values

All the values to set

Exceptions

System.ApplicationException	If array DataType is not int
System.ApplicationException	null

void com.sparsity.sparksee.gdb.ValueArray.SetInteger	(	int	index,
		int[]	values
	)		throws System.ApplicationException, System.ArgumentException, System.ApplicationException

Set a subset of the values of this int array.

UnsupportedOperationErrorIf array DataType is not int AppErrorIf the ValueArray is not available

Parameters

index	[in] Position of the first element to set [0..N-1]
values	The values to set

Exceptions

System.ApplicationException	null
System.ArgumentException	If the index or size is out of range
System.ApplicationException	null

void com.sparsity.sparksee.gdb.ValueArray.SetLong

(

long[]

values

)

throws System.ApplicationException, System.ApplicationException

Set all the values of this long array.

AppErrorIf the ValueArray is not available

Parameters

values

All the values to set

Exceptions

System.ApplicationException	If array DataType is not long
System.ApplicationException	null

void com.sparsity.sparksee.gdb.ValueArray.SetLong	(	int	index,
		long[]	values
	)		throws System.ApplicationException, System.ArgumentException, System.ApplicationException

Set a subset of the values of this long array.

UnsupportedOperationErrorIf array DataType is not long AppErrorIf the ValueArray is not available

Parameters

index	[in] Position of the first element to set [0..N-1]
values	The values to set

Exceptions

System.ApplicationException	null
System.ArgumentException	If the index or size is out of range
System.ApplicationException	null

void com.sparsity.sparksee.gdb.ValueArray.SetOID

(

long[]

values

)

throws System.ApplicationException, System.ApplicationException

Set all the values of this oid array.

AppErrorIf the ValueArray is not available

Parameters

values

All the values to set

Exceptions

System.ApplicationException	If array DataType is not oid
System.ApplicationException	null

void com.sparsity.sparksee.gdb.ValueArray.SetOID	(	int	index,
		long[]	values
	)		throws System.ApplicationException, System.ArgumentException, System.ApplicationException

Set a subset of the values of this oid array.

UnsupportedOperationErrorIf array DataType is not oid AppErrorIf the ValueArray is not available

Parameters

index	[in] Position of the first element to set [0..N-1]
values	The values to set

Exceptions

System.ApplicationException	null
System.ArgumentException	If the index or size is out of range
System.ApplicationException	null

void com.sparsity.sparksee.gdb.ValueArray.SetTimestamp

(

long[]

values

)

throws System.ApplicationException, System.ApplicationException

Set all the values of this timestamp array.

AppErrorIf the ValueArray is not available

Parameters

values

All the values to set

Exceptions

System.ApplicationException	If array DataType is not timestamp
System.ApplicationException	null

void com.sparsity.sparksee.gdb.ValueArray.SetTimestamp	(	int	index,
		long[]	values
	)		throws System.ApplicationException, System.ArgumentException, System.ApplicationException

Set a subset of the values of this timestamp array.

UnsupportedOperationErrorIf array DataType is not timestamp AppErrorIf the ValueArray is not available

Parameters

index	[in] Position of the first element to set [0..N-1]
values	The values to set

Exceptions

System.ApplicationException	null
System.ArgumentException	If the index or size is out of range
System.ApplicationException	null