Package com.priint.pubserver.comet.bridge.preview

Annotation Type CometPreviewProcessingProperties

@Inherited
@Documented
@Retention(RUNTIME)
@Target(METHOD)
public @interface CometPreviewProcessingProperties

The CometPreviewProcessingProperties annotation defines properties to set for preview statement processing when using the standard mapping.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
java.lang.String	dataMappingMethod	Name of a method to map results of a preview method call.
java.lang.String	dataMappingPlugin	Mapped name of a Plugin to map results from a preview method call.
java.lang.String	dataProcessingMethod	Name of a method to post process results of a preview method call.
java.lang.String	dataProcessingPlugin	Mapped name of a Plugin to post process results of a preview method call.
boolean	usePlaceholderDataProcessing	Use placeholder data processing for all results.

Element Detail

dataMappingPlugin

java.lang.String dataMappingPlugin

Mapped name of a Plugin to map results from a preview method call.

This value can only be set in combination with dataMappingMethod(). If defined, results from a preview method call will be mapped to Preview objects using this method rather than the standard mapping.
Mapping methods must match these requirements:

• the first parameter must be of type java.util.List<?>
• the result type must be java.util.List<Preview>
• they should be capable of mapping any expected input type (e.g. Bucket, MediaAsset, Text, Preview...) to Preview

More values from the request context can be accessed by declaring [2..n] parameters and using one of the following defaultValues:

• String ParameterTags.Tag.MODEL_ID: the identifier of the entity model
• Context ParameterTags.Tag.ENTITY_CONTEXT: language, country, assortment ...
• String ParameterTags.Tag.ENTITY_ID: identifier of the entity
• String ParameterTags.Tag.RECORD_ID: identifier of the record
• String ParameterTags.Tag.RECORD_GROUPID: group identifier of the record
• String ParameterTags.Tag.ENTITY_CLASS: class of the entity (e.g. Bucket, KeyValue ...)
• String ParameterTags.Tag.FIND_VALUE1: search value 1
• String ParameterTags.Tag.FIND_VALUE2: search value 2

Returns:

Default:

""

dataMappingMethod

java.lang.String dataMappingMethod

Name of a method to map results of a preview method call.

This value can only be set in combination with dataMappingPlugin(). See dataMappingPlugin() for further information

Returns:

name of a method to post process preview method calls

Default:

""

dataProcessingPlugin

java.lang.String dataProcessingPlugin

Mapped name of a Plugin to post process results of a preview method call.

This value can only be set in combination with dataProcessingMethod(). If defined, results from a preview method call will be passed to this method.
Processing methods must match the following requirements:

• the first parameter must be of type java.util.List<Preview>
• the result type must be java.util.List<Preview>

More values from the request context can be accessed by declaring [2..n] parameters and using one of the following defaultValues:

• String ParameterTags.Tag.MODEL_ID: the identifier of the entity model
• Context ParameterTags.Tag.ENTITY_CONTEXT: language, country, assortment ...
• String ParameterTags.Tag.ENTITY_ID: identifier of the entity
• String ParameterTags.Tag.RECORD_ID: identifier of the record
• String ParameterTags.Tag.RECORD_GROUPID: group identifier of the record
• String ParameterTags.Tag.ENTITY_CLASS: class of the entity (e.g. Bucket, KeyValue ...)
• String ParameterTags.Tag.FIND_VALUE1: search value 1
• String ParameterTags.Tag.FIND_VALUE2: search value 2

Returns:

mapped name of a Plugin to post process preview method calls

Default:

""

dataProcessingMethod

java.lang.String dataProcessingMethod

Name of a method to post process results of a preview method call.

This value can only be set in combination with dataProcessingPlugin(). See dataProcessingPlugin() for further information

Returns:

name of a method to post process preview method calls

Default:

""

usePlaceholderDataProcessing

boolean usePlaceholderDataProcessing

Use placeholder data processing for all results.

If set to true and the statement is run from a placeholder context, all result data is processed using the same instructions like this placeholder.

Returns:

true, if placeholder data processing should be used, false otherwise

Default:

false