com.taursys.model
Class AbstractCollectionValueHolder

java.lang.Object
  com.taursys.model.AbstractCollectionValueHolder

All Implemented Interfaces:

javax.swing.event.ChangeListener, java.util.Collection, CollectionValueHolder, java.util.EventListener, ValueHolder

Direct Known Subclasses:

AbstractListValueHolder, ObjectCollectionValueHolder, VOCollectionValueHolder

public class AbstractCollectionValueHolder

extends java.lang.Object

implements CollectionValueHolder, javax.swing.event.ChangeListener

A partial implementation of a CollectionValueHolder Interface. This class uses an internal ObjectValueHolder and Collection to implement the required contract.

Version:

2.0

Author:

Marty Phelan

Constructor Summary

AbstractCollectionValueHolder(ObjectValueHolder holder)
Constructs a new AbstractCollectionValueHolder

AbstractCollectionValueHolder(ObjectValueHolder holder, java.util.Collection collection)
Constructs a new AbstractCollectionValueHolder for the given collection.

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	addChangeListener(javax.swing.event.ChangeListener l) Adds the specified change listener to receive change events from this value holder.
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.
java.lang.String	getAlias() Get the alias name for this ValueHolder.
java.util.Collection	getCollection() Returns the current collection of this holder.
int	getJavaDataType(java.lang.String propertyName) Get the java data type for the given property
java.lang.Object	getObject() Returns the object in the current position.
protected ObjectValueHolder	getObjectValueHolder() Get the internal ObjectValueHolder for this CollectionValueHolder.
java.lang.String	getParentPropertyName() Get the property name of the Collection in the parentValueHolder for this VOCollectionValueHolder.
ValueHolder	getParentValueHolder() Get the parent ValueHolder for this VOCollectionValueHolder.
java.lang.Object	getPropertyValue(java.lang.String propertyName) Get the value of the given property in the valueObject.
java.lang.Object[]	getPropertyValues(java.lang.String[] propertyNames) Get the values for the given property names.
boolean	hasNext() Indicates whether there is another (any) Objects in the collection.
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() Makes the next object in the collection available.
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	removeChangeListener(javax.swing.event.ChangeListener l) Removes the specified change listener so that it no longer receives change events from this value holder.
void	reset() Resets this holder so that you can iterate the collection from the beginning.
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	setAlias(java.lang.String newAlias) Sets the alias name for this value holder.
void	setCollection(java.util.Collection collection) Sets the current collection for this holder and invokes reset method.
void	setObject(java.lang.Object obj) Replaces the object in the current position with the given one.
void	setParentPropertyName(java.lang.String parentPropertyName) Set the property name of the Collection in the parentValueHolder for this VOCollectionValueHolder.
void	setParentValueHolder(ValueHolder parentValueHolder) Set the parent ValueHolder for this VOCollectionValueHolder.
void	setPropertyValue(java.lang.String propertyName, java.lang.Object value) Set the value of the given property in the valueObject.
void	setPropertyValues(java.lang.String[] propertyNames, java.lang.Object[] values) Set the values for the given properties in the valueObject.
int	size() Returns the number of elements in the underlying collection of this holder.
void	stateChanged(javax.swing.event.ChangeEvent e) Invoked by the parentValueHolder whenever there is a change in its value.
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.
java.lang.String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.taursys.model.CollectionValueHolder

equals, hashCode

Constructor Detail

AbstractCollectionValueHolder

public AbstractCollectionValueHolder(ObjectValueHolder holder)

Constructs a new AbstractCollectionValueHolder

AbstractCollectionValueHolder

public AbstractCollectionValueHolder(ObjectValueHolder holder,
                                     java.util.Collection collection)

Constructs a new AbstractCollectionValueHolder for the given collection.

Method Detail

getObjectValueHolder

protected ObjectValueHolder getObjectValueHolder()

Get the internal ObjectValueHolder for this CollectionValueHolder. The internal ObjectValueHolder is specified in the constructor.

Returns:

the internal ObjectValueHolder for this CollectionValueHolder.

getPropertyValue

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

Get the value of the given property in the valueObject.

Specified by:

getPropertyValue in interface ValueHolder

Returns:

the value of the given property in the valueObject.

Throws:

ModelException

getPropertyValues

public java.lang.Object[] getPropertyValues(java.lang.String[] propertyNames)
                                     throws ModelException

Get the values for the given property names. This method returns an empty Object array if the given propertyNames is null or empty.

Specified by:

getPropertyValues in interface ValueHolder

Parameters:

propertyNames - array of property names

Returns:

the values for the given property names.

Throws:

ModelException

setPropertyValue

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

Set the value of the given property in the valueObject. Fires a StateChanged event to any listeners.

Specified by:

setPropertyValue in interface ValueHolder

Parameters:

propertyName - the property name to set

value - the value to set the property to

Throws:

ModelException

setPropertyValues

public void setPropertyValues(java.lang.String[] propertyNames,
                              java.lang.Object[] values)
                       throws ModelException

Set the values for the given properties in the valueObject. Fires a StateChanged event to any listeners.

Specified by:

setPropertyValues in interface ValueHolder

Parameters:

propertyNames - the property names to set

values - the values to set the properties to

Throws:

ModelException

getJavaDataType

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

Get the java data type for the given property

Specified by:

getJavaDataType in interface ValueHolder

Returns:

the java data type for the given property

Throws:

ModelException

getAlias

public java.lang.String getAlias()

Get the alias name for this ValueHolder. This property is used by the ComponentFactory to bind Components to ValueHolders by matching it to the first part of the Component's ID property.

Specified by:

getAlias in interface ValueHolder

Returns:

the alias name for this ValueHolder

setAlias

public void setAlias(java.lang.String newAlias)

Sets the alias name for this value holder. This property is used by the ComponentFactory to bind Components to value holders by matching it to the first part of the Component's ID property.

Parameters:

newAlias - the alias name for this value holder

removeChangeListener

public void removeChangeListener(javax.swing.event.ChangeListener l)

Removes the specified change listener so that it no longer receives change events from this value holder. Change events are generated whenever the contents of the value holder change.

Specified by:

removeChangeListener in interface ValueHolder

Parameters:

l - the change listener to remove

addChangeListener

public void addChangeListener(javax.swing.event.ChangeListener l)

Adds the specified change listener to receive change events from this value holder. Change events are generated whenever the contents of the value holder change.

Specified by:

addChangeListener in interface ValueHolder

Parameters:

l - the change listener to add

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)

Replaces the object in the current position with the given one. You should ensure that the current position is valid before invoking this method. The order of unordered collections may be disturbed by this operation.

Specified by:

setObject in interface CollectionValueHolder

setParentValueHolder

public void setParentValueHolder(ValueHolder parentValueHolder)

Set the parent ValueHolder for this VOCollectionValueHolder. The parent ValueHolder will provide the Collection for this ValueHolder. If the parent is also a CollectionValueHolder, then whenever the parent moves to a new row, this VOCollectionValueHolder will receive a notification and will retrieve its new collection from the parent.

Parameters:

parentValueHolder - the parent ValueHolder for this VOCollectionValueHolder.

getParentValueHolder

public ValueHolder getParentValueHolder()

Get the parent ValueHolder for this VOCollectionValueHolder. The parent ValueHolder will provide the Collection for this ValueHolder. If the parent is also a CollectionValueHolder, then whenever the parent moves to a new row, this VOCollectionValueHolder will receive a notification and will retrieve its new collection from the parent.

Returns:

the parent ValueHolder for this VOCollectionValueHolder.

setParentPropertyName

public void setParentPropertyName(java.lang.String parentPropertyName)

Set the property name of the Collection in the parentValueHolder for this VOCollectionValueHolder. The parent ValueHolder will provide the Collection for this ValueHolder. If the parent is also a CollectionValueHolder, then whenever the parent moves to a new row, this VOCollectionValueHolder will receive a notification and will retrieve its new collection from the parent.

getParentPropertyName

public java.lang.String getParentPropertyName()

Get the property name of the Collection in the parentValueHolder for this VOCollectionValueHolder. The parent ValueHolder will provide the Collection for this ValueHolder. If the parent is also a CollectionValueHolder, then whenever the parent moves to a new row, this VOCollectionValueHolder will receive a notification and will retrieve its new collection from the parent.

Returns:

the property name of the Collection in the parentValueHolder for this VOCollectionValueHolder.

stateChanged

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

Invoked by the parentValueHolder whenever there is a change in its value. The parent ValueHolder will provide the Collection for this ValueHolder. If the parent is also a CollectionValueHolder, then whenever the parent moves to a new row, this VOCollectionValueHolder will receive a notification and will retrieve its new collection from the parent.

Specified by:

stateChanged in interface javax.swing.event.ChangeListener

Parameters:

e - the ChangeEvent from the parentValueHolder

hasNext

public boolean hasNext()

Indicates whether there is another (any) Objects in the collection. If the internal iterator for the collection has not yet been created, this method will invoke the getInternalIterator method. This method returns the results of the iterator's hasNext method.

Specified by:

hasNext in interface CollectionValueHolder

next

public void next()

Makes the next object in the collection available. You should invoke the hasNext method BEFORE invoking this method to ensure that there IS a next object. The ValueObject is fetched from the collection and stored in the valueObject property.

Specified by:

next in interface CollectionValueHolder

reset

public void reset()

Resets this holder so that you can iterate the collection from the beginning. This sets the iterator and valueObject properties to null. That ensures that the iterator is recreated at the next invocation of hasNext, next, or getInternalIterator.

Specified by:

reset in interface CollectionValueHolder

getCollection

public java.util.Collection getCollection()

Returns the current collection of this holder.

setCollection

public void setCollection(java.util.Collection collection)

Sets the current collection for this holder and invokes reset method. If the given collection is null, an Collections.EMPTY_LIST is stored instead, otherwise the given collection is stored. This is done to prevent NullPointerExceptions from occuring whenever any method is subsequently called.

size

public int size()

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()

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)

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()

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()

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)

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

Throws:

java.lang.ArrayStoreException - the runtime type of the specified array is not a supertype of the runtime type of every element in this collection.

add

public boolean add(java.lang.Object o)

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

Throws:

java.lang.UnsupportedOperationException - add is not supported by this collection.

java.lang.ClassCastException - class of the specified element prevents it from being added to the underlying collection of this holder.

java.lang.IllegalArgumentException - some aspect of this element prevents it from being added to the underlying collection of this holder.

remove

public boolean remove(java.lang.Object o)

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

Throws:

java.lang.UnsupportedOperationException - remove is not supported by this collection.

containsAll

public boolean containsAll(java.util.Collection c)

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:

contains(Object)

addAll

public boolean addAll(java.util.Collection c)

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

Throws:

java.lang.UnsupportedOperationException - if the underlying collection of this holder does not support the addAll method.

java.lang.ClassCastException - if the class of an element of the specified collection prevents it from being added to the underlying collection of this holder.

java.lang.IllegalArgumentException - some aspect of an element of the specified collection prevents it from being added to this collection.

See Also:

add(Object)

removeAll

public 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). 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

Throws:

java.lang.UnsupportedOperationException - if the removeAll method is not supported by the underlying collection of this holder.

See Also:

remove(Object), contains(Object)

retainAll

public 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). 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

Throws:

java.lang.UnsupportedOperationException - if the retainAll method is not supported by this Collection.

See Also:

remove(Object), contains(Object)

clear

public void clear()

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

Throws:

java.lang.UnsupportedOperationException - if the clear method is not supported by the underlying collection of this holder.

toString

public java.lang.String toString()

Returns a string representation of this object. This contains the object identity and state information.

Returns:

a string representation of this object