Package org.ametys.odf.validator

Class ProgramItemHierarchyValidator

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.cms.contenttype.validation.AbstractContentValidator

org.ametys.odf.validator.ProgramItemHierarchyValidator

All Implemented Interfaces:

ContentValidator, Configurable, LogEnabled, Serviceable

public class ProgramItemHierarchyValidator
extends AbstractContentValidator
implements Serviceable, Configurable

Global validator for ProgramItem content. Check that structure to not create an infinite loop

Field Summary

Fields

Modifier and Type	Field	Description
protected ODFHelper	_odfHelper	The ODF helper

Constructor Summary

Constructors

Constructor	Description
ProgramItemHierarchyValidator()

Method Summary

Modifier and Type	Method	Description
protected I18nizableText	_getError(ElementDefinition childDefinition, Content content, Content childContent, String catalog, String i18nKey)	Retrieves an error message
protected boolean	checkAncestors(ProgramItem childProgramItem, List<? extends ProgramItem> parentProgramItems)	Check if the hierarchy of a program item will be still valid if adding the given program item as child.
protected boolean	checkAncestors(ProgramItem programItem, ProgramItem childProgramItem)	Check if the hierarchy of a program item will be still valid if adding the given program item as child.
void	configure(Configuration configuration)
protected Set<String>	getChildAttributeNames()	Get the names of child attribute to be checked
protected Set<String>	getParentAttributeNames()	Get the names of parent attribute to be checked
void	service(ServiceManager smanager)
ValidationResult	validate(Content content)	Validates a content.
ValidationResult	validate(Content content, Map<String,Object> values, View view)	Validates a content being edited

Methods inherited from class org.ametys.cms.contenttype.validation.AbstractContentValidator

getContentType, initialize, setContentType

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Details

_odfHelper

protected ODFHelper _odfHelper

The ODF helper

Constructor Details

ProgramItemHierarchyValidator

public ProgramItemHierarchyValidator()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

validate

public ValidationResult validate(Content content)

Description copied from interface: ContentValidator

Validates a content.

Specified by:

validate in interface ContentValidator

Parameters:

content - the content to validate

Returns:

the validation result

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

validate

public ValidationResult validate(Content content,
 Map<String,Object> values,
 View view)

Description copied from interface: ContentValidator

Validates a content being edited

Specified by:

validate in interface ContentValidator

Parameters:

content - the content to validate

values - the values being set

view - the view

Returns:

the validation result

getChildAttributeNames

protected Set<String> getChildAttributeNames()

Get the names of child attribute to be checked

Returns:

the child attribute's names

getParentAttributeNames

protected Set<String> getParentAttributeNames()

Get the names of parent attribute to be checked

Returns:

the parent attribute's names

checkAncestors

protected boolean checkAncestors(ProgramItem programItem,
 ProgramItem childProgramItem)

Check if the hierarchy of a program item will be still valid if adding the given program item as child. Return false if the ProgramItem to add is in the hierarchy of the given ProgramItem

Parameters:

programItem - The content to start search

childProgramItem - The child program item to search in ancestors

Returns:

true if child program item is already part of the hierarchy (ascendant search)

checkAncestors

protected boolean checkAncestors(ProgramItem childProgramItem,
 List<? extends ProgramItem> parentProgramItems)

Check if the hierarchy of a program item will be still valid if adding the given program item as child. Return false if the ProgramItem to add is in the hierarchy of the given ProgramItem

Parameters:

childProgramItem - The child program item to add

parentProgramItems - The parent program items of the target

Returns:

true if child program item is already part of the hierarchy (ascendant search)

_getError

protected I18nizableText _getError(ElementDefinition childDefinition,
 Content content,
 Content childContent,
 String catalog,
 String i18nKey)

Retrieves an error message

Parameters:

childDefinition - The child attribute definition

content - The content being edited

childContent - The content to add as child content

catalog - the i18n catalog

i18nKey - the i18n key for the error message

Returns:

the error message