org.dataone.service.types

Class TypeCompareUtil

java.lang.Object

org.dataone.service.types.TypeCompareUtil

public class TypeCompareUtil
extends Object

This utility class provides an efficient way to test bean-style data objects (of the same type) for differences in property values. It uses reflection, so there's a categorical performance hit compared to non-general-case solutions you might write yourself. The reason for use of reflection is to decouple it from datatype definitions that may change over the long term.

Author:

rnahf

Constructor Summary

Constructors

Constructor and Description
TypeCompareUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static List<String>	compareD1ServiceType(Map<String,Object> d1ServiceTypeMap, Boolean sortArrays) This method will compare any number of dataone service-type objects of the same type to each other and return a report of every field where there is a difference.
static List<String>	compareSystemMetadata(SystemMetadata sysmeta1, SystemMetadata sysmeta2) Reports the properties of a systemMetadata object, one per line in xpath fashion.
static LinkedHashMap<String,String>	getD1SubtypesListing(Object o) A recursive method that returns a map of key value pairs that correspond to the property paths (keys) and values of the object passed in.
static LinkedHashMap<String,String>	getD1SubtypesListing(String path, Object o, boolean sortArrays) A recursive method that returns a map of key value pairs that correspond to the property paths (keys) and values of the object passed in.
static LinkedHashMap<String,String>	getD1SubtypesListing(String path, Object o, boolean sortArrays, boolean flattenSimpleTypeLists)
static List<String>	reportSubtypesListing(Object o, Boolean sort) Generates a tabular listing of the field names and values, suitable for display.

Methods inherited from class java.lang.Object

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

Constructor Detail

TypeCompareUtil

public TypeCompareUtil()

Method Detail

compareSystemMetadata

public static List<String> compareSystemMetadata(SystemMetadata sysmeta1,
                                 SystemMetadata sysmeta2)

Reports the properties of a systemMetadata object, one per line in xpath fashion. the values of each property follow in subsequent columns per line.

Parameters:

sysmeta1 -

sysmeta2 -

Returns:

- the report as a List of differences

compareD1ServiceType

public static List<String> compareD1ServiceType(Map<String,Object> d1ServiceTypeMap,
                                Boolean sortArrays)

This method will compare any number of dataone service-type objects of the same type to each other and return a report of every field where there is a difference. Multi-valued fields are sorted by default to minimize reporting of meaningless differences, but with the possible side-effect of shifting elements out of alignment and reporting more rows than differences when there are differences.

Parameters:

d1ServiceTypeMap - - a map of dataone service-type objects

sortArrays - - Boolean: if set to false, will not sort the arrays prior to comparison.

Returns:

- a table of fields where there are differences

getD1SubtypesListing

public static LinkedHashMap<String,String> getD1SubtypesListing(Object o)

A recursive method that returns a map of key value pairs that correspond to the property paths (keys) and values of the object passed in. It depends on bean-style getter methods to find the properties of the object. It will sort subtypes that are arrays when order doesn't matter. For a strict non-sorting listing, use getD1SubtypesListing(String path, Object o, boolean sortArrays) and set sortArrays to false.

Parameters:

o - - the dataone object

Returns:

using LinkedHashMap to ensure order read equals order listed

getD1SubtypesListing

public static LinkedHashMap<String,String> getD1SubtypesListing(String path,
                                                Object o,
                                                boolean sortArrays)

A recursive method that returns a map of key value pairs that correspond to the property paths (keys) and values of the object passed in. It depends on bean-style getter methods to find the properties of the object. Both empty lists and null values yield the value 'null'

Parameters:

path -

o - - the dataone object

sortArrays - - true will sort array subtypes so they can be logically compared

Returns:

using LinkedHashMap to ensure order read equals order listed

getD1SubtypesListing

public static LinkedHashMap<String,String> getD1SubtypesListing(String path,
                                                Object o,
                                                boolean sortArrays,
                                                boolean flattenSimpleTypeLists)

reportSubtypesListing

public static List<String> reportSubtypesListing(Object o,
                                 Boolean sort)

Generates a tabular listing of the field names and values, suitable for display.

Parameters:

o -

Returns: