org.kuali.kra.budget.calculator

Class QueryList<E>

java.lang.Object

org.kuali.kra.budget.calculator.QueryList<E>

All Implemented Interfaces:

Serializable, Cloneable, Iterable<E>, Collection<E>, List<E>, RandomAccess

public final class QueryList<E>
extends Object
implements List<E>, RandomAccess, Cloneable, Serializable

This class...

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
QueryList()
QueryList(Collection<E> dataList)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(E o)
void	add(int index, E element)
boolean	addAll(Collection<? extends E> c)
boolean	addAll(int index, Collection<? extends E> c)
void	clear()
QueryList<E>	clone()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
boolean	equals(Object o)
QueryList<E>	filter(Operator operator) filters querylist which contains only those beans which satisfies the operator condition.
E	get(int index)
int	hashCode()
int	indexOf(Object o)
boolean	isEmpty()
Iterator<E>	iterator()
int	lastIndexOf(Object o)
ListIterator<E>	listIterator()
ListIterator<E>	listIterator(int index)
E	remove(int index)
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
E	set(int index, E element)
int	size()
boolean	sort(String fieldName) Overridden method for sorting.
boolean	sort(String[] fieldNames, boolean ascending) sorts the QueryList by the fieldNames in ascending or descending order.
boolean	sort(String[] fieldNames, boolean[] ascending) sorts the QueryList by the fieldNames in ascending or descending order.
boolean	sort(String fieldName, boolean ascending) sorts the QueryList by the fieldName in ascending or descending order.
boolean	sort(String fieldName, boolean ascending, boolean ignoreCase) sorts the QueryList by the fieldName in ascending or descending order.
List<E>	subList(int fromIndex, int toIndex)
double	sum(String fieldName) calculates the sum of the field in this QueryList.
double	sum(String fieldName, Class arg, Object value) calculates the sum of the field in this QueryList.
double	sum(String fieldName, Operator operator) calculates the sum of the field in this QueryList.
BudgetDecimal	sumObjects(String fieldName) calculates the sum of the Objects of the specified field in this QueryList.
BudgetDecimal	sumObjects(String fieldName, Operator operator) calculates the sum of the field in this QueryList.
Object[]	toArray()
<T> T[]	toArray(T[] a)
List<E>	toArrayList()
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QueryList

public QueryList()

QueryList

public QueryList(Collection<E> dataList)

Method Detail

sort

public boolean sort(String fieldName)

Overridden method for sorting. By default it will sort in ascending order. sorts the QueryList by the fieldName in ascending or descending order. Note: the field Object should be of Comparable type.

Parameters:

fieldName - field which is used to sort the bean.

Returns:

boolean indicating whether the sort is completed successfully or not.

sort

public boolean sort(String fieldName,
           boolean ascending)

sorts the QueryList by the fieldName in ascending or descending order. Note: the field Objects should be of Comparable type.

Parameters:

fieldName - field which is used to sort the bean.

ascending - if true sorting is done in ascending order, else sorting is done in descending order.

Returns:

boolean indicating whether the sort is completed successfully or not.

sort

public boolean sort(String fieldName,
           boolean ascending,
           boolean ignoreCase)

sorts the QueryList by the fieldName in ascending or descending order. Note: the field Object should be of Comparable type.

Parameters:

ignoreCase - use only when comparing strings. as default implementation uses case sensitive comparison.

fieldName - field which is used to sort the bean.

ascending - if true sorting is done in ascending order, else sorting is done in descending order.

Returns:

boolean indicating whether the sort is completed successfully or not.

sort

public boolean sort(String[] fieldNames,
           boolean ascending)

sorts the QueryList by the fieldNames in ascending or descending order. Note: the field Objects should be of Comparable type.

Parameters:

fieldNames - fields which is used to sort the bean.

ascending - if true sorting is done in ascending order, else sorting is done in descending order.

Returns:

boolean indicating whether the sort is completed successfully or not. Modified code for the better performance and proper sorting. Added by Sharath and Nadh

sort

public boolean sort(String[] fieldNames,
           boolean[] ascending)

sorts the QueryList by the fieldNames in ascending or descending order. Note: the field Objects should be of Comparable type.

Parameters:

fieldNames - fields which is used to sort the bean.

ascending - if true sorting is done in ascending order, else sorting is done in descending order.

Returns:

boolean indicating whether the sort is completed successfully or not. Modified code for the better performance and proper sorting. Added by Sharath and Nadh

filter

public QueryList<E> filter(Operator operator)

filters querylist which contains only those beans which satisfies the operator condition.

Parameters:

operator - Operator.

Returns:

querylist which contains only those beans which satisfies the operator condition.

sum

public double sum(String fieldName)

calculates the sum of the field in this QueryList.

Parameters:

fieldName - field of bean whose sum has to be calculated.

Returns:

sum.

sumObjects

public BudgetDecimal sumObjects(String fieldName)

calculates the sum of the Objects of the specified field in this QueryList.

Parameters:

fieldName - field of bean whose sum has to be calculated.

Returns:

sum as BigDecimal Object.

sum

public double sum(String fieldName,
         Class arg,
         Object value)

calculates the sum of the field in this QueryList.

Parameters:

fieldName - field of bean whose sum has to be calculated.

arg - argument for the getter method of field if it takes any argumnt, else can be null.

value - value for the argument, else can be null.

Returns:

returns sum.

sum

public double sum(String fieldName,
         Operator operator)

calculates the sum of the field in this QueryList.

Parameters:

fieldName - field of bean whose sum has to be calculated.

operator - to get filrtered vector on which sum will be called.

Returns:

returns sum.

sumObjects

public BudgetDecimal sumObjects(String fieldName,
                       Operator operator)

calculates the sum of the field in this QueryList.

Parameters:

fieldName - field of bean whose sum has to be calculated.

operator - to get filrtered vector on which sum will be called.

Returns:

returns sum.

clone

public QueryList<E> clone()

Overrides:

clone in class Object

add

public boolean add(E o)

Specified by:

add in interface Collection<E>

Specified by:

add in interface List<E>

add

public void add(int index,
       E element)

Specified by:

add in interface List<E>

addAll

public boolean addAll(Collection<? extends E> c)

Specified by:

addAll in interface Collection<E>

Specified by:

addAll in interface List<E>

addAll

public boolean addAll(int index,
             Collection<? extends E> c)

Specified by:

addAll in interface List<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface List<E>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface List<E>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<E>

Specified by:

containsAll in interface List<E>

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<E>

Specified by:

equals in interface List<E>

Overrides:

equals in class Object

get

public E get(int index)

Specified by:

get in interface List<E>

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<E>

Specified by:

hashCode in interface List<E>

Overrides:

hashCode in class Object

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface List<E>

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface List<E>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<E>

listIterator

public ListIterator<E> listIterator()

Specified by:

listIterator in interface List<E>

listIterator

public ListIterator<E> listIterator(int index)

Specified by:

listIterator in interface List<E>

remove

public E remove(int index)

Specified by:

remove in interface List<E>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface List<E>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<E>

Specified by:

removeAll in interface List<E>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<E>

Specified by:

retainAll in interface List<E>

set

public E set(int index,
    E element)

Specified by:

set in interface List<E>

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface List<E>

subList

public List<E> subList(int fromIndex,
              int toIndex)

Specified by:

subList in interface List<E>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface List<E>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface List<E>

toString

public String toString()

Overrides:

toString in class Object

toArrayList

public List<E> toArrayList()