atg.repository.search.indexing

Interface PropertyAccessor

All Known Implementing Classes:

ConstantValueAccessor, CustomCatalogPropertyAccessor, LanguageNameAccessor, ProjectPropertyAccessor, atg.repository.search.indexing.PropertyAccessorImpl

public interface PropertyAccessor

Interface to accessing the properties of a repository items.

Note that a single PropertyAccessor instance can be accessed from multiple threads at the same time, so each PropertyAccessor implementation should be stateless. Any needed state can be stored an attribute (or as multiple attribues) on the Context object.

The typical call order is:

• prepareNextIteration()
  • prepareNextVariant() - after each variant
    • getTextPropertyValue() or getMetaPropertyValue() (per property)
    • getTextSecurityConstraint() or getMetaSecurityConstraint() (per property value)

Created: February 07 2005

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getMetaPropertyValue(Context pContext, RepositoryItem pItem, java.lang.String pPropertyName, atg.repository.search.indexing.specifier.PropertyTypeEnum pType) Get the meta property value.
atg.repository.search.indexing.specifier.SecurityConstraints	getMetaSecurityConstraint(Context pContext, RepositoryItem pItem, java.lang.String pPropertyName, atg.repository.search.indexing.specifier.PropertyTypeEnum pType, java.lang.Object pPropertyValue, atg.repository.search.indexing.specifier.SecurityConstraints pSecurityConstraints) Get the security constraint for the specified meta property.
java.lang.Object	getSubItemPropertyValue(Context pContext, RepositoryItem pItem, java.lang.String pPropertyName) Return the value for a sub-item property.
java.lang.Object	getTextPropertyValue(Context pContext, RepositoryItem pItem, java.lang.String pPropertyName) Get the text property value.
atg.repository.search.indexing.specifier.SecurityConstraints	getTextSecurityConstraint(Context pContext, RepositoryItem pItem, java.lang.String pPropertyName, java.lang.Object pPropertyValue, atg.repository.search.indexing.specifier.SecurityConstraints pSecurityConstraints) Get the security constraint for the specified text property.
void	onIndexingInitialization(IndexingOutputConfig pIndexingOutputConfig, java.util.Set<java.lang.String> pPropertyNames) Called for custom-set property accessors before each bulk or incremental indexing process runs.
void	onIndexingTermination(IndexingOutputConfig pIndexingOutputConfig, java.util.Set<java.lang.String> pPropertyNames) Called for custom-set property accessors after each bulk or incremental indexing process runs.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

getTextPropertyValue

java.lang.Object getTextPropertyValue(Context pContext,
                                      RepositoryItem pItem,
                                      java.lang.String pPropertyName)

Get the text property value. Text property values correspond to properties contained in "text-property" elements in the XML definition file and result in "div" elements in the output XHTML document.

Treat properties that begin with "$" as regular, java-bean properties, and not dynamic bean-ish repository property values.

Parameters:

pContext - The current context. Contains the current URL, the stack of parent items, etc.

pItem - The repository item whose property to get

pPropertyName - The name of the property to get

getMetaPropertyValue

java.lang.Object getMetaPropertyValue(Context pContext,
                                      RepositoryItem pItem,
                                      java.lang.String pPropertyName,
                                      atg.repository.search.indexing.specifier.PropertyTypeEnum pType)

Get the meta property value. Property values correspond to properties contained in the meta-property" elements in the XML definition file and result in "meta" elements in the output document.

Treat properties that begin with "$" as regular, java-bean properties, and not dynamic bean-ish repository property values.

Parameters:

pContext - The current context. Contains the current URL, the stack of parent items, etc.

pItem - The repository item whose property to get

pPropertyName - The name of the property to get

pType - the type of the property. See the PROP_TYPE_ constants in OutputItemSpecifier.

getSubItemPropertyValue

java.lang.Object getSubItemPropertyValue(Context pContext,
                                         RepositoryItem pItem,
                                         java.lang.String pPropertyName)

Return the value for a sub-item property. May return a single repository item, an array, a collection, or Map of sub-items.

Parameters:

pContext - The current context. Contains the current URL, the stack of parent items, etc.

pItem - The repository item whose property to get

pPropertyName - The name of the property to get

getMetaSecurityConstraint

atg.repository.search.indexing.specifier.SecurityConstraints getMetaSecurityConstraint(Context pContext,
                                                                                       RepositoryItem pItem,
                                                                                       java.lang.String pPropertyName,
                                                                                       atg.repository.search.indexing.specifier.PropertyTypeEnum pType,
                                                                                       java.lang.Object pPropertyValue,
                                                                                       atg.repository.search.indexing.specifier.SecurityConstraints pSecurityConstraints)

Get the security constraint for the specified meta property. Implementations of this method may simply return the specified pSecurityConstraints object (which may be null), or may create an return a new SecurityConstraints object.

Parameters:

pContext - The current context. Contains the current URL, the stack of parent items, etc.

pItem - The repository item whose constraints to get

pPropertyName - The name of the property whose contraints to get

pType - the type of the property. See the PROP_TYPE_ constants in OutputItemSpecifier.

pPropertyValue - The property value returned by getMetaPropertyValue.

pSecurityConstraints - The static security constraints from from the definition file. May be null.

Returns:

the new security constraints, or null.

getTextSecurityConstraint

atg.repository.search.indexing.specifier.SecurityConstraints getTextSecurityConstraint(Context pContext,
                                                                                       RepositoryItem pItem,
                                                                                       java.lang.String pPropertyName,
                                                                                       java.lang.Object pPropertyValue,
                                                                                       atg.repository.search.indexing.specifier.SecurityConstraints pSecurityConstraints)

Get the security constraint for the specified text property. Implementations of this method may simply return the specified pSecurityConstraints object (which may be null), or may create an return a new SecurityConstraints object.

Parameters:

pContext - The current context. Contains the current URL, the stack of parent items, etc.

pItem - The repository item whose constraints to get

pPropertyName - The name of the property whose constraints to get

pPropertyValue - The property value returned by getMetaPropertyValue.

pSecurityConstraints - The static security constraints from from the definition file. May be null.

Returns:

the new security constraints, or null.

onIndexingInitialization

void onIndexingInitialization(IndexingOutputConfig pIndexingOutputConfig,
                              java.util.Set<java.lang.String> pPropertyNames)
                       throws IndexingException

Called for custom-set property accessors before each bulk or incremental indexing process runs.

Parameters:

pIndexingOutputConfig - The IndexingOutputConfig component initaiting the index

pPropertyNames - The set of property names which this property accessor is associated with in the definition file.

Throws:

IndexingException

onIndexingTermination

void onIndexingTermination(IndexingOutputConfig pIndexingOutputConfig,
                           java.util.Set<java.lang.String> pPropertyNames)
                    throws IndexingException

Called for custom-set property accessors after each bulk or incremental indexing process runs.

Parameters:

pIndexingOutputConfig - The IndexingOutputConfig component initaiting the index

pPropertyNames - The set of property names which this property accessor is associated with in the definition file.

Throws:

IndexingException