|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.endeca.portal.attributes.filter.IncludedPropertyFilter
public class IncludedPropertyFilter
A BasePropertyContainer filter that uses a specified property of the BPC object to determine whether it should be included. If the specified property is found on the BPC object and it's a boolean, then it's value is used for filtering. The filter will return true if the value of the property is true. If the property is not found, the filter will return the default value (which can be configured).
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_PROPERTY_NAME
Default property name to mark whether a BPC is included. |
Constructor Summary | |
---|---|
IncludedPropertyFilter()
Default constructor. |
|
IncludedPropertyFilter(java.lang.String propertyName)
Constructor that allows specifying the propertyName parameter. |
|
IncludedPropertyFilter(java.lang.String propertyName,
boolean includeByDefault)
Full constructor. |
Method Summary | |
---|---|
java.lang.String |
getPropertyName()
|
boolean |
isIncludeByDefault()
|
void |
setIncludeByDefault(boolean includeByDefault)
|
void |
setPropertyName(java.lang.String propertyName)
|
boolean |
test(BasePropertyContainer bpc)
Checks whether the BPC contains the property as specified by the propertyName parameter of this filter. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DEFAULT_PROPERTY_NAME
Constructor Detail |
---|
public IncludedPropertyFilter()
DEFAULT_PROPERTY_NAME
and
the includeByDefault to false
public IncludedPropertyFilter(java.lang.String propertyName)
propertyName
- public IncludedPropertyFilter(java.lang.String propertyName, boolean includeByDefault)
propertyName
- includeByDefault
- Method Detail |
---|
public void setPropertyName(java.lang.String propertyName)
propertyName
- the propertyName to setpublic java.lang.String getPropertyName()
public void setIncludeByDefault(boolean includeByDefault)
includeByDefault
- the includeByDefault to setpublic boolean isIncludeByDefault()
public boolean test(BasePropertyContainer bpc)
test
in interface BPCFilter
bpc
-
BPCFilter
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |