MetadataDefinition (Ametys 4.1.x

java.lang.Object
- org.ametys.runtime.parameter.Parameter<MetadataType>
- - org.ametys.cms.contenttype.MetadataDefinition

All Implemented Interfaces:

MetadataDefinitionHolder

Direct Known Subclasses:

DefaultContentType.RestrictedMetadataDefinition, RepeaterDefinition, RichTextMetadataDefinition
```
public class MetadataDefinition
extends Parameter<MetadataType>
implements MetadataDefinitionHolder
```
Metadata definition. The Parameter.getId() method returns the metadata path, separated by slashes.

Field Summary

Fields
Modifier and Type	Field and Description
`private Map<String,MetadataDefinition>`	`_children`
`private String`	`_contentType`
`private boolean`	`_forceInvert`
`private String`	`_invertRelationPath`
`private boolean`	`_isMultiple`
`private String`	`_name`
`private String`	`_refContentTypeId`
`private RichTextOutgoingReferencesExtractor`	`_richTextOutgoingReferencesExtractor`
`private RichTextTransformer`	`_transformer`

Constructor Summary

Constructors
Constructor and Description

MetadataDefinition()

Constructors
Constructor and Description
`MetadataDefinition()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`addMetadata(MetadataDefinition metadataDef)` Add a metadata definition.
`boolean`	`equals(Object obj)`
`String`	`getContentType()` Get the metadata's content type (only applicable for a content-typed metadata).
`boolean`	`getForceInvert()` Returns true if mutual relationship should be set regardless of user's rights
`String`	`getInvertRelationPath()` Get the metadata's mutual relationship path (only applicable for a content-typed metadata).
`Set<String>`	`getMetadataComponentsName()` Deprecated. Use getMetadataNames instead
`MetadataDefinition`	`getMetadataDefinition(String metadataName)` Retrieves the definition of a given metadata.
`Set<String>`	`getMetadataNames()` Retrieves the metadata names.
`String`	`getName()` Retrieves the metadata name.
`String`	`getReferenceContentType()` Get the content type of reference (ie.
`RichTextOutgoingReferencesExtractor`	`getRichTextOutgoingReferencesExtractor()` Retrieves the rich text outgoing references extractor to use.
`RichTextTransformer`	`getRichTextTransformer()` Retrieves the rich text transformer to use.
`int`	`hashCode()`
`boolean`	`isMultiple()` Test if the metadata is multiple.
`void`	`setContentType(String contentType)` Set the content type (only applicable for a content-typed metadata).
`void`	`setForceInvert(boolean force)` Force mutual relationship regardless of user's rights (only applicable for a content-typed metadata with invert relation path).
`void`	`setInvertRelationPath(String invertRelationPath)` Set the metadata's mutual relationship path (only applicable for a content-typed metadata).
`void`	`setMultiple(boolean isMultiple)` Set the metadata multiple status.
`void`	`setName(String name)` Set the metadata name.
`void`	`setReferenceContentType(String cTypeId)` Set the id of reference content type (ie.
`void`	`setRichTextOutgoingReferencesExtractor(RichTextOutgoingReferencesExtractor richTextOutgoingReferencesExtractor)` Set the rich text outgoing references extractor to use.
`void`	`setRichTextTransformer(RichTextTransformer transformer)` Set the rich text transformer to use.
`String`	`toString()`

Methods inherited from class org.ametys.runtime.parameter.Parameter
getDefaultValue, getDescription, getEnumerator, getId, getLabel, getPluginName, getType, getValidator, getWidget, getWidgetParameters, setDefaultValue, setDescription, setEnumerator, setId, setLabel, setPluginName, setType, setValidator, setWidget, setWidgetParameters

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - _name
```
private String _name
```
  - _isMultiple
```
private boolean _isMultiple
```
  - _contentType
```
private String _contentType
```
  - _invertRelationPath
```
private String _invertRelationPath
```
  - _forceInvert
```
private boolean _forceInvert
```
  - _transformer
```
private RichTextTransformer _transformer
```
  - _richTextOutgoingReferencesExtractor
```
private RichTextOutgoingReferencesExtractor _richTextOutgoingReferencesExtractor
```
  - _children
```
private final Map<String,MetadataDefinition> _children
```
  - _refContentTypeId
```
private String _refContentTypeId
```
- Constructor Detail
  - MetadataDefinition
```
public MetadataDefinition()
```
- Method Detail
  - getName
```
public String getName()
```
    Retrieves the metadata name.
    
    Returns:
    
    the metadata name.
  - setName
```
public void setName(String name)
```
    Set the metadata name.
    
    Parameters:
    
    name - the metadata name.
  - isMultiple
```
public boolean isMultiple()
```
    Test if the metadata is multiple.
    
    Returns:
    
    true if the metadata is multiple.
  - setMultiple
```
public void setMultiple(boolean isMultiple)
```
    Set the metadata multiple status.
    
    Parameters:
    
    isMultiple - the metadata multiple status.
  - getReferenceContentType
```
public String getReferenceContentType()
```
    Get the content type of reference (ie. the content type which has declared the metadata definition)
    
    Returns:
    
    The id of reference content type
  - setReferenceContentType
```
public void setReferenceContentType(String cTypeId)
```
    Set the id of reference content type (ie. the content type which has declared the metadata definition)
    
    Parameters:
    
    cTypeId - The id of reference content type
  - getContentType
```
public String getContentType()
```
    Get the metadata's content type (only applicable for a content-typed metadata).
    
    Returns:
    
    the metadata's content type, null if no restriction.
  - setContentType
```
public void setContentType(String contentType)
```
    Set the content type (only applicable for a content-typed metadata).
    
    Parameters:
    
    contentType - the metadata's content type.
  - getInvertRelationPath
```
public String getInvertRelationPath()
```
    Get the metadata's mutual relationship path (only applicable for a content-typed metadata).
    
    Returns:
    
    the metadata's mutual relationship path, null if not applicable.
  - setInvertRelationPath
```
public void setInvertRelationPath(String invertRelationPath)
```
    Set the metadata's mutual relationship path (only applicable for a content-typed metadata).
    
    Parameters:
    
    invertRelationPath - the metadata's mutual relationship path, separated by slashes.
  - setForceInvert
```
public void setForceInvert(boolean force)
```
    Force mutual relationship regardless of user's rights (only applicable for a content-typed metadata with invert relation path).
    
    Parameters:
    
    force - true to force mutual relationship regardless of user's rights
  - getForceInvert
```
public boolean getForceInvert()
```
    Returns true if mutual relationship should be set regardless of user's rights
    
    Returns:
    
    true if mutual relationship should be set regardless of user's rights
  - getRichTextTransformer
```
public RichTextTransformer getRichTextTransformer()
```
    Retrieves the rich text transformer to use.
    
    Returns:
    
    the rich text transformer.
  - setRichTextTransformer
```
public void setRichTextTransformer(RichTextTransformer transformer)
```
    Set the rich text transformer to use.
    
    Parameters:
    
    transformer - the rich text transformer.
  - getRichTextOutgoingReferencesExtractor
```
public RichTextOutgoingReferencesExtractor getRichTextOutgoingReferencesExtractor()
```
    Retrieves the rich text outgoing references extractor to use.
    
    Returns:
    
    the rich text outgoing references extractor.
  - setRichTextOutgoingReferencesExtractor
```
public void setRichTextOutgoingReferencesExtractor(RichTextOutgoingReferencesExtractor richTextOutgoingReferencesExtractor)
```
    Set the rich text outgoing references extractor to use.
    
    Parameters:
    
    richTextOutgoingReferencesExtractor - The rich text outgoing references extractor
  - getMetadataComponentsName
```
@Deprecated
public Set<String> getMetadataComponentsName()
```
    Deprecated. Use getMetadataNames instead
    
    Retrieves the metadata names below this composite metadata.
    
    Returns:
    
    the metadata names.
  - getMetadataNames
```
public Set<String> getMetadataNames()
```
    Description copied from interface: MetadataDefinitionHolder
    
    Retrieves the metadata names.
    
    Specified by:
    
    getMetadataNames in interface MetadataDefinitionHolder
    
    Returns:
    
    the metadata names.
  - getMetadataDefinition
```
public MetadataDefinition getMetadataDefinition(String metadataName)
```
    Description copied from interface: MetadataDefinitionHolder
    
    Retrieves the definition of a given metadata.
    
    Specified by:
    
    getMetadataDefinition in interface MetadataDefinitionHolder
    
    Parameters:
    
    metadataName - the metadata name.
    
    Returns:
    
    the metadata definition.
  - addMetadata
```
public boolean addMetadata(MetadataDefinition metadataDef)
```
    Add a metadata definition.
    
    Parameters:
    
    metadataDef - the metadata definition.
    
    Returns:
    
    true if the metadata has been added, false if this metadata already exists.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class MetadataDefinition

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.ametys.runtime.parameter.Parameter

Methods inherited from class java.lang.Object

Field Detail

_name

_isMultiple

_contentType

_invertRelationPath

_forceInvert

_transformer

_richTextOutgoingReferencesExtractor

_children

_refContentTypeId

Constructor Detail

MetadataDefinition

Method Detail

getName

setName

isMultiple

setMultiple

getReferenceContentType

setReferenceContentType

getContentType

setContentType

getInvertRelationPath

setInvertRelationPath

setForceInvert

getForceInvert

getRichTextTransformer

setRichTextTransformer

getRichTextOutgoingReferencesExtractor

setRichTextOutgoingReferencesExtractor

getMetadataComponentsName

getMetadataNames

getMetadataDefinition

addMetadata

toString

equals

hashCode