ma.glasnost.orika.impl

Class AggregateFilter

java.lang.Object

ma.glasnost.orika.impl.AggregateFilter

All Implemented Interfaces:

Filter<Object,Object>, MappedTypePair<Object,Object>

public class AggregateFilter
extends Object
implements Filter<Object,Object>

AggregateFilter provides the capability to combine multiple filters together to act as a single filter

Author:

mattdeboer

Constructor Summary

Constructors

Constructor and Description
AggregateFilter(List<Filter<Object,Object>> filters) Constructs a new Aggregate Filter composed of the provided filters

Method Summary

Modifier and Type	Method and Description
boolean	appliesTo(Property source, Property destination) This method will be called at build time to determine if this filter should be applied to the mapping of the specified properties
<D> D	filterDestination(D destinationValue, Type<?> sourceType, String sourceName, Type<D> destType, String destName, MappingContext mappingContext) This method is called to provide the Filter an opportunity to modify the destination field's value in some way before it is mapped onto the destination type.
boolean	filtersDestination() Called at code generation time to determine whether this filter modifies the destination.
<S> S	filterSource(S sourceValue, Type<S> sourceType, String sourceName, Type<?> destType, String destName, MappingContext mappingContext) This method is called to provide the Filter an opportunity to replace the source field value before it is passed into the mapping code which transforms it to the destination type.
boolean	filtersSource() Called at code generation time to determine whether this filter modifies the source.
Type<Object>	getAType()
Type<Object>	getBType()
<S,D> boolean	shouldMap(Type<S> sourceType, String sourceName, S source, Type<D> destType, String destName, D dest, MappingContext mappingContext) This method is called at runtime to determine whether the mapping implied by the field names and types should be performed; if false is returned, the mapping is skipped.

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregateFilter

public AggregateFilter(List<Filter<Object,Object>> filters)

Constructs a new Aggregate Filter composed of the provided filters

Parameters:

filters -

Method Detail

getAType

public Type<Object> getAType()

Specified by:

getAType in interface MappedTypePair<Object,Object>

Returns:

the 'A' type for this mapped pair

getBType

public Type<Object> getBType()

Specified by:

getBType in interface MappedTypePair<Object,Object>

Returns:

the 'B' type for this mapped pair

appliesTo

public boolean appliesTo(Property source,
                         Property destination)

Description copied from interface: Filter

This method will be called at build time to determine if this filter should be applied to the mapping of the specified properties

Specified by:

appliesTo in interface Filter<Object,Object>

Parameters:

source - the source property

destination - the destination property

Returns:

true if this Filter applies

filtersSource

public boolean filtersSource()

Description copied from interface: Filter

Called at code generation time to determine whether this filter modifies the source.

Implementations should not implement dynamic behavior here, as this method will most likely be called only once (at generation time) for a given Filter instance.

Specified by:

filtersSource in interface Filter<Object,Object>

Returns:

true if this Filter should be called to filter the source value the mapping results

filtersDestination

public boolean filtersDestination()

Description copied from interface: Filter

Called at code generation time to determine whether this filter modifies the destination.

Implementations should not implement dynamic behavior here, as this method will most likely be called only once (at generation time) for a given Filter instance.

Specified by:

filtersDestination in interface Filter<Object,Object>

Returns:

true if this Filter should be called to filter the destination of the mapping results

shouldMap

public <S,D> boolean shouldMap(Type<S> sourceType,
                               String sourceName,
                               S source,
                               Type<D> destType,
                               String destName,
                               D dest,
                               MappingContext mappingContext)

Description copied from interface: Filter

This method is called at runtime to determine whether the mapping implied by the field names and types should be performed; if false is returned, the mapping is skipped.

Specified by:

shouldMap in interface Filter<Object,Object>

Parameters:

sourceType - the type of the source field

sourceName - the name of the source field

source - the value of the source field

destType - the type of the destination field

destName - the name of the destination field

dest - the value of the destination field

mappingContext - the current mapping context

Returns:

true if the fields represented by these types and names

filterDestination

public <D> D filterDestination(D destinationValue,
                               Type<?> sourceType,
                               String sourceName,
                               Type<D> destType,
                               String destName,
                               MappingContext mappingContext)

Description copied from interface: Filter

This method is called to provide the Filter an opportunity to modify the destination field's value in some way before it is mapped onto the destination type.

Note that the return value should still be an instance of the provided destination type, else ClassCastException will likely occur.

Specified by:

filterDestination in interface Filter<Object,Object>

Parameters:

destinationValue - the destination value

sourceType - the type of the source field

sourceName - the name of the source field

destType - the type of the destination field

destName - the name of the destination field

mappingContext - the current mapping context

Returns:

the filtered output value

filterSource

public <S> S filterSource(S sourceValue,
                          Type<S> sourceType,
                          String sourceName,
                          Type<?> destType,
                          String destName,
                          MappingContext mappingContext)

Description copied from interface: Filter

This method is called to provide the Filter an opportunity to replace the source field value before it is passed into the mapping code which transforms it to the destination type.

It's recommended that the filter should return a new instance if it's necessary to modify the source, as a mapping request is not generally expected to have side effects on the source.

Specified by:

filterSource in interface Filter<Object,Object>

Parameters:

sourceValue - the source value

sourceType - the type of the source field

sourceName - the name of the source field

destType - the type of the destination field

destName - the name of the destination field

mappingContext - the current mapping context

Returns:

the filtered output value