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 and Description
private Set<String>	_childMetadataNames
protected ODFHelper	_odfHelper The ODF helper

Constructor Summary

Constructors

Constructor and Description
ProgramItemHierarchyValidator()

Method Summary

Modifier and Type	Method and Description
protected void	addHierarchyError(Errors errors, MetadataDefinition childDefinition, Content content, Content childContent) Add an error the ascendant hierarchy is invalid (infinite loop)
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>	getChildMetadataNames() Get the names of child metadata to be checked
void	service(ServiceManager smanager)
void	validate(Content content, Errors errors) Validates a content.
void	validate(Content content, Form form, MetadataSet metadataSet, Errors errors) Validates a content with the edited form.

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

getContentType, 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 Detail

_odfHelper

protected ODFHelper _odfHelper

The ODF helper

_childMetadataNames

private Set<String> _childMetadataNames

Constructor Detail

ProgramItemHierarchyValidator

public ProgramItemHierarchyValidator()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

validate

public void validate(Content content,
                     Errors errors)

Description copied from interface: ContentValidator

Validates a content.

Specified by:

validate in interface ContentValidator

Parameters:

content - the content to validate

errors - the structure to populate if the validation failed.

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

validate

public void validate(Content content,
                     Form form,
                     MetadataSet metadataSet,
                     Errors errors)

Description copied from interface: ContentValidator

Validates a content with the edited form.

Specified by:

validate in interface ContentValidator

Parameters:

content - the content to validate

form - the form to validate

metadataSet - the edited metadata set

errors - the structure to populate if the validation failed.

getChildMetadataNames

protected Set<String> getChildMetadataNames()

Get the names of child metadata to be checked

Returns:

the child metadata'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)

addHierarchyError

protected void addHierarchyError(Errors errors,
                                 MetadataDefinition childDefinition,
                                 Content content,
                                 Content childContent)

Add an error the ascendant hierarchy is invalid (infinite loop)

Parameters:

errors - The list of errors

childDefinition - The child metadata definition

content - The content being edited

childContent - The content to add as child content