com.hybris.cockpitng.validation.model

Class ValidationResult

java.lang.Object

com.hybris.cockpitng.core.model.impl.AbstractObservable

com.hybris.cockpitng.validation.model.ValidationResult

All Implemented Interfaces:

Observable

public class ValidationResult
extends AbstractObservable

Field Summary

Fields

Modifier and Type	Field and Description
static ValidationResult	EMPTY

Fields inherited from class com.hybris.cockpitng.core.model.impl.AbstractObservable

mutex

Constructor Summary

Constructors

Modifier	Constructor and Description
	ValidationResult() Creates empty validation result
	ValidationResult(List<ValidationInfo> result) Creates validation result with root validation violations as specified
	ValidationResult(List<ValidationInfo> result, String prefix, boolean withPrefix) Creates validation result with or without given prefix
protected	ValidationResult(ValidationInfoFactory infoFactory, boolean dirty, List<ValidationInfo> result)

Method Summary

Modifier and Type	Method and Description
void	addValidationInfo(String path, Collection<ValidationInfo> validationInfos) Adds new validation violations to current container.
void	addValidationInfo(ValidationInfo info) Adds new validation violation to current container.
protected boolean	checkDirty() Checks whether container is sorted.
void	clear() Removes all validation violations registered in current container.
boolean	contains(String path) Checks whether container contains any validation violation for specified path.
boolean	containsNotConfirmedSeverity(ValidationSeverity severity) Checks whether container contains any validation violation with specified severity that is not confirmed.
boolean	containsSeverity(ValidationSeverity severity) Checks whether container contains any validation violation with specified severity.
protected List<ValidationInfo>	createResultList(List<ValidationInfo> init)
protected ValidationInfoFactory	createWithoutPrefixFactory(String prefix)
protected ValidationInfoFactory	createWithPrefixFactory(String prefix)
boolean	equals(Object o)
ValidationResultSet	find(String path) Gets all validation violations contained by this container that are related to specified path or it's subpaths.
ValidationResultSet	findNotConfirmed(String path) Gets all validation violations contained by this container that are related to specified path or it's subpaths and are not confirmed.
ValidationResultSet	get(String prefix) Gets all validation violations contained by this container that are related to specified prefix or it's subpaths.
ValidationResultSet	get(ValidationSeverity severity) Gets all validation violations contained by this container that has specified severity level.
List<ValidationInfo>	getAll() Gets all validation violations that are contained by this container.
ValidationResultSet	getConfirmed() Gets all validation violations contained by this container that are confirmed.
ValidationSeverity	getHighestNotConfirmedSeverity() Gets highest severity of violations contained by container that are not confirmed.
ValidationInfo	getHighestNotConfirmedSeverityInfo() Gets violation with highest severity of violations contained by container that are not confirmed.
ValidationSeverity	getHighestSeverity() Gets highest severity of violations contained by container.
ValidationInfo	getHighestSeverityInfo() Gets violation with highest severity of violations contained by container.
ValidationResultSet	getNotConfirmed() Gets all validation violations contained by this container that are not confirmed.
ValidationResultSet	getNotConfirmed(String path) Gets all validation violations contained by this container that are related to specified path or it's subpaths and are not confirmed.
ValidationResultSet	getNotConfirmed(ValidationSeverity severity) Gets all validation violations contained by this container that has specified severity level are not confirmed.
protected Stream<ValidationInfo>	getNotConfirmedStream(String path)
protected Stream<ValidationInfo>	getStream(String path)
int	hashCode()
protected boolean	isDirty() Checks whether container is sorted.
protected void	markDirty() Marks container as unsorted
protected boolean	pathsMatches(String expected, String actual) Checks whether provided paths matches
protected void	removeImmediately(String path)
void	removeValidationInfo(String path) Removes all validation violations from specified path and its subpaths from current container with provided.
void	removeValidationInfo(ValidationInfo info) Removes validation violation from current container
void	setValidationInfo(Collection<ValidationInfo> validationInfos) Replaces all validation violations registered in current container with provided.
void	setValidationInfo(String path, Collection<ValidationInfo> validationInfos) Replaces violations related to provided path with their new instances.
int	size() Gets number of violations contained by this container
void	updateValidationInfo(Collection<ValidationInfo> validationInfos) Replaces violations with their new instances.
void	updateValidationInfo(String path, Collection<ValidationInfo> validationInfos) Replaces violations with their new instances.

Methods inherited from class com.hybris.cockpitng.core.model.impl.AbstractObservable

addObserver, alreadyExists, changed, changed, getObservedValues, getObservers, removeObserver, removeObserver

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hybris.cockpitng.core.model.Observable

addObserver

Field Detail

EMPTY

public static final ValidationResult EMPTY

Constructor Detail

ValidationResult

public ValidationResult()

Creates empty validation result

ValidationResult

public ValidationResult(List<ValidationInfo> result,
                        String prefix,
                        boolean withPrefix)

Creates validation result with or without given prefix

ValidationResult

public ValidationResult(List<ValidationInfo> result)

Creates validation result with root validation violations as specified

Parameters:

result - root violations

ValidationResult

protected ValidationResult(ValidationInfoFactory infoFactory,
                           boolean dirty,
                           List<ValidationInfo> result)

Parameters:

infoFactory - root info factory

dirty - true if provided violations are not sorted

result - root violations

Method Detail

createResultList

protected List<ValidationInfo> createResultList(List<ValidationInfo> init)

checkDirty

protected boolean checkDirty()

Checks whether container is sorted. If then, then all violations are being sorted descending by their severity.

Returns:

true if container was just sorted

markDirty

protected void markDirty()

Marks container as unsorted

isDirty

protected boolean isDirty()

Checks whether container is sorted.

Returns:

true if container need to be sorted

See Also:

checkDirty()

size

public int size()

Gets number of violations contained by this container

Returns:

number of contained violations

getAll

public List<ValidationInfo> getAll()

Gets all validation violations that are contained by this container. Violations remain as relative to containers root.

Returns:

all validation violations from container

get

public ValidationResultSet get(ValidationSeverity severity)

Gets all validation violations contained by this container that has specified severity level. Violations remain as relative to containers root.

Parameters:

severity - requested severity level

Returns:

search result

getNotConfirmed

public ValidationResultSet getNotConfirmed()

Gets all validation violations contained by this container that are not confirmed. Violations remain as relative to containers root.

Returns:

search result

getConfirmed

public ValidationResultSet getConfirmed()

Gets all validation violations contained by this container that are confirmed. Violations remain as relative to containers root.

Returns:

search result

getNotConfirmed

public ValidationResultSet getNotConfirmed(ValidationSeverity severity)

Gets all validation violations contained by this container that has specified severity level are not confirmed. Violations remain as relative to containers root.

Parameters:

severity - requested severity level

Returns:

search result

pathsMatches

protected boolean pathsMatches(String expected,
                               String actual)

Checks whether provided paths matches

Parameters:

expected - path that is expected

actual - path found in violation

Returns:

true if violation path is equal to expected or it's subpath

createWithPrefixFactory

protected ValidationInfoFactory createWithPrefixFactory(String prefix)

createWithoutPrefixFactory

protected ValidationInfoFactory createWithoutPrefixFactory(String prefix)

getStream

protected Stream<ValidationInfo> getStream(String path)

get

public ValidationResultSet get(String prefix)

Gets all validation violations contained by this container that are related to specified prefix or it's subpaths. Violations returned are relative to provided prefix.

Parameters:

prefix - violations path

Returns:

search result

find

public ValidationResultSet find(String path)

Gets all validation violations contained by this container that are related to specified path or it's subpaths. Violations remain as relative to containers root.

Parameters:

path - violations path

Returns:

search result

getNotConfirmedStream

protected Stream<ValidationInfo> getNotConfirmedStream(String path)

getNotConfirmed

public ValidationResultSet getNotConfirmed(String path)

Gets all validation violations contained by this container that are related to specified path or it's subpaths and are not confirmed. Violations returned are relative to provided path.

Parameters:

path - violations path

Returns:

search result

findNotConfirmed

public ValidationResultSet findNotConfirmed(String path)

Gets all validation violations contained by this container that are related to specified path or it's subpaths and are not confirmed. Violations remain as relative to containers root.

Parameters:

path - violations path

Returns:

search result

getHighestSeverity

public ValidationSeverity getHighestSeverity()

Gets highest severity of violations contained by container.

Returns:

highest severity or ValidationSeverity.NONE if container is empty

getHighestSeverityInfo

public ValidationInfo getHighestSeverityInfo()

Gets violation with highest severity of violations contained by container.

Returns:

violation with highest severity or null if container is empty

getHighestNotConfirmedSeverity

public ValidationSeverity getHighestNotConfirmedSeverity()

Gets highest severity of violations contained by container that are not confirmed.

Returns:

highest severity or ValidationSeverity.NONE if container is empty

getHighestNotConfirmedSeverityInfo

public ValidationInfo getHighestNotConfirmedSeverityInfo()

Gets violation with highest severity of violations contained by container that are not confirmed.

Returns:

violation with highest severity or null if container is empty

containsSeverity

public boolean containsSeverity(ValidationSeverity severity)

Checks whether container contains any validation violation with specified severity.

Parameters:

severity - violations severity

Returns:

true if at least one violation is of specified severity

containsNotConfirmedSeverity

public boolean containsNotConfirmedSeverity(ValidationSeverity severity)

Checks whether container contains any validation violation with specified severity that is not confirmed.

Parameters:

severity - violations severity

Returns:

true if at least one violation is of specified severity and is not confirmed

contains

public boolean contains(String path)

Checks whether container contains any validation violation for specified path.

Parameters:

path - violations path

Returns:

true if at least one violation is related to provided path or any of its children

addValidationInfo

public void addValidationInfo(String path,
                              Collection<ValidationInfo> validationInfos)

Adds new validation violations to current container. All violation are considered to be relative containers root and specified path.

Parameters:

path - relative path for added violations

validationInfos - validation violations to be added

addValidationInfo

public void addValidationInfo(ValidationInfo info)

Adds new validation violation to current container. violation is considered to be relative containers root.

Parameters:

info - validation violation to be added

removeImmediately

protected void removeImmediately(String path)

clear

public void clear()

Removes all validation violations registered in current container.

setValidationInfo

public void setValidationInfo(Collection<ValidationInfo> validationInfos)

Replaces all validation violations registered in current container with provided.

Parameters:

validationInfos - new violations for container

See Also:

updateValidationInfo(Collection)

setValidationInfo

public void setValidationInfo(String path,
                              Collection<ValidationInfo> validationInfos)

Replaces violations related to provided path with their new instances. All new violation are considered to be relative to provided root path and prefix is added to them.

As first all violation related to provided path are removed. Then new violations are wrapped with prefix and added to container.

Parameters:

path - root path for added violations

validationInfos - validation violations to be added

See Also:

updateValidationInfo(String, Collection)

updateValidationInfo

public void updateValidationInfo(Collection<ValidationInfo> validationInfos)

Replaces violations with their new instances.

As first all violations related to same paths that new ones are removed. Then new violations are added to container.

Notice that only violations related to paths from provided violations are changed, though method does nothing, if provided list is empty.

Parameters:

validationInfos - new violations

See Also:

removeValidationInfo(String), setValidationInfo(Collection)

updateValidationInfo

public void updateValidationInfo(String path,
                                 Collection<ValidationInfo> validationInfos)

Replaces violations with their new instances.

As first all violation related to provided path are removed. Then new violations are added to container. New violations should be related to provided path and define their violation path as a subpath of it.

Parameters:

path - root path which violations are being changed

validationInfos - new violations

Throws:

IllegalArgumentException - if any of provided violation defines a path that is not relative to path

See Also:

removeValidationInfo(String), setValidationInfo(String, Collection)

removeValidationInfo

public void removeValidationInfo(String path)

Removes all validation violations from specified path and its subpaths from current container with provided.

Parameters:

path - relative path for which to remove violations

removeValidationInfo

public void removeValidationInfo(ValidationInfo info)

Removes validation violation from current container

Parameters:

info - violation to be removed

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object