eu.ehri.project.persistence

Class ErrorSet

java.lang.Object

eu.ehri.project.persistence.ErrorSet

All Implemented Interfaces:

NestableData<ErrorSet>

public final class ErrorSet
extends Object
implements NestableData<ErrorSet>

Class that represents a set of validation errors associated with a bundle.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ErrorSet.Builder Builder class for creating an Error set.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR_KEY
static String	REL_KEY Serialization constant definitions

Constructor Summary

Constructors

Constructor and Description
ErrorSet() Constructor.
ErrorSet(com.google.common.collect.Multimap<String,String> errors) Constructor.
ErrorSet(com.google.common.collect.Multimap<String,String> errors, com.google.common.collect.Multimap<String,ErrorSet> relations) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
static ErrorSet	fromError(String key, String error) Factory constructor.
Collection<String>	getDataValue(String key) Get errors for a key.
com.google.common.collect.Multimap<String,String>	getErrors() Get the top-level errors.
com.google.common.collect.Multimap<String,ErrorSet>	getRelations() Get the bundle's relation bundles.
List<ErrorSet>	getRelations(String relation) Get a set of relations.
int	hashCode()
boolean	hasRelations(String relation)
boolean	isEmpty() Is this ErrorSet empty? It will be if there are no errors and none of the relations have errors.
ErrorSet	removeDataValue(String key)
ErrorSet	replaceRelations(com.google.common.collect.Multimap<String,ErrorSet> relations)
Map<String,Object>	toData() Serialize a error set to raw data.
String	toJson() Serialize a error set to a JSON string.
String	toString()
ErrorSet	withDataValue(String key, Object err) Set a value in the bundle's data.
ErrorSet	withRelation(String relation, ErrorSet other) Add a bundle for a particular relation.
ErrorSet	withRelations(com.google.common.collect.Multimap<String,ErrorSet> newRelations) Add entire set of relations.
ErrorSet	withRelations(String relation, List<ErrorSet> others) Set bundles for a particular relation.

Methods inherited from class java.lang.Object

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

Field Detail

REL_KEY

public static final String REL_KEY

Serialization constant definitions

See Also:

Constant Field Values

ERROR_KEY

public static final String ERROR_KEY

See Also:

Constant Field Values

Constructor Detail

ErrorSet

public ErrorSet()

Constructor.

ErrorSet

public ErrorSet(com.google.common.collect.Multimap<String,String> errors)

Constructor.

Parameters:

errors - A map of top-level errors

ErrorSet

public ErrorSet(com.google.common.collect.Multimap<String,String> errors,
                com.google.common.collect.Multimap<String,ErrorSet> relations)

Constructor.

Parameters:

errors - A map of top-level errors

relations - A map of relations

Method Detail

fromError

public static ErrorSet fromError(String key,
                                 String error)

Factory constructor.

Parameters:

key - The property key in error

error - The string description of the property error

getDataValue

public Collection<String> getDataValue(String key)

Get errors for a key.

Specified by:

getDataValue in interface NestableData<ErrorSet>

Parameters:

key - A property key

Returns:

A list of errors associated with a property key

getErrors

public com.google.common.collect.Multimap<String,String> getErrors()

Get the top-level errors.

Returns:

All top-level errors

getRelations

public com.google.common.collect.Multimap<String,ErrorSet> getRelations()

Get the bundle's relation bundles.

Specified by:

getRelations in interface NestableData<ErrorSet>

Returns:

A set of relations

withRelations

public ErrorSet withRelations(com.google.common.collect.Multimap<String,ErrorSet> newRelations)

Add entire set of relations.

Specified by:

withRelations in interface NestableData<ErrorSet>

Parameters:

newRelations - A map of relations

Returns:

A new error set

getRelations

public List<ErrorSet> getRelations(String relation)

Get a set of relations.

Specified by:

getRelations in interface NestableData<ErrorSet>

Parameters:

relation - A relation label

Returns:

A new error set

hasRelations

public boolean hasRelations(String relation)

Specified by:

hasRelations in interface NestableData<ErrorSet>

replaceRelations

public ErrorSet replaceRelations(com.google.common.collect.Multimap<String,ErrorSet> relations)

Specified by:

replaceRelations in interface NestableData<ErrorSet>

withDataValue

public ErrorSet withDataValue(String key,
                              Object err)

Set a value in the bundle's data.

Specified by:

withDataValue in interface NestableData<ErrorSet>

Parameters:

key - A property key

err - A description of the error

Returns:

A new error set

removeDataValue

public ErrorSet removeDataValue(String key)

Specified by:

removeDataValue in interface NestableData<ErrorSet>

withRelations

public ErrorSet withRelations(String relation,
                              List<ErrorSet> others)

Set bundles for a particular relation.

Specified by:

withRelations in interface NestableData<ErrorSet>

Parameters:

relation - A relation label

others - A set of relation error sets

Returns:

A new error set

withRelation

public ErrorSet withRelation(String relation,
                             ErrorSet other)

Add a bundle for a particular relation.

Specified by:

withRelation in interface NestableData<ErrorSet>

Parameters:

relation - A relation label

other - An error set relation

toData

public Map<String,Object> toData()

Serialize a error set to raw data.

Returns:

A map of data

toString

public String toString()

Overrides:

toString in class Object

toJson

public String toJson()

Serialize a error set to a JSON string.

Returns:

json string

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isEmpty

public boolean isEmpty()

Is this ErrorSet empty? It will be if there are no errors and none of the relations have errors.

Returns:

Whether or not the set is empty.