|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PropertyValuesFilter
The filter interface. Used to filter/modify/process multiple occurances
of values in a document. Implementations of this class can be used to
concatonate, reorder or add values. Filters are applied toward the end of
document creation, after all the property values have been gathered. They
may be applied before or after PropertyFormatter
s, depending on
the result of the applyAfterFormatting()
method.
Filters are referenced via a "filter" attribute on a "property" element
in the indexing output XML configuration file. Typically a
PropertyValuesFilter is instantiated via a nucleus component, and
associated with a name via the filterMap on a IndexingOutputConfig
.
Created: April 28 2005
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
Method Summary | |
---|---|
boolean |
applyAfterFormatting()
Whether to apply summarizing after formatting/stringification. |
ValueAndSecurity[] |
filter(java.lang.String pPropertyName,
ValueAndSecurity[] pValueAndSecurities)
Summarize the specified values. |
Field Detail |
---|
static final java.lang.String CLASS_VERSION
Method Detail |
---|
boolean applyAfterFormatting()
If this method returns true, a PropertyFormatter
is invoked to convert any values into strings.
ValueAndSecurity[] filter(java.lang.String pPropertyName, ValueAndSecurity[] pValueAndSecurities)
pPropertyName
- the name of the propertypValueAndSecurities
- and array of values with
their corresponding security elements.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |