public interface PropertyAccessor
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:
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
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.
|
static final java.lang.String CLASS_VERSION
java.lang.Object getTextPropertyValue(Context pContext, RepositoryItem pItem, java.lang.String pPropertyName)
Treat properties that begin with "$" as regular, java-bean properties, and not dynamic bean-ish repository property values.
pContext
- The current context. Contains the current URL,
the stack of parent items, etc.pItem
- The repository item whose property to getpPropertyName
- The name of the property to getjava.lang.Object getMetaPropertyValue(Context pContext, RepositoryItem pItem, java.lang.String pPropertyName, atg.repository.search.indexing.specifier.PropertyTypeEnum pType)
Treat properties that begin with "$" as regular, java-bean properties, and not dynamic bean-ish repository property values.
pContext
- The current context. Contains the current URL,
the stack of parent items, etc.pItem
- The repository item whose property to getpPropertyName
- The name of the property to getpType
- the type of the property. See the
PROP_TYPE_ constants in OutputItemSpecifier.java.lang.Object getSubItemPropertyValue(Context pContext, RepositoryItem pItem, java.lang.String pPropertyName)
pContext
- The current context. Contains the current URL,
the stack of parent items, etc.pItem
- The repository item whose property to getpPropertyName
- The name of the property to getatg.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)
pContext
- The current context. Contains the current URL,
the stack of parent items, etc.pItem
- The repository item whose constraints to getpPropertyName
- The name of the property whose contraints to getpType
- 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.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)
pContext
- The current context. Contains the current URL,
the stack of parent items, etc.pItem
- The repository item whose constraints to getpPropertyName
- The name of the property whose constraints to getpPropertyValue
- The property value returned by
getMetaPropertyValue.pSecurityConstraints
- The static security constraints from
from the definition file. May be null.void onIndexingInitialization(IndexingOutputConfig pIndexingOutputConfig, java.util.Set<java.lang.String> pPropertyNames) throws IndexingException
pIndexingOutputConfig
- The IndexingOutputConfig component
initaiting the indexpPropertyNames
- The set of property names which this
property accessor is associated with in the definition file.IndexingException
void onIndexingTermination(IndexingOutputConfig pIndexingOutputConfig, java.util.Set<java.lang.String> pPropertyNames) throws IndexingException
pIndexingOutputConfig
- The IndexingOutputConfig component
initaiting the indexpPropertyNames
- The set of property names which this
property accessor is associated with in the definition file.IndexingException