org.apache.commons.scaffold.util
Interface ResultList

All Superinterfaces:

java.util.Collection

All Known Implementing Classes:

ResultListBase

public interface ResultList

extends java.util.Collection

A container for a set of results returned from the resource tier. The list may contain a Map for each record in a set, or a collection of beans. A setter for the list is not provided, so that different implementations can specify the type it expects.

Version:

$Revision: 1.7 $ $Date: 2004/03/21 21:10:10 $

Method Summary

boolean	add(java.lang.Object o) Appends the specified element to the end of this list (optional operation).
boolean	addAll(java.util.Collection c) Appends all of the elements in the specified Collection to the end of this list, in the order that they are returned by the specified Collection's Iterator.
void	clear() Removes all of the elements from this list..
boolean	contains(java.lang.Object element) Returns true if this collection contains the specified element.
boolean	containsAll(java.util.Collection c) Returns true if this collection contains all of the elements in the specified collection.
java.lang.Object	get(int index) Returns the element at the specified position in this list.
java.lang.Integer	getCode() Return the code.
int	getCounter() Convenience method for maintaining a counter that can be shared among multiple components in some presentation systems (e.g, Tiles).
java.util.Map	getDisplayName() Return the displayName map (a HashMap).
java.lang.Object	getElement(int index) Convenience accessor for get().
java.util.Iterator	getIterator() Convenience accessor for iterator().
java.lang.String	getLegend() Return the legend.
java.util.List	getResult() Return the result list
Scroller	getScroller() Return our scroller.
int	getSize() Convenience accessor for size().
boolean	isEmpty() Returns true if this collection contains no elements.
java.util.Iterator	iterator() Return an iterator for the List.
boolean	populate(java.lang.Object o, int index) Populate matching properties on given object, using bean at given index.
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 this collection's elements that are also contained in the specified collection.
boolean	retainAll(java.util.Collection c) Retains only the elements in this collection that are contained in the specified collection.
void	setCode(java.lang.Integer code) Set the code.
void	setCounter(int counter) Set a new counter value.
void	setDisplayName(java.util.Map displayName) Assign a new displayName list.
void	setLegend(java.lang.String legend) Set the legend.
void	setLegend(java.lang.String name, java.lang.String value) Set the legend.
void	setResult(java.util.List result) Set our result
void	setScroller(Scroller scroller) Set our scroller.
int	size() Return the number of elements on the List.
java.lang.Object[]	toArray() Returns an array containing all of the elements in this collection.
java.lang.Object[]	toArray(java.lang.Object[] a) Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.

Methods inherited from interface java.util.Collection

equals, hashCode

Method Detail

getResult

public java.util.List getResult()

Return the result list

Returns:

the result list

setResult

public void setResult(java.util.List result)

Set our result

Parameters:

result - The new result

getScroller

public Scroller getScroller()

Return our scroller. The scroller object tracks the client's current position in a result list. The database (or a cache) can return part of a larger list at a time. The scroller object can be used to request the appropriate next or previous entry on the list, and also to display the relative postion of the first item in this batch (x of xx).

Returns:

Our scroller

setScroller

public void setScroller(Scroller scroller)

Set our scroller.

Parameters:

scroller - The new scroller

getCounter

public int getCounter()

Convenience method for maintaining a counter that can be shared among multiple components in some presentation systems (e.g, Tiles).

Returns:

The next counter value

setCounter

public void setCounter(int counter)

Set a new counter value.

getCode

public java.lang.Integer getCode()

Return the code.

Returns:

the code

setCode

public void setCode(java.lang.Integer code)

Set the code.

Parameters:

code - The new code

getLegend

public java.lang.String getLegend()

Return the legend.

Returns:

the legend

setLegend

public void setLegend(java.lang.String legend)

Set the legend.

Parameters:

legend - The new legend

setLegend

public void setLegend(java.lang.String name,
                      java.lang.String value)

Set the legend.

getDisplayName

public java.util.Map getDisplayName()

Return the displayName map (a HashMap). These are localized titles for the properties names in the result list.

Returns:

the displayName list

setDisplayName

public void setDisplayName(java.util.Map displayName)

Assign a new displayName list. These are localized titles for the properties names in the result list.

toArray

public java.lang.Object[] toArray()

Returns an array containing all of the elements in this collection.

Specified by:

toArray in interface java.util.Collection

Returns:

an array containing all of the elements in this collection

toArray

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

Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.

Specified by:

toArray in interface java.util.Collection

Returns:

an array containing the elements of this collection

isEmpty

public boolean isEmpty()

Returns true if this collection contains no elements.

Specified by:

isEmpty in interface java.util.Collection

Returns:

true if this collection contains no elements

size

public int size()

Return the number of elements on the List.

Specified by:

size in interface java.util.Collection

Returns:

the size of the List

contains

public boolean contains(java.lang.Object element)

Returns true if this collection contains the specified element.

Specified by:

contains in interface java.util.Collection

Returns:

true if this collection contains the specified element

add

public boolean add(java.lang.Object o)

Appends the specified element to the end of this list (optional operation).

Specified by:

add in interface java.util.Collection

Returns:

the row count

iterator

public java.util.Iterator iterator()

Return an iterator for the List.

Specified by:

iterator in interface java.util.Collection

Returns:

an iterator for the List

get

public java.lang.Object get(int index)

Returns the element at the specified position in this list.

addAll

public boolean addAll(java.util.Collection c)

Appends all of the elements in the specified Collection to the end of this list, in the order that they are returned by the specified Collection's Iterator.

Specified by:

addAll in interface java.util.Collection

clear

public void clear()

Removes all of the elements from this list..

Specified by:

clear in interface java.util.Collection

containsAll

public boolean containsAll(java.util.Collection c)

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

Specified by:

containsAll in interface java.util.Collection

Returns:

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

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

Specified by:

remove in interface java.util.Collection

removeAll

public boolean removeAll(java.util.Collection c)

Removes all this collection's elements that are also contained in the specified collection.

Specified by:

removeAll in interface java.util.Collection

retainAll

public boolean retainAll(java.util.Collection c)

Retains only the elements in this collection that are contained in the specified collection.

Specified by:

retainAll in interface java.util.Collection

getElement

public java.lang.Object getElement(int index)

Convenience accessor for get().

getIterator

public java.util.Iterator getIterator()

Convenience accessor for iterator().

Returns:

an iterator for the List

getSize

public int getSize()

Convenience accessor for size().

Returns:

the size of the List

populate

public boolean populate(java.lang.Object o,
                        int index)
                 throws java.lang.Exception

Populate matching properties on given object, using bean at given index. Returns false if index>size. PropertyUtils.describe.

Throws:

Throws - StateException on any error.

java.lang.Exception