*** This class is subject to change ***

com.sas.dataselectors.filters
Class AdvancedFilterValueList

java.lang.Object
  |
  +--java.util.AbstractCollection
        |
        +--java.util.AbstractList
              |
              +--java.util.ArrayList
                    |
                    +--com.sas.dataselectors.filters.AdvancedFilterValueList

All Implemented Interfaces:

FilterValueInterface, FilterValuesInterface,

public class AdvancedFilterValueList

extends java.util.ArrayList

implements FilterValuesInterface, FilterValueInterface

The AdvancedFilterValueList is both a filter value list and a filter value.

See Also:

Serialized Form

Field Summary

protected String	_toStringMessageFormat Deprecated. The message format to use when constructing the toString text for this object.
static String	RB_KEY Deprecated. The property key prefix for resources used by this class.

Fields inherited from class java.util.AbstractList

modCount

Fields inherited from interface com.sas.dataselectors.filters.FilterValuesInterface

GETTHRESHHOLDALLVALUES

Constructor Summary

AdvancedFilterValueList()
Deprecated. Constructs a new value list with the default properties.

AdvancedFilterValueList(Collection collection)
Deprecated. Constructs a new value list with the specified members.

AdvancedFilterValueList(Object[] values)
Deprecated. Constructs a new value list with the specified members.

AdvancedFilterValueList(Object value, String formattedValue, int dataType, Object format, Object unformattedValue)
Deprecated. Constructs a new value list with the specified properties.

AdvancedFilterValueList(Object value, String formattedValue, int dataType, Object format, Object unformattedValue, String toStringMessageFormat)
Deprecated. Constructs a new value list with the specified properties.

Method Summary

Object	getData() Deprecated. Returns the native filter object this value represents.
int	getDataType() Deprecated. Returns the data type this value represents.
List	getFirstValues(long lThreshold) Deprecated. Gathers and returns the first set of values held in this list.
Object	getFormat() Deprecated. Returns the format of this value.
String	getFormattedValue() Deprecated. Returns the formatted representation of this value.
String	getListLabel() Deprecated. Returns the label for this value list.
List	getNextValues(long lThreshold) Deprecated. Gathers and returns the next set of values held in this list.
Object	getUnformattedValue() Deprecated. Returns the unformatted representation of this value.
boolean	hasMoreValues() Deprecated. Returns true if the iterator indicates more values are available, false otherwise.
void	setFilterValue(FilterValueInterface value) Deprecated. Sets the delegate filter value object used when the class is referenced as a value.
String	toString() Deprecated. Constructs a text representation of this value.

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, lastIndexOf, remove, removeRange, set, size, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode, iterator, listIterator, listIterator, subList

Methods inherited from class java.util.AbstractCollection

containsAll, remove, removeAll, retainAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

containsAll, equals, hashCode, iterator, listIterator, listIterator, remove, removeAll, retainAll, subList

Field Detail

RB_KEY

public static String RB_KEY

Deprecated.

The property key prefix for resources used by this class.

_toStringMessageFormat

protected String _toStringMessageFormat

Deprecated.

The message format to use when constructing the toString text for this object.

Constructor Detail

AdvancedFilterValueList

public AdvancedFilterValueList()

Deprecated.

Constructs a new value list with the default properties.

AdvancedFilterValueList

public AdvancedFilterValueList(Collection collection)

Deprecated.

Constructs a new value list with the specified members.

Parameters:

collection - the initial values to populate the list

AdvancedFilterValueList

public AdvancedFilterValueList(Object[] values)

Deprecated.

Constructs a new value list with the specified members.

Parameters:

values - the initial values to populate the list

AdvancedFilterValueList

public AdvancedFilterValueList(Object value,
                               String formattedValue,
                               int dataType,
                               Object format,
                               Object unformattedValue,
                               String toStringMessageFormat)

Deprecated.

Constructs a new value list with the specified properties. The properties given will be used when the class is referenced as a value.

Parameters:

value - the native model object this value represents

formattedValue - the formatted representation of this value

dataType - the type of data this value represents

format - the format for this value

unformattedValue - the unformatted representation of this value

toStringMessageFormat - the format used when constructing the toString text

AdvancedFilterValueList

public AdvancedFilterValueList(Object value,
                               String formattedValue,
                               int dataType,
                               Object format,
                               Object unformattedValue)

Deprecated.

Constructs a new value list with the specified properties. The properties given will be used when the class is referenced as a value. The default toString format will be used.

Parameters:

value - the native model object this value represents

formattedValue - the formatted representation of this value

dataType - the type of data this value represents

format - the format for this value

unformattedValue - the unformatted representation of this value

Method Detail

setFilterValue

public void setFilterValue(FilterValueInterface value)

Deprecated.

Sets the delegate filter value object used when the class is referenced as a value.

Parameters:

value - the new delegate filter value

hasMoreValues

public boolean hasMoreValues()

Deprecated.

Returns true if the iterator indicates more values are available, false otherwise.

Specified by:

hasMoreValues in interface FilterValuesInterface

Returns:

true if the iterator indicates more values are available, false otherwise

getFirstValues

public List getFirstValues(long lThreshold)
                    throws DataRetrievalError

Deprecated.

Gathers and returns the first set of values held in this list. This method must be called to initialize the value set and before any call to getNextValues.

Specified by:

getFirstValues in interface FilterValuesInterface

Parameters:

lThreshold - the maximum number of records to return or -1 for no limit

Returns:

a List of the first set of values

Throws:

DataRetrievalError - if any error occurs while gathering values

getNextValues

public List getNextValues(long lThreshold)
                   throws DataRetrievalError

Deprecated.

Gathers and returns the next set of values held in this list.

Specified by:

getNextValues in interface FilterValuesInterface

Parameters:

lThreshold - the maximum number of records to return or -1 for no limit

Returns:

a List of the next set of values

Throws:

DataRetrievalError - if any error occurs while gathering values

getListLabel

public String getListLabel()

Deprecated.

Returns the label for this value list.

Specified by:

getListLabel in interface FilterValuesInterface

Returns:

the label for this value list

getFormattedValue

public String getFormattedValue()

Deprecated.

Returns the formatted representation of this value.

Specified by:

getFormattedValue in interface FilterValueInterface

Returns:

the formatted value

getUnformattedValue

public Object getUnformattedValue()

Deprecated.

Returns the unformatted representation of this value.

Specified by:

getUnformattedValue in interface FilterValueInterface

Returns:

the unformatted value

getDataType

public int getDataType()

Deprecated.

Returns the data type this value represents.

Specified by:

getDataType in interface FilterValueInterface

Returns:

the data type of this value

getFormat

public Object getFormat()

Deprecated.

Returns the format of this value.

Specified by:

getFormat in interface FilterValueInterface

Returns:

the format

getData

public Object getData()

Deprecated.

Returns the native filter object this value represents.

Specified by:

getData in interface FilterValueInterface

Returns:

the native filter value

toString

public String toString()

Deprecated.

Constructs a text representation of this value. The format may have been specified at construction or else it will be the default format.

Overrides:

toString in class AbstractCollection

See Also:

MessageFormat

*** This class is subject to change ***