org.osgl.util

Enum DataMapper.Semantic

java.lang.Object

java.lang.Enum<DataMapper.Semantic>

org.osgl.util.DataMapper.Semantic

All Implemented Interfaces:

Serializable, Comparable<DataMapper.Semantic>

Enclosing class:

DataMapper

public static enum DataMapper.Semantic
extends Enum<DataMapper.Semantic>

The mapping semantic steering the mapping logic

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEEP_COPY Recursively copy data from source data structure into target data structure.
FLAT_COPY Recursively copy data from source data structure into target Map structure.
MAP Recursively map data from source data structure into target data structure.
MERGE Recursively merge data from source data structure into target data structure.
MERGE_MAP Recursively map data from source data structure into target data structure.
SHALLOW_COPY Copy the reference from source properties to target properties.

Method Summary

Modifier and Type	Method and Description
static DataMapper.Semantic	valueOf(String name) Returns the enum constant of this type with the specified name.
static DataMapper.Semantic[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SHALLOW_COPY

public static final DataMapper.Semantic SHALLOW_COPY

Copy the reference from source properties to target properties. * require property type be exactly match between source and target data * if there are more properties in the target data, the extra properties will be set to `null` or default value if they are primitive types

DEEP_COPY

public static final DataMapper.Semantic DEEP_COPY

Recursively copy data from source data structure into target data structure. * intermediate data structure can be different between source and target * the terminate data type must match exactly * if there are more properties in the target data, the extra properties will be set to `null` or default value if they are primitive types * if there are existing data in collection of target data structure, the existing data must be cleared before copy happening

FLAT_COPY

public static final DataMapper.Semantic FLAT_COPY

Recursively copy data from source data structure into target Map structure. The nested data will be flatmap to top level. E.g ``` { id: 123 name: foo address: streetNo: 1 streetName: George St } ``` will be flat into ``` { id: 123 name: foo address.streetNo: 1 address.streetName: George St } ``` Note this semantic only applied when target is a Map and key type is String, otherwise an IllegalStateException will be thrown out.

MERGE

public static final DataMapper.Semantic MERGE

Recursively merge data from source data structure into target data structure. This semantic is same as DEEP_COPY except: * if there are more properties in the target data, the extra properties will be left untouched * if there are existing data in collection of target data structure, the data will be merged or untouched

MAP

public static final DataMapper.Semantic MAP

Recursively map data from source data structure into target data structure. This semantic is same as DEEP_COPY except: * the terminate data type can be different, in which case type conversion will be used.

MERGE_MAP

public static final DataMapper.Semantic MERGE_MAP

Recursively map data from source data structure into target data structure. This semantic is same as MERGE except: * the terminate data type can be different, in which case type conversion will be used.

Method Detail

values

public static DataMapper.Semantic[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DataMapper.Semantic c : DataMapper.Semantic.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DataMapper.Semantic valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null