OutgoingReferencesExtractor (Ametys 4.5.x - API)

java.lang.Object
- org.ametys.cms.content.references.OutgoingReferencesExtractor

All Implemented Interfaces:

Component
```
public class OutgoingReferencesExtractor
extends Object
implements 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 Description

static String ROLE
Avalon role

Constructor Summary

Constructors
Constructor Description

OutgoingReferencesExtractor()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected Map<String,OutgoingReferences>`	`_getOutgoingReferences(ModelAwareDataHolder dataHolder, String dataPathPrefix)`	Analyze a data holder to extract the outgoing references
`Map<String,OutgoingReferences>`	`getOutgoingReferences(Content content)`	This method analyzes the content to return the list of outgoing references grouped by data path.

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
- Constructor Detail
  - OutgoingReferencesExtractor
```
public OutgoingReferencesExtractor()
```
- Method Detail
  - getOutgoingReferences
```
public Map<String,OutgoingReferences> getOutgoingReferences(Content content)
```
    This method analyzes the content to return the list of outgoing references grouped by data path.
    
    Parameters:
    
    content - The content to analyze
    
    Returns:
    
    A Map where keys are data path and values are outgoing references for this data. Can not be null.
  - _getOutgoingReferences
```
protected Map<String,OutgoingReferences> _getOutgoingReferences(ModelAwareDataHolder dataHolder,
                                                                      String dataPathPrefix)
```
    Analyze a data holder to extract the outgoing references
    
    Parameters:
    
    dataHolder - the data holder to analyze
    
    dataPathPrefix - the data path of the current data holder
    
    Returns:
    
    the outgoing references, indexed by data path