net.nemerosa.ontrack.model.structure

Interface PropertyType<T>

Type Parameters:

T - Type of object supported by this type

All Superinterfaces:

Extension

All Known Subinterfaces:

ConfigurationPropertyType<C,T>, PromotionLevelPropertyType<T>, ValidationStampPropertyType<T>

public interface PropertyType<T>
extends Extension

Defines the type for a property.

Method Summary

Modifier and Type	Method and Description
boolean	canEdit(ProjectEntity entity, SecurityService securityService) Edition policy.
boolean	canView(ProjectEntity entity, SecurityService securityService) Defines the authorization policy for viewing this property.
default boolean	containsValue(T value, java.lang.String propertyValue) Checks if the property value contains the given search token.
default T	copy(ProjectEntity sourceEntity, T value, ProjectEntity targetEntity, java.util.function.Function<java.lang.String,java.lang.String> replacementFn) Copy/clones the value defined for the sourceEntity for being suitable in the targetEntity after applying the replacement function.
com.fasterxml.jackson.databind.JsonNode	forStorage(T value) Gets the JSON representation of a property value
T	fromClient(com.fasterxml.jackson.databind.JsonNode node) Parses the client JSON representation for a property value.
T	fromStorage(com.fasterxml.jackson.databind.JsonNode node) Parses the storage JSON representation for a property value.
java.lang.String	getDescription() Description for this property
Form	getEditionForm(ProjectEntity entity, T value) Form to create/update this property.
java.lang.String	getName() Display name for this property
java.lang.String	getSearchKey(T value) Given the value of a property, computes some text that can be used as a hint to search among all the properties when looking for a key word.
java.util.Set<ProjectEntityType>	getSupportedEntityTypes() List of entity types this property applies to.
default java.lang.String	getTypeName() Type name for this property type.
default Property<T>	of(com.fasterxml.jackson.databind.JsonNode node) Parses the JSON representation for a property value and creates the property value directly.
Property<T>	of(T value) Creation of a property value from a value.
default void	onPropertyChanged(ProjectEntity entity, T value) This method is called when the property value changes (created or updated) for an entity
default void	onPropertyDeleted(ProjectEntity entity, T oldValue) This method is called when the property is deleted for an entity
T	replaceValue(T value, java.util.function.Function<java.lang.String,java.lang.String> replacementFunction) Replaces a value by another one by transforming each string of the value into another one.

Methods inherited from interface net.nemerosa.ontrack.model.extension.Extension

getFeature

Method Detail

getName

java.lang.String getName()

Display name for this property

getDescription

java.lang.String getDescription()

Description for this property

getSupportedEntityTypes

java.util.Set<ProjectEntityType> getSupportedEntityTypes()

List of entity types this property applies to.

canEdit

boolean canEdit(ProjectEntity entity,
                SecurityService securityService)

Edition policy.

Can this property be directly edited by a used on the given associated entity.

Parameters:

entity - Entity where to edit the property

securityService - The access to the security layer

Returns:

Authorization policy for this entity

canView

boolean canView(ProjectEntity entity,
                SecurityService securityService)

Defines the authorization policy for viewing this property.

Parameters:

entity - Entity where to view the property

securityService - The access to the security layer

Returns:

Authorization policy for this entity

getEditionForm

Form getEditionForm(ProjectEntity entity,
                    T value)

Form to create/update this property.

Parameters:

entity - Entity to edit the property for

value - Value to update if set. If not set, this means the creation of a new property.

of

Property<T> of(T value)

Creation of a property value from a value. Should perform validation.

forStorage

com.fasterxml.jackson.databind.JsonNode forStorage(T value)

Gets the JSON representation of a property value

fromClient

T fromClient(com.fasterxml.jackson.databind.JsonNode node)

Parses the client JSON representation for a property value. This method MUST perform validation before accepting the value.

See Also:

getEditionForm(ProjectEntity, Object)

fromStorage

T fromStorage(com.fasterxml.jackson.databind.JsonNode node)

Parses the storage JSON representation for a property value.

of

default Property<T> of(com.fasterxml.jackson.databind.JsonNode node)

Parses the JSON representation for a property value and creates the property value directly.

See Also:

fromStorage(com.fasterxml.jackson.databind.JsonNode), of(Object)

getSearchKey

java.lang.String getSearchKey(T value)

Given the value of a property, computes some text that can be used as a hint to search among all the properties when looking for a key word. Typically, in a database store, the resulting value will be stored in an indexed column.

Parameters:

value - Value to index

Returns:

Index value

replaceValue

T replaceValue(T value,
               java.util.function.Function<java.lang.String,java.lang.String> replacementFunction)

Replaces a value by another one by transforming each string of the value into another one.

Parameters:

value - Value to replace

replacementFunction - Replacement function to used to transform each string into a new one

Returns:

Transformed value

containsValue

default boolean containsValue(T value,
                              java.lang.String propertyValue)

Checks if the property value contains the given search token.

By default, this method uses the search key.

Parameters:

value - Value to search into

propertyValue - Search token

Returns:

true is found

getTypeName

default java.lang.String getTypeName()

Type name for this property type.

copy

default T copy(ProjectEntity sourceEntity,
               T value,
               ProjectEntity targetEntity,
               java.util.function.Function<java.lang.String,java.lang.String> replacementFn)

Copy/clones the value defined for the sourceEntity for being suitable in the targetEntity after applying the replacement function.

By default, just applies the textual replacements.

Parameters:

sourceEntity - Owner of the property to copy

value - Property value to copy

targetEntity - Entity to associate the new property with

replacementFn - Replacement function for textual values

See Also:

replaceValue(Object, Function)

onPropertyChanged

default void onPropertyChanged(ProjectEntity entity,
                               T value)

This method is called when the property value changes (created or updated) for an entity

Parameters:

entity - Entity for which the property is changed

value - New value

onPropertyDeleted

default void onPropertyDeleted(ProjectEntity entity,
                               T oldValue)

This method is called when the property is deleted for an entity

Parameters:

entity - Entity for which the property is deleted

oldValue - Old value