|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IFilterablePagedList<T>
An IPagedList which can be filtered. This is an application of the com.bea.p13n.pagination.FilterablePagedResult model to the Content PagedList construct.
An overview of PagedList capabilities, including sorting and filtering, is provided
in the package documentation at com.bea.content.paging
Filtering is used to restrict a set of IPagedList results to some subset. Supports single-property filtering with a single filter method (begins with, contains, etc) and a single filter string. For example, you can construct a filter such as: 'name' property value begins with 'foo' The set of filterable properties and the set of filter methods can both be identified via queries. Filterable properties and filter methods can either be 'native' or 'non-native'. Native properties and filter methods will perform best.
Field Summary |
---|
Fields inherited from interface com.bea.content.paging.ContentListKeys |
---|
ALL_ITEMS, BATCH_LOADING_SIZE_KEY, CUSTOM_OBJECT_FILTER, CUSTOM_OBJECT_SORT, FILTER_CRITERIA_KEY, SORT_CRITERIA_KEY |
Method Summary | |
---|---|
Set<String> |
getAllFilterableProperties()
Which properties we can filter on |
Set<FilterMethod> |
getAllFilterMethods()
Which FilterMethods we can use (begins with, contains, etc) All implementations must support UNFILTERED, but some may, for example, only be able to support EQUALS and/or BEGINS_WITH. |
Locale |
getCurrentFilterLocale()
Returns the current locale used for filtering. |
FilterMethod |
getCurrentFilterMethod()
Returns the current filter method (begins with, contains, etc) we are using -- how the results are currently filtered. |
String |
getCurrentFilterProperty()
Returns the property (if any) the results are currently filtered on. |
String |
getCurrentFilterString()
Returns the current string literal used to filter the result. |
Set<String> |
getNativeFilterableProperties()
Behaves the same as getAllFilterableProperties(), except this method returns only high-performing (native) filterable properties. |
Set<FilterMethod> |
getNativeFilterMethods()
Behaves the same as getAllFilterMethods(), except this method returns only high-performing (native) filter methods. |
void |
reFilter(FilterMethod filterMethod,
String filterString,
String filterProperty,
Locale filterLocale)
Refilter the results. |
Methods inherited from interface com.bea.content.paging.IPagedList |
---|
fullSize, getBatchLoadingSize, isFullyResolved, iterator, nativeSize, setBatchLoadingSize |
Method Detail |
---|
Set<String> getAllFilterableProperties() throws RepositoryRuntimeException
Note: a special 'custom object filter' property as defined in ContentListKeys may be present in the returned values.
RepositoryRuntimeException
Set<String> getNativeFilterableProperties() throws RepositoryRuntimeException
Note: a special 'custom object filter' property as defined in ContentListKeys may be present in the returned values.
RepositoryRuntimeException
Set<FilterMethod> getAllFilterMethods() throws RepositoryRuntimeException
RepositoryRuntimeException
Set<FilterMethod> getNativeFilterMethods() throws RepositoryRuntimeException
RepositoryRuntimeException
String getCurrentFilterProperty() throws RepositoryRuntimeException
Note: this method may return the special 'custom object filter' property as defined in ContentListKeys.
RepositoryRuntimeException
FilterMethod getCurrentFilterMethod() throws RepositoryRuntimeException
RepositoryRuntimeException
String getCurrentFilterString() throws RepositoryRuntimeException
RepositoryRuntimeException
Locale getCurrentFilterLocale() throws RepositoryRuntimeException
RepositoryRuntimeException
void reFilter(FilterMethod filterMethod, String filterString, String filterProperty, Locale filterLocale) throws UnsupportedOperationException, IllegalArgumentException, RepositoryRuntimeException
filterMethod
- the new method to use for filtering. Null is not allowed.filterString
- the string to use for filtering.
If filterMethod is UNFILTERED, this is probably ignored,
but reFilter should then reissue the query to return a full unfiltered set
of results. May not be null or empty, unlesss filterMethod is UNFILTERED.filterProperty
- the property of the result to use for filtering.
If filterMethod is UNFILTERED, this property is probably ignored (and
reFilter simply resets to the full result set). Must not be null or empty,
unless filterMethod is UNFILTERED or the implementation chooses to ignore it.
Oherwise this should match one of the names returned by getAllFilterableProperties.
This can include the special 'custom object filter' property defined in
ContentListKeys.filterLocale
- locale used to filter. Null implies that filtering should not
be based on Locale. Might be ignored if the bean or property being filtered
does not support locale-based filtering (i.e. the property is an Integer or
has no associated localized content).
UnsupportedOperationException
- if filtering can not be performed for
the given property or method.
IllegalArgumentException
- if filterMethod is null, or if the filterExpression
or filterPropery are null or empty string when filterMethod is anything
other than UNFILTERED.
RepositoryRuntimeException
|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |