atg.repository.search.indexing
Interface PropertyFormatter

All Known Implementing Classes:

PropertyFormatterImpl

public interface PropertyFormatter

Property value formatter. This interface is used to convert property value objects to strings. PropertyFormatters are referenced via a "formatter" attribute on an "item" element in the indexing output XML configuration file. Typically a PropertyFormatter is instantiated via a nucleus component, and associated with a name via the formatterMap on a IndexingOutputConfig instance.

Note that the PropertyFormatter calls do not recieve a "Context" object, since they may be invoked well after the values have been collected.

Created: April 27 2005

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Method Summary

java.lang.String	formatMeta(java.lang.String pPropertyName, java.lang.String pOutputPropertyName, atg.repository.search.indexing.specifier.PropertyTypeEnum pPropertyType, java.lang.Object pValue) Format the specified meta property value.
java.lang.String	formatText(java.lang.String pPropertyName, java.lang.String pOutputPropertyName, java.lang.Object pValue) Format the specified text property value.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

formatText

java.lang.String formatText(java.lang.String pPropertyName,
                            java.lang.String pOutputPropertyName,
                            java.lang.Object pValue)

Format the specified text property value.

Parameters:

pPropertyName - the source name of the property

pOutputPropertyName - the output property name

pValue - the property's value

Returns:

the formatted string

formatMeta

java.lang.String formatMeta(java.lang.String pPropertyName,
                            java.lang.String pOutputPropertyName,
                            atg.repository.search.indexing.specifier.PropertyTypeEnum pPropertyType,
                            java.lang.Object pValue)

Format the specified meta property value.

Parameters:

pPropertyName - the source name of the property

pOutputPropertyName - the output property name

pPropertyType - the type of the meta property

pValue - the property's value

Returns:

the formatted string