eu.ehri.project.persistence.utils

Class DataUtils

java.lang.Object

eu.ehri.project.persistence.utils.DataUtils

public class DataUtils
extends Object

Helpers for working with the NestableData format.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataUtils.BundlePathError

Constructor Summary

Constructors

Constructor and Description
DataUtils()

Method Summary

Modifier and Type	Method and Description
static <N extends NestableData<N>> N	delete(N item, String path) XPath-like method for deleting the value of a nested relation's attribute.
static <N extends NestableData<N>> N	deleteItem(N item, String path) XPath-like method for deleting a node from a nested tree, i.e:
static <T,N extends NestableData<N>> T	get(N item, String path) XPath-like method for getting the value of a nested relation's attribute.
static <N extends NestableData<N>> N	getItem(N item, String path) XPath-like method for getting a item at a given path.
static <N extends NestableData<N>> List<N>	getRelations(N item, String path) Xpath-like method to fetch a set of nested relations.
static <T,N extends NestableData<N>> N	set(N item, String path, T value) Xpath-like method for creating a new item by updating a nested relation of an existing item.
static <N extends NestableData<N>> N	setItem(N item, String path, N newItem) Xpath-like method for creating a new item by updating a nested relation of an existing item.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataUtils

public DataUtils()

Method Detail

get

public static <T,N extends NestableData<N>> T get(N item,
                                                  String path)

XPath-like method for getting the value of a nested relation's attribute.

 
 String lang = DataUtils.get(item, "describes[0]/languageCode"));
 
 

Type Parameters:

T - the type to fetch

Parameters:

item - the item

path - a path string

Returns:

a property of type T

getItem

public static <N extends NestableData<N>> N getItem(N item,
                                                    String path)

XPath-like method for getting a item at a given path.

 
 Bundle description = DataUtils.getItem(item, "describes[0]"));
 
 

Parameters:

item - the item

path - a path string

Returns:

a item found at the given path

delete

public static <N extends NestableData<N>> N delete(N item,
                                                   String path)

XPath-like method for deleting the value of a nested relation's attribute.

 
 Bundle newBundle = DataUtils.delete(item, "describes[0]/languageCode"));
 
 

Parameters:

item - the item

path - a path string

Returns:

the item with the item at the given path deleted

deleteItem

public static <N extends NestableData<N>> N deleteItem(N item,
                                                       String path)

XPath-like method for deleting a node from a nested tree, i.e:

 
 Bundle newBundle = DataUtils.deleteItem(item, "describes[0]"));
 
 

Parameters:

item - the item

path - a path string

Returns:

the item with the item at the given path deleted

set

public static <T,N extends NestableData<N>> N set(N item,
                                                  String path,
                                                  T value)

Xpath-like method for creating a new item by updating a nested relation of an existing item.

 
 Bundle newBundle = DataUtils.set(oldBundle, "hasDate[0]/startDate", "1923-10-10");
 
 

Type Parameters:

T - the type of property being set

Parameters:

item - the item

path - a path string

value - the value being set

Returns:

the item with the property at the given path set

setItem

public static <N extends NestableData<N>> N setItem(N item,
                                                    String path,
                                                    N newItem)

Xpath-like method for creating a new item by updating a nested relation of an existing item.

 
 Bundle dateBundle = ...
 Bundle newItem = DataUtils.setItem(oldBundle, "hasDate[0]", dateBundle);
 
 

Use an index of -1 to create a relationship set or append to an existing one.

Parameters:

item - the item

path - a path string

newItem - the new item to set at the path

Returns:

a item with the given item set at the given path

getRelations

public static <N extends NestableData<N>> List<N> getRelations(N item,
                                                               String path)

Xpath-like method to fetch a set of nested relations.

 
 List<Bundle> dates = DataUtils.getRelations(item, "hasDate");
 
 

Parameters:

item - the item

path - a path string

Returns:

a list of bundles at the given relationship path