org.ametys.cms.content.references

Class OutgoingReferencesExtractor

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.cms.content.references.OutgoingReferencesExtractor

All Implemented Interfaces:

Component, LogEnabled, Serviceable

public class OutgoingReferencesExtractor
extends AbstractLogEnabled
implements Serviceable, Component

The outgoing references extractor is a class that analyzes a content to extract the list of outgoing references in the metadata. Theses references should be stored on the content to allow research or post-processing later (example: consistency analyzer).

Field Summary

Fields

Modifier and Type	Field and Description
private static String	__OUTGOING_REFERENCE_TYPE_EXPLORER Constants for the explorer type for outgoing references
protected ContentTypesHelper	_contentTypesHelper Helper for content types
static String	ROLE Avalon role

Constructor Summary

Constructors

Constructor and Description
OutgoingReferencesExtractor()

Method Summary

Modifier and Type	Method and Description
protected Map<String,OutgoingReferences>	_analyzeCompositeMetadata(Content content, MetadataDefinition parentMetadataDefinition, CompositeMetadata metadataHolder, String metadataPathPrefix) Analyze a composite metadata to extract the outgoing references
protected OutgoingReferences	_analyzeMetadata(MetadataDefinition metadataDefinition, RichText metadata) Analyze a rich text metadata.
protected OutgoingReferences	_analyzeReferenceMetadata(MetadataDefinition metadataDefinition, CompositeMetadata metadata) Analyze a reference metadata.
protected OutgoingReferences	_analyzeResourceFileMetadata(MetadataDefinition metadataDefinition, String metadata) Analyze a string file metadata.
protected MetadataDefinition	_getMetadataDefinition(Content content, MetadataDefinition parentMetadataDefinition, String metadataName) Retrieves a sub metadata definition from a content type or a parent metadata definition.
Map<String,OutgoingReferences>	getOutgoingReferences(Content content) This method analyzes the content to return the list of outgoing references grouped by metadata path.
void	service(ServiceManager serviceManager)

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

ROLE

public static final String ROLE

Avalon role

__OUTGOING_REFERENCE_TYPE_EXPLORER

private static final String __OUTGOING_REFERENCE_TYPE_EXPLORER

Constants for the explorer type for outgoing references

See Also:

Constant Field Values

_contentTypesHelper

protected ContentTypesHelper _contentTypesHelper

Helper for content types

Constructor Detail

OutgoingReferencesExtractor

public OutgoingReferencesExtractor()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getOutgoingReferences

public Map<String,OutgoingReferences> getOutgoingReferences(Content content)

This method analyzes the content to return the list of outgoing references grouped by metadata path.

Parameters:

content - The content to analyze

Returns:

A map where keys are metadata path and values are outgoing references for this metadata. Can not be null.

_analyzeCompositeMetadata

protected Map<String,OutgoingReferences> _analyzeCompositeMetadata(Content content,
                                                                   MetadataDefinition parentMetadataDefinition,
                                                                   CompositeMetadata metadataHolder,
                                                                   String metadataPathPrefix)

Analyze a composite metadata to extract the outgoing references

Parameters:

content - The current content

parentMetadataDefinition - The parent metadata definition (can be null, at the root level)

metadataHolder - The composite metadata to analyze. Cannot be null

metadataPathPrefix - The path of the current metadata holder

Returns:

The outgoing references, indexed by metadata path.

_analyzeMetadata

protected OutgoingReferences _analyzeMetadata(MetadataDefinition metadataDefinition,
                                              RichText metadata)

Analyze a rich text metadata. Delegates processing to the rich text outgoing references extractor of the metadata definition

Parameters:

metadataDefinition - The metadata definition corresponding to the current metadata

metadata - The metadata to analyze. Cannot be null

Returns:

The corresponding outgoing references.

_analyzeResourceFileMetadata

protected OutgoingReferences _analyzeResourceFileMetadata(MetadataDefinition metadataDefinition,
                                                          String metadata)

Analyze a string file metadata.

Parameters:

metadataDefinition - The metadata definition corresponding to the current metadata

metadata - The metadata to analyze. Cannot be null

Returns:

The corresponding outgoing references.

_analyzeReferenceMetadata

protected OutgoingReferences _analyzeReferenceMetadata(MetadataDefinition metadataDefinition,
                                                       CompositeMetadata metadata)

Analyze a reference metadata.

Parameters:

metadataDefinition - The metadata definition corresponding to the current metadata

metadata - The reference metadata

Returns:

The corresponding outgoing references.

_getMetadataDefinition

protected MetadataDefinition _getMetadataDefinition(Content content,
                                                    MetadataDefinition parentMetadataDefinition,
                                                    String metadataName)

Retrieves a sub metadata definition from a content type or a parent metadata definition.

Parameters:

content - the content.

parentMetadataDefinition - the parent metadata definition.

metadataName - the metadata name.

Returns:

the metadata definition found or null otherwise.