org.jahia.services.importexport.validation

Class MissingTemplatesValidationResult

java.lang.Object

org.jahia.services.importexport.validation.MissingTemplatesValidationResult

All Implemented Interfaces:

Serializable, ValidationResult

public class MissingTemplatesValidationResult
extends Object
implements ValidationResult, Serializable

Represents a validation result, containing missing templates in the content to be imported.

Since:

Jahia 6.6

Author:

Sergiy Shyrkov

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.jahia.services.importexport.validation.ValidationResult

ValidationResult.FailedValidationResult

Constructor Summary

Constructors

Modifier	Constructor and Description
	MissingTemplatesValidationResult(Map<String,Set<String>> missing, String targetTemplateSet, boolean targetTemplateSetPresent, Map<String,Integer> modulesMissingCounts) Initializes an instance of this class.
protected	MissingTemplatesValidationResult(MissingTemplatesValidationResult result1, MissingTemplatesValidationResult result2) Initializes an instance of this class, merging the two validation results into one.

Method Summary

Modifier and Type	Method and Description
Map<String,Set<String>>	getMissingTemplates() Returns a Map with missing templates as keys and as value a list of element paths having that template in the import.
String	getTargetTemplateSet() Returns the name of the template set, specified in the imprt file.
Map<String,Integer>	getTemplateSetsMissingCounts() If the target template set is not present on the system we verify templates against all available template sets and check how many are missing in each of them.
boolean	isBlocking() Returns true if the current validation blocks the import.
boolean	isSuccessful() Returns true if the current validation result is successful, meaning no missing templates were detected.
boolean	isTargetTemplateSetPresent()
ValidationResult	merge(ValidationResult toBeMergedWith) Performs a merge of current validation results with provided one.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MissingTemplatesValidationResult

public MissingTemplatesValidationResult(Map<String,Set<String>> missing,
                                        String targetTemplateSet,
                                        boolean targetTemplateSetPresent,
                                        Map<String,Integer> modulesMissingCounts)

Initializes an instance of this class.

Parameters:

missing - missing templates information

targetTemplateSet - the template set from the import file

targetTemplateSetPresent - is template set from import file present on the system?

modulesMissingCounts - if the target template set is not present on the system we verify templates against all available template sets and check how many are missing in each of them

MissingTemplatesValidationResult

protected MissingTemplatesValidationResult(MissingTemplatesValidationResult result1,
                                           MissingTemplatesValidationResult result2)

Initializes an instance of this class, merging the two validation results into one.

Parameters:

result1 - the first validation result instance to be merged

result2 - the second validation result instance to be merged

Method Detail

getMissingTemplates

public Map<String,Set<String>> getMissingTemplates()

Returns a Map with missing templates as keys and as value a list of element paths having that template in the import.

Returns:

a Map with missing templates as keys and as value a list of element paths having that template in the import

getTargetTemplateSet

public String getTargetTemplateSet()

Returns the name of the template set, specified in the imprt file.

Returns:

the name of the template set, specified in the imprt file

getTemplateSetsMissingCounts

public Map<String,Integer> getTemplateSetsMissingCounts()

If the target template set is not present on the system we verify templates against all available template sets and check how many are missing in each of them. This method returns in this case a map, with template set names as keys and missing count as values. If the target template set if found, the check against all other template sets is not done and this method returns an empty map.

Returns:

a map, with template set names as keys and missing count as values

isSuccessful

public boolean isSuccessful()

Returns true if the current validation result is successful, meaning no missing templates were detected.

Specified by:

isSuccessful in interface ValidationResult

Returns:

true if the current validation result is successful, meaning no missing templates were detected

isTargetTemplateSetPresent

public boolean isTargetTemplateSetPresent()

merge

public ValidationResult merge(ValidationResult toBeMergedWith)

Performs a merge of current validation results with provided one.

Specified by:

merge in interface ValidationResult

Parameters:

toBeMergedWith - a ValidationResult to merge with

Returns:

returns a merged view of both results

isBlocking

public boolean isBlocking()

Description copied from interface: ValidationResult

Returns true if the current validation blocks the import.

Specified by:

isBlocking in interface ValidationResult

Returns:

true if the current validation result is blocking.

toString

public String toString()

Overrides:

toString in class Object