com.taursys.model
Class ObjectArrayValueHolder

java.lang.Object
  com.taursys.model.AbstractValueHolder
      com.taursys.model.ObjectArrayValueHolder

All Implemented Interfaces:

java.util.Collection, CollectionValueHolder, ValueHolder

public class ObjectArrayValueHolder

extends AbstractValueHolder

implements CollectionValueHolder

ValueHolder which stores an array of objects. The get/setPropertyValue methods simply return the object in the current position.

Constructor Summary

ObjectArrayValueHolder()
Constructs a new ObjectArrayValueHolder.

ObjectArrayValueHolder(java.lang.Object[] newArray)
Constructs a new ObjectArrayValueHolder with the given array.

Method Summary

boolean	add(java.lang.Object o) Ensures that the underlying collection of this holder contains the specified element (optional operation).
boolean	addAll(java.util.Collection c) Adds all of the elements in the specified collection to the underlying collection of this holder (optional operation).
void	clear() Removes all of the elements from the underlying collection of this holder (optional operation).
boolean	contains(java.lang.Object o) Returns true if the underlying collection of this holder contains the specified element.
boolean	containsAll(java.util.Collection c) Returns true if the underlying collection of this holder contains all of the elements in the specified collection.
boolean	equals(java.lang.Object o) Compares the specified object with the underlying collection of this holder for equality.
java.lang.Object[]	getArray() Returns the current object array.
int	getJavaDataType(java.lang.String propertyName) Always returns DataTypes.TYPE_UNDEFINED (propertyName is ignored)
java.lang.Object	getObject() Returns the object in the current position.
java.lang.Object	getPropertyValue(java.lang.String propertyName) Returns the current object in array (propertyName is ignored).
java.lang.Object[]	getVariantArray() Deprecated. - use setArray - this method will be removed soon
boolean	hasNext() Indicates whether there is another (any) Objects in the array.
boolean	isEmpty() Returns true if the underlying collection of this holder contains no elements.
java.util.Iterator	iterator() Returns an iterator over the elements in the underlying collection of this holder.
void	next() Increments the position in the array.
boolean	remove(java.lang.Object o) Removes a single instance of the specified element from this collection, if it is present (optional operation).
boolean	removeAll(java.util.Collection c) Removes all the underlying collection of this holder's elements that are also contained in the specified collection (optional operation).
void	reset() Resets the position in the array to -1.
boolean	retainAll(java.util.Collection c) Retains only the elements in the underlying collection of this holder that are contained in the specified collection (optional operation).
void	setArray(java.lang.Object[] newArray) Sets the given array as the internal array of objects.
void	setObject(java.lang.Object obj) Sets (replace/copy) the object in the current position.
void	setPropertyValue(java.lang.String propertyName, java.lang.Object newValue) Sets the current object in array (propertyName is ignored).
void	setVariantArray(java.lang.Object[] newArray) Deprecated. - use setArray - this method will be removed soon
int	size() Returns the number of elements in the underlying collection of this holder.
void	stateChanged(javax.swing.event.ChangeEvent e)
java.lang.Object[]	toArray() Returns an array containing all of the elements in the underlying collection of this holder.
java.lang.Object[]	toArray(java.lang.Object[] a) Returns an array containing all of the elements in the underlying collection of this holder whose runtime type is that of the specified array.

Methods inherited from class com.taursys.model.AbstractValueHolder

addChangeListener, checkArrays, fireStateChanged, getAlias, getPropertyValues, isMultiplePropertiesChanging, removeChangeListener, setAlias, setMultiplePropertiesChanging, setPropertyValues, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.taursys.model.CollectionValueHolder

hashCode

Methods inherited from interface com.taursys.model.ValueHolder

addChangeListener, getAlias, getPropertyValues, removeChangeListener, setPropertyValues

Constructor Detail

ObjectArrayValueHolder

public ObjectArrayValueHolder()

Constructs a new ObjectArrayValueHolder.

ObjectArrayValueHolder

public ObjectArrayValueHolder(java.lang.Object[] newArray)

Constructs a new ObjectArrayValueHolder with the given array.

Method Detail

setVariantArray

public void setVariantArray(java.lang.Object[] newArray)

Deprecated. - use setArray - this method will be removed soon

Sets the given array as the internal array of objects.

getVariantArray

public java.lang.Object[] getVariantArray()

Deprecated. - use setArray - this method will be removed soon

Returns the current object array.

setArray

public void setArray(java.lang.Object[] newArray)

Sets the given array as the internal array of objects.

getArray

public java.lang.Object[] getArray()

Returns the current object array.

getPropertyValue

public java.lang.Object getPropertyValue(java.lang.String propertyName)
                                  throws ModelException

Returns the current object in array (propertyName is ignored).

Specified by:

getPropertyValue in interface ValueHolder

Specified by:

getPropertyValue in class AbstractValueHolder

Returns:

the value for the given property name.

Throws:

ModelException

setPropertyValue

public void setPropertyValue(java.lang.String propertyName,
                             java.lang.Object newValue)
                      throws ModelException

Sets the current object in array (propertyName is ignored).

Specified by:

setPropertyValue in interface ValueHolder

Specified by:

setPropertyValue in class AbstractValueHolder

Parameters:

propertyName - the property to update

Throws:

ModelException

getJavaDataType

public int getJavaDataType(java.lang.String propertyName)
                    throws ModelException

Always returns DataTypes.TYPE_UNDEFINED (propertyName is ignored)

Specified by:

getJavaDataType in interface ValueHolder

Specified by:

getJavaDataType in class AbstractValueHolder

Returns:

the java data type for the given propertyName

Throws:

ModelException

hasNext

public boolean hasNext()

Indicates whether there is another (any) Objects in the array. This method true if there is another element in the array.

Specified by:

hasNext in interface CollectionValueHolder

next

public void next()

Increments the position in the array. You should invoke the hasNext method BEFORE invoking this method to ensure that there IS another object. Fires a StateChanged event to any listeners.

Specified by:

next in interface CollectionValueHolder

reset

public void reset()

Resets the position in the array to -1.

Specified by:

reset in interface CollectionValueHolder

getObject

public java.lang.Object getObject()

Returns the object in the current position. You should ensure that the current position is valid before invoking this method.

Specified by:

getObject in interface CollectionValueHolder

setObject

public void setObject(java.lang.Object obj)

Sets (replace/copy) the object in the current position. You should ensure that the current position is valid before invoking this method. Depending on the specific implementation, the given object may either replace the current object in the list, or the property values of the given object may be copied to the current object in the list. Fires a StateChanged event to any listeners.

Specified by:

setObject in interface CollectionValueHolder

size

public int size()

Description copied from interface: CollectionValueHolder

Returns the number of elements in the underlying collection of this holder. If the underlying collection of this holder contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

size in interface CollectionValueHolder

Returns:

the number of elements in the underlying collection of this holder

isEmpty

public boolean isEmpty()

Description copied from interface: CollectionValueHolder

Returns true if the underlying collection of this holder contains no elements.

Specified by:

isEmpty in interface CollectionValueHolder

Returns:

true if the underlying collection of this holder contains no elements

contains

public boolean contains(java.lang.Object o)

Description copied from interface: CollectionValueHolder

Returns true if the underlying collection of this holder contains the specified element. More formally, returns true if and only if this collection contains at least one element e such that (o==null ? e==null : o.equals(e)).

Specified by:

contains in interface CollectionValueHolder

Parameters:

o - element whose presence in the underlying collection of this holder is to be tested.

Returns:

true if the underlying collection of this holder contains the specified element

iterator

public java.util.Iterator iterator()

Description copied from interface: CollectionValueHolder

Returns an iterator over the elements in the underlying collection of this holder. There are no guarantees concerning the order in which the elements are returned (unless the underlying collection of this holder is an instance of some class that provides a guarantee).

Specified by:

iterator in interface CollectionValueHolder

Returns:

an Iterator over the elements in the underlying collection of this holder

toArray

public java.lang.Object[] toArray()

Description copied from interface: CollectionValueHolder

Returns an array containing all of the elements in the underlying collection of this holder. If the collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

The returned array will be "safe" in that no references to it are maintained by the underlying collection of this holder. (In other words, this method must allocate a new array even if the underlying collection of this holder is backed by an array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

Specified by:

toArray in interface CollectionValueHolder

Returns:

an array containing all of the elements in the underlying collection of this holder

toArray

public java.lang.Object[] toArray(java.lang.Object[] a)

Description copied from interface: CollectionValueHolder

Returns an array containing all of the elements in the underlying collection of this holder whose runtime type is that of the specified array. If the collection fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of the underlying collection of this holder.

If the underlying collection of this holder fits in the specified array with room to spare (i.e., the array has more elements than the underlying collection of this holder), the element in the array immediately following the end of the collection is set to null. This is useful in determining the length of this collection only if the caller knows that the underlying collection of this holder does not contain any null elements.)

If the underlying collection of this holder makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

Like the toArray method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs

Suppose l is a List known to contain only strings. The following code can be used to dump the list into a newly allocated array of String:

     String[] x = (String[]) v.toArray(new String[0]);
 

Note that toArray(new Object[0]) is identical in function to toArray().

Specified by:

toArray in interface CollectionValueHolder

Parameters:

a - the array into which the elements of the underlying collection of this holder are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.

Returns:

an array containing the elements of the underlying collection of this holder

add

public boolean add(java.lang.Object o)

Description copied from interface: CollectionValueHolder

Ensures that the underlying collection of this holder contains the specified element (optional operation). Returns true if the underlying collection of this holder changed as a result of the call. (Returns false if the underlying collection of this holder does not permit duplicates and already contains the specified element.)

Collections that support this operation may place limitations on what elements may be added to the underlying collection of this holder. In particular, some collections will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. Collection classes should clearly specify in their documentation any restrictions on what elements may be added.

If a collection refuses to add a particular element for any reason other than that it already contains the element, it must throw an exception (rather than returning false). This preserves the invariant that a collection always contains the specified element after this call returns.

Specified by:

add in interface CollectionValueHolder

Parameters:

o - element whose presence in the underlying collection of this holder is to be ensured.

Returns:

true if the underlying collection of this holder changed as a result of the call

remove

public boolean remove(java.lang.Object o)

Description copied from interface: CollectionValueHolder

Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if the underlying collection of this holder contains one or more such elements. Returns true if the underlying collection of this holder contained the specified element (or equivalently, if the underlying collection of this holder changed as a result of the call).

Specified by:

remove in interface CollectionValueHolder

Parameters:

o - element to be removed from the underlying collection of this holder, if present.

Returns:

true if the underlying collection of this holder changed as a result of the call

containsAll

public boolean containsAll(java.util.Collection c)

Description copied from interface: CollectionValueHolder

Returns true if the underlying collection of this holder contains all of the elements in the specified collection.

Specified by:

containsAll in interface CollectionValueHolder

Parameters:

c - collection to be checked for containment in the underlying collection of this holder.

Returns:

true if the underlying collection of this holder contains all of the elements in the specified collection

See Also:

CollectionValueHolder.contains(Object)

addAll

public boolean addAll(java.util.Collection c)

Description copied from interface: CollectionValueHolder

Adds all of the elements in the specified collection to the underlying collection of this holder (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is the underlying collection of this holder, and the underlying collection of this holder is nonempty.)

Specified by:

addAll in interface CollectionValueHolder

Parameters:

c - elements to be inserted into the underlying collection of this holder.

Returns:

true if the underlying collection of this holder changed as a result of the call

See Also:

CollectionValueHolder.add(Object)

removeAll

public boolean removeAll(java.util.Collection c)

Description copied from interface: CollectionValueHolder

Removes all the underlying collection of this holder's elements that are also contained in the specified collection (optional operation). After this call returns, the underlying collection of this holder will contain no elements in common with the specified collection.

Specified by:

removeAll in interface CollectionValueHolder

Parameters:

c - elements to be removed from the underlying collection of this holder.

Returns:

true if the underlying collection of this holder changed as a result of the call

See Also:

CollectionValueHolder.remove(Object), CollectionValueHolder.contains(Object)

retainAll

public boolean retainAll(java.util.Collection c)

Description copied from interface: CollectionValueHolder

Retains only the elements in the underlying collection of this holder that are contained in the specified collection (optional operation). In other words, removes from the underlying collection of this holder all of its elements that are not contained in the specified collection.

Specified by:

retainAll in interface CollectionValueHolder

Parameters:

c - elements to be retained in the underlying collection of this holder.

Returns:

true if the underlying collection of this holder changed as a result of the call

See Also:

CollectionValueHolder.remove(Object), CollectionValueHolder.contains(Object)

clear

public void clear()

Description copied from interface: CollectionValueHolder

Removes all of the elements from the underlying collection of this holder (optional operation). This collection will be empty after this method returns unless it throws an exception.

Specified by:

clear in interface CollectionValueHolder

equals

public boolean equals(java.lang.Object o)

Description copied from interface: CollectionValueHolder

Compares the specified object with the underlying collection of this holder for equality.

While the Collection interface adds no stipulations to the general contract for the Object.equals, programmers who implement the Collection interface "directly" (in other words, create a class that is a Collection but is not a Set or a List) must exercise care if they choose to override the Object.equals. It is not necessary to do so, and the simplest course of action is to rely on Object's implementation, but the implementer may wish to implement a "value comparison" in place of the default "reference comparison." (The List and Set interfaces mandate such value comparisons.)

The general contract for the Object.equals method states that equals must be symmetric (in other words, a.equals(b) if and only if b.equals(a)). The contracts for List.equals and Set.equals state that lists are only equal to other lists, and sets to other sets. Thus, a custom equals method for a collection class that implements neither the List nor Set interface must return false when the underlying collection of this holder is compared to any list or set. (By the same logic, it is not possible to write a class that correctly implements both the Set and List interfaces.)

Specified by:

equals in interface CollectionValueHolder

stateChanged

public void stateChanged(javax.swing.event.ChangeEvent e)