org.ametys.cms.content.referencetable

Class HierarchicalReferenceTablesHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.content.referencetable.HierarchicalReferenceTablesHelper

All Implemented Interfaces:

LogEnabled, Disposable, Component, Serviceable

public class HierarchicalReferenceTablesHelper
extends AbstractLogEnabled
implements Component, Serviceable, Disposable

Helper component for computing information about hierarchy of reference table Contents.

At the startup of the Ametys application, you must call registerRelation(ContentType, ContentType) in order to register a relation between a parent content type and its child content type.
When all relations are registered, one or several hierarchy(ies) can be inferred, following some basic rules:

• A hierarchy of two or more content types cannot be cyclic
• A content type can have itself as its parent content type
• A content type cannot have two different parent content types
• A content type can have only one content type as children, plus possibly itself

From each hierarchy of content types, a tree of contents can be inferred.

For instance, the following examples of hierarchy are valid (where X←Y means 'X is the parent content type of Y';
and ⤹Z means 'Z is the parent content type of Z'):

• B←A
• E←D←C←B←A
• ⤹B←A (content type B defines two different child content types, but one is itself, which is allowed)
• ⤹E←D←C←B←A
• ⤹A

; and the following examples of hierarchy are invalid:

• C←B and C←A (a content type cannot have multiple content types as children, which are not itself)
• C←A and B←A (a content type cannot have two different parent content types)
• ⤹A and B←A (a content type cannot have two different parent content types, even if one is itself)
• A←B and B←A (cyclic hierarchy)
• A←C←B←A (cyclic hierarchy)

Field Summary

Fields

Modifier and Type	Field and Description
private Set<ContentType>	_autoReferencingContentTypes The content types pointing at themselves
private BiMap<ContentType,ContentType>	_childByContentType The map parent -> child (excepted content types pointing on themselves)
protected ContentTypeExtensionPoint	_contentTypeEP The extension point for content types
protected AmetysObjectResolver	_resolver The Ametys objet resolver
private BiMap<ContentType,ContentType>	_topLevelTypeByLeafType The map leafContentType -> topLevelContentType
static String	ROLE The Avalon role

Constructor Summary

Constructors

Constructor and Description
HierarchicalReferenceTablesHelper()

Method Summary

Modifier and Type	Method and Description
private boolean	_checkNoCycle(ContentType parent, ContentType child)
private void	_setMetadata(MetadataDefinition metadataDefinition, ModifiableContent content, Content value)
void	dispose()
List<String>	getAllParents(Content content) Recursively returns the "parent" metadata value for the given content, i.e; will return the parent, the parent of the parent, etc.
List<ContentType>	getChildContentTypes(Content refTableEntry) Gets the content types the children of the given content can have.
Set<String>	getHierarchicalContentTypes(String leafContentTypeId) Get the hierarchy of content types (distinct content types)
String	getParent(Content content) Returns the "parent" metadata value for the given content, or null if it is not defined for its content types See also ContentType.getParentMetadata()
String	getPathInHierarchy(String refTableEntryId) Get the path of reference table entry in its hierarchy
ContentType	getTopLevelType(ContentType leafContentType) Gets the top level content type for the given leaf content type (which defines the hierarchy)
boolean	hasAtLeastOneHierarchy() Returns true if at least one hierarchy was registered (i.e.
boolean	hasChildContentType(ContentType contentType) Returns true if the given content type has a child content type
boolean	isHierarchical(ContentType contentType) Returs true if the given content type is hierarchical, i.e.
boolean	isLeaf(ContentType contentType) Returns true if the given content type is a leaf content type
boolean	registerRelation(ContentType parent, ContentType child) Register a relation between a parent and its child, and update the internal model if it is a valid one.
void	service(ServiceManager manager)
void	setParentMetadata(ModifiableContent content, Content parent) Sets the "parent" metadata of the given content See also ContentType.getParentMetadata()

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The Avalon role

_contentTypeEP

protected ContentTypeExtensionPoint _contentTypeEP

The extension point for content types

_resolver

protected AmetysObjectResolver _resolver

The Ametys objet resolver

_childByContentType

private BiMap<ContentType,ContentType> _childByContentType

The map parent -> child (excepted content types pointing on themselves)

_autoReferencingContentTypes

private Set<ContentType> _autoReferencingContentTypes

The content types pointing at themselves

_topLevelTypeByLeafType

private BiMap<ContentType,ContentType> _topLevelTypeByLeafType

The map leafContentType -> topLevelContentType

Constructor Detail

HierarchicalReferenceTablesHelper

public HierarchicalReferenceTablesHelper()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

dispose

public void dispose()

Specified by:

dispose in interface Disposable

registerRelation

public boolean registerRelation(ContentType parent,
                                ContentType child)

Register a relation between a parent and its child, and update the internal model if it is a valid one.

Parameters:

parent - The parent content type

child - The child content type

Returns:

true if the relation is valid, i.e. in accordance with what was registered before

hasAtLeastOneHierarchy

public boolean hasAtLeastOneHierarchy()

Returns true if at least one hierarchy was registered (i.e. at least one content type defines a valid "parent" metadata)

Returns:

true if at least one hierarchy was registered

getTopLevelType

public ContentType getTopLevelType(ContentType leafContentType)

Gets the top level content type for the given leaf content type (which defines the hierarchy)

Parameters:

leafContentType - the leaf cotnent type

Returns:

the top level content type for the given leaf content type

_checkNoCycle

private boolean _checkNoCycle(ContentType parent,
                              ContentType child)

hasChildContentType

public boolean hasChildContentType(ContentType contentType)

Returns true if the given content type has a child content type

Parameters:

contentType - The content type

Returns:

true if the given content type has a child content type

isHierarchical

public boolean isHierarchical(ContentType contentType)

Returs true if the given content type is hierarchical, i.e. is part of a hierarchy

Parameters:

contentType - The content type

Returns:

true if the given content type is hierarchical, i.e. is part of a hierarchy

isLeaf

public boolean isLeaf(ContentType contentType)

Returns true if the given content type is a leaf content type

Parameters:

contentType - The content type

Returns:

true if the given content type is a leaf content type

getHierarchicalContentTypes

public Set<String> getHierarchicalContentTypes(String leafContentTypeId)

Get the hierarchy of content types (distinct content types)

Parameters:

leafContentTypeId - The id of leaf content type

Returns:

The content types of hierarchy

getPathInHierarchy

public String getPathInHierarchy(String refTableEntryId)

Get the path of reference table entry in its hierarchy

Parameters:

refTableEntryId - The id of entry

Returns:

The path from root parent

getChildContentTypes

public List<ContentType> getChildContentTypes(Content refTableEntry)

Gets the content types the children of the given content can have. The result can contain 0, 1 or 2 content types

Parameters:

refTableEntry - The content

Returns:

the content types the children of the given content can have.

setParentMetadata

public void setParentMetadata(ModifiableContent content,
                              Content parent)

Sets the "parent" metadata of the given content See also ContentType.getParentMetadata()

Parameters:

content - The content

parent - The value of the "parent" metadata

_setMetadata

private void _setMetadata(MetadataDefinition metadataDefinition,
                          ModifiableContent content,
                          Content value)

getParent

public String getParent(Content content)

Returns the "parent" metadata value for the given content, or null if it is not defined for its content types See also ContentType.getParentMetadata()

Parameters:

content - The content

Returns:

the "parent" metadata value for the given content, or null

getAllParents

public List<String> getAllParents(Content content)

Recursively returns the "parent" metadata value for the given content, i.e; will return the parent, the parent of the parent, etc.

Parameters:

content - The content

Returns:

all the parents of the given content