atg.repository.search.indexing.filter

Class ConcatFilter

java.lang.Object

atg.repository.search.indexing.filter.ConcatFilter

All Implemented Interfaces:

PropertyValuesFilter, PropertyValuesFilter.ReversiblePropertyValuesFilter

public class ConcatFilter
extends java.lang.Object
implements PropertyValuesFilter.ReversiblePropertyValuesFilter

Implement a filter that concatonates the values into a single value.

Created: April 28 2005

Nested Class Summary

Nested classes/interfaces inherited from interface atg.repository.search.indexing.PropertyValuesFilter

PropertyValuesFilter.ReversiblePropertyValuesFilter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Constructor Summary

Constructors

Constructor and Description
ConcatFilter()

Method Summary

Modifier and Type	Method and Description
boolean	applyAfterFormatting() Apply this filter after formatting.
atg.repository.search.indexing.ValueAndSecurity[]	filter(java.lang.String pPropertyName, atg.repository.search.indexing.ValueAndSecurity[] pValues) Filter the specified values.
boolean	getEscapeWithQuoting() Returns property mSeparator.
char	getSeparator() Returns property mSeparator.
atg.repository.search.indexing.ValueAndSecurity[]	reverseFilter(java.lang.String pPropertyName, atg.repository.search.indexing.ValueAndSecurity[] pValueAndSecurities) Reverse the original filtering.
void	setEscapeWithQuoting(boolean pEscapeWithQuoting) Sets property mSeparator.
void	setSeparator(char pSeparator) Sets property mSeparator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ConcatFilter

public ConcatFilter()

Method Detail

setSeparator

public void setSeparator(char pSeparator)

Sets property mSeparator.

getSeparator

public char getSeparator()

Returns property mSeparator.

setEscapeWithQuoting

public void setEscapeWithQuoting(boolean pEscapeWithQuoting)

Sets property mSeparator.

getEscapeWithQuoting

public boolean getEscapeWithQuoting()

Returns property mSeparator.

applyAfterFormatting

public boolean applyAfterFormatting()

Apply this filter after formatting.

Specified by:

applyAfterFormatting in interface PropertyValuesFilter

Returns:

true if values should have been formatted/stringified before the filter is invoked, false either formatted or unformatted is okay.

filter

public atg.repository.search.indexing.ValueAndSecurity[] filter(java.lang.String pPropertyName,
                                                                atg.repository.search.indexing.ValueAndSecurity[] pValues)

Filter the specified values. Return the filtered list of values. Some filters ("add" or "concat") might return an array with a single value. Others ("unique") might return multiple values.

Specified by:

filter in interface PropertyValuesFilter

Parameters:

pPropertyName - the name of the property

pValues - and array of values with their corresponding security elements.

reverseFilter

public atg.repository.search.indexing.ValueAndSecurity[] reverseFilter(java.lang.String pPropertyName,
                                                                       atg.repository.search.indexing.ValueAndSecurity[] pValueAndSecurities)

Description copied from interface: PropertyValuesFilter.ReversiblePropertyValuesFilter

Reverse the original filtering. Note that input security information is not guaranteed to be unique, in this case.

Specified by:

reverseFilter in interface PropertyValuesFilter.ReversiblePropertyValuesFilter

Parameters:

pPropertyName - the name of the property

pValueAndSecurities - and array of values with their corresponding security elements.