Package com.lucidworks.apollo.pipeline.index.config.transform

Class FieldMappingConfig

java.lang.Object

com.lucidworks.apollo.pipeline.StageConfig

com.lucidworks.apollo.pipeline.index.config.transform.FieldMappingConfig

All Implemented Interfaces:

com.lucidworks.apollo.common.JsonConfig, com.lucidworks.apollo.common.WithAdditionalProperties

public class FieldMappingConfig
extends StageConfig

Nested Class Summary

Nested classes/interfaces inherited from class com.lucidworks.apollo.pipeline.StageConfig

StageConfig.Category

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_ID
static final String	FIELD_MAPPINGS
static final String	FIELD_RETENTION_MAPPINGS
static final String	FIELD_TRANSLATION_MAPPINGS
static final String	FIELD_UPDATE_MAPPINGS
static final String	RESERVED_FIELDS_MAPPING_ALLOWED_FLAG
static final String	TYPE
static final String	UNMAPPED_FIELD_MAPPING
static final String	UNMAPPED_FIELD_RULE

Constructor Summary

Constructors

Constructor	Description
FieldMappingConfig(String id, List<FieldMappingRule> mappings, FieldMappingRule unmapped)
FieldMappingConfig(String id, List<FieldMappingRule> mappings, FieldMappingRule unmapped, Boolean reservedFieldsMappingAllowed)
FieldMappingConfig(String id, List<FieldMappingRule> mappings, FieldMappingRule unmapped, List<FieldTranslationMapping> translationMappings, List<FieldRetentionMapping> retentionMappings, List<FieldUpdateValueMapping> updateMappings, UnmappedFieldMappingRule unmappedRule, Boolean reservedFieldsMappingAllowed)	This constructor handles both the older style of mapping fields when all operations were dealt with using the same list of FieldMappingRules (mappings) as well as the unmapped fields (unmapped).

Method Summary

Modifier and Type	Method	Description
List<FieldMappingRule>	getMappings()
List<FieldRetentionMapping>	getRetentionMappings()
List<FieldTranslationMapping>	getTranslationMappings()
FieldMappingRule	getUnmapped()
UnmappedFieldMappingRule	getUnmappedRule()
List<FieldUpdateValueMapping>	getUpdateMappings()
Boolean	isReservedFieldsMappingAllowed()
void	setMappings(List<FieldMappingRule> mappings)
void	setUnmapped(FieldMappingRule unmapped)

Methods inherited from class com.lucidworks.apollo.pipeline.StageConfig

equals, getAdditionalProperties, getCondition, getId, getLabel, getType, hashCode, isSkip, newId, setAdditionalProperty, setCondition, setLabel, setSkip

Methods inherited from class java.lang.Object

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

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

CONFIG_ID

public static final String CONFIG_ID

See Also:

• Constant Field Values

FIELD_MAPPINGS

public static final String FIELD_MAPPINGS

See Also:

• Constant Field Values

UNMAPPED_FIELD_MAPPING

public static final String UNMAPPED_FIELD_MAPPING

See Also:

• Constant Field Values

FIELD_RETENTION_MAPPINGS

public static final String FIELD_RETENTION_MAPPINGS

See Also:

• Constant Field Values

FIELD_TRANSLATION_MAPPINGS

public static final String FIELD_TRANSLATION_MAPPINGS

See Also:

• Constant Field Values

FIELD_UPDATE_MAPPINGS

public static final String FIELD_UPDATE_MAPPINGS

See Also:

• Constant Field Values

UNMAPPED_FIELD_RULE

public static final String UNMAPPED_FIELD_RULE

See Also:

• Constant Field Values

RESERVED_FIELDS_MAPPING_ALLOWED_FLAG

public static final String RESERVED_FIELDS_MAPPING_ALLOWED_FLAG

See Also:

• Constant Field Values

Constructor Details

FieldMappingConfig

public FieldMappingConfig(String id,
 List<FieldMappingRule> mappings,
 FieldMappingRule unmapped)

FieldMappingConfig

public FieldMappingConfig(String id,
 List<FieldMappingRule> mappings,
 FieldMappingRule unmapped,
 Boolean reservedFieldsMappingAllowed)

FieldMappingConfig

public FieldMappingConfig(String id,
 List<FieldMappingRule> mappings,
 FieldMappingRule unmapped,
 List<FieldTranslationMapping> translationMappings,
 List<FieldRetentionMapping> retentionMappings,
 List<FieldUpdateValueMapping> updateMappings,
 UnmappedFieldMappingRule unmappedRule,
 Boolean reservedFieldsMappingAllowed)

This constructor handles both the older style of mapping fields when all operations were dealt with using the same list of FieldMappingRules (mappings) as well as the unmapped fields (unmapped). These will continue to be used internally alongside the newer style of mappings (translationMappings, retentionMappings, updateMappings, unmappedRule) before the older style is removed at some later date.

Parameters:

id - the configuration ID

mappings - mappings used previously to cover all operations

unmapped - mapping used previously to cover unmapped fields

translationMappings - mappings for move and copy operations

retentionMappings - mappings for keep and delete operations

updateMappings - mappings for set and add operations

unmappedRule - mapping for any unmapped fields

reservedFieldsMappingAllowed - whether to allow mapping on reserved fields

Method Details

getMappings

public List<FieldMappingRule> getMappings()

setMappings

public void setMappings(List<FieldMappingRule> mappings)

getUnmapped

public FieldMappingRule getUnmapped()

setUnmapped

public void setUnmapped(FieldMappingRule unmapped)

getRetentionMappings

public List<FieldRetentionMapping> getRetentionMappings()

getUpdateMappings

public List<FieldUpdateValueMapping> getUpdateMappings()

getTranslationMappings

public List<FieldTranslationMapping> getTranslationMappings()

getUnmappedRule

public UnmappedFieldMappingRule getUnmappedRule()

isReservedFieldsMappingAllowed

public Boolean isReservedFieldsMappingAllowed()